manage_profiler
Auto-generated from the Python tool registry. Do not hand-edit outside
<!-- examples:start --><!-- examples:end -->blocks — the generator (tools/generate_docs_reference.py) will overwrite them.
Group: profiling · Module: services.tools.manage_profiler
Description
Unity Profiler session control, counter reads, memory snapshots, and Frame Debugger.
SESSION:
- profiler_start: Enable profiler, optionally record to .raw file (log_file, enable_callstacks)
- profiler_stop: Disable profiler, stop recording
- profiler_status: Get enabled state, active areas, recording path
- profiler_set_areas: Toggle ProfilerAreas on/off (areas dict)
COUNTERS:
- get_frame_timing: FrameTimingManager data (12 fields, synchronous)
- get_counters: Generic counter read by category + optional counter names (async, 1-frame wait)
- get_object_memory: Memory size of a specific object by path
MEMORY SNAPSHOT (requires com.unity.memoryprofiler):
- memory_take_snapshot: Capture memory snapshot to file
- memory_list_snapshots: List available .snap files
- memory_compare_snapshots: Compare two snapshot files
FRAME DEBUGGER:
- frame_debugger_enable: Turn on Frame Debugger, report event count
- frame_debugger_disable: Turn off Frame Debugger
- frame_debugger_get_events: Get draw call events (paged, best-effort via reflection)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
action | str | yes | The profiler action to perform. |
category | str | None | — | Profiler category name for get_counters (e.g. Render, Scripts, Memory, Physics). |
counters | list[str] | None | — | Specific counter names for get_counters. Omit to read all in category. |
object_path | str | None | — | Scene hierarchy or asset path for get_object_memory. |
log_file | str | None | — | Path to .raw file for profiler_start recording. |
enable_callstacks | bool | None | — | Enable allocation callstacks for profiler_start. |
areas | dict[str, bool] | None | — | Dict of area name to bool for profiler_set_areas. |
snapshot_path | str | None | — | Output path for memory_take_snapshot. |
search_path | str | None | — | Search directory for memory_list_snapshots. |
snapshot_a | str | None | — | First snapshot path for memory_compare_snapshots. |
snapshot_b | str | None | — | Second snapshot path for memory_compare_snapshots. |
page_size | int | None | — | Page size for frame_debugger_get_events (default 50). |
cursor | int | None | — | Cursor offset for frame_debugger_get_events. |
Returns
A dict containing the Unity response. The exact shape depends on the action.
Examples
No examples yet. Add usage examples here — they will be preserved across regenerations.