← Back to Tracing domain

Tracing.start

Start trace events collection.

Domain: Tracing stable

Parameters

NameTypeDescription
categories (optional)stringCategory/tag filter
options (optional)stringTracing options
bufferUsageReportingInterval (optional)numberIf set, the agent will issue bufferUsage events at this interval, specified in milliseconds
transferMode (optional)stringWhether to report trace events as series of dataCollected events or to save trace to a stream (defaults to `ReportEvents`).
streamFormat (optional)StreamFormatTrace data format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `json`).
streamCompression (optional)StreamCompressionCompression format to use. This only applies when using `ReturnAsStream` transfer mode (defaults to `none`)
traceConfig (optional)TraceConfig
perfettoConfig (optional)stringBase64-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 (optional)TracingBackendBackend type (defaults to `auto`)

Example Request

{
  "id": 1,
  "method": "Tracing.start"
}

Example Response

{
  "id": 1,
  "result": {}
}

Usage in Node.js

const result = await send('Tracing.start');
console.log(result);