CDPotion.Domain.Tracing (cdpotion v0.1.0)

Summary

Functions

end!()

Stop trace events collection.

get_categories()

Gets supported tracing categories.

record_clock_sync_marker(sync_id)

Record a clock sync marker in the trace.

request_memory_dump(deterministic \\ nil, level_of_detail \\ nil)

Request a global memory dump.

start(categories \\ nil, options \\ nil, buffer_usage_reporting_interval \\ nil, transfer_mode \\ nil, stream_format \\ nil, stream_compression \\ nil, trace_config \\ nil, perfetto_config \\ nil, tracing_backend \\ nil)

Start trace events collection.

Functions

Link to this function

end!()

Stop trace events collection.

Link to this function

get_categories()

Gets supported tracing categories.

Link to this function

record_clock_sync_marker(sync_id)

Record a clock sync marker in the trace.

Parameters:

  • syncId:string: The ID of this clock sync marker
Link to this function

request_memory_dump(deterministic \\ nil, level_of_detail \\ nil)

Request a global memory dump.

Parameters:

  • deterministic:boolean: (Optional) Enables more deterministic results by forcing garbage collection
  • levelOfDetail:MemoryDumpLevelOfDetail: (Optional) Specifies level of details in memory dump. Defaults to "detailed".
Link to this function

start(categories \\ nil, options \\ nil, buffer_usage_reporting_interval \\ nil, transfer_mode \\ nil, stream_format \\ nil, stream_compression \\ nil, trace_config \\ nil, perfetto_config \\ nil, tracing_backend \\ nil)

Start trace events collection.

Parameters:

  • categories:string: (Optional) Category/tag filter
  • options:string: (Optional) Tracing options
  • bufferUsageReportingInterval:number: (Optional) If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
  • transferMode:string: (Optional) Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents).
  • streamFormat:StreamFormat: (Optional) Trace data format to use. This only applies when using ReturnAsStream transfer mode (defaults to json).
  • streamCompression:StreamCompression: (Optional) Compression format to use. This only applies when using ReturnAsStream transfer mode (defaults to none)
  • traceConfig:TraceConfig: (Optional) description not provided :(
  • perfettoConfig:string: (Optional) Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters categories, options, traceConfig are ignored. (Encoded as a base64 string when passed over JSON)
  • tracingBackend:TracingBackend: (Optional) Backend type (defaults to auto)