package tracing

Import Path
	github.com/chromedp/cdproto/tracing (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files easyjson.go events.go Package tracing provides the Chrome DevTools Protocol commands, types, and events for the Tracing domain. Generated by the cdproto-gen command. types.go
Package-Level Type Names (total 18)
/* sort by: | */
Backend backend type to use for tracing. chrome uses the Chrome-integrated tracing service and is supported on all platforms. system is only supported on Chrome OS and uses the Perfetto system tracing service. auto chooses system when the perfettoConfig provided to Tracing.start specifies at least one non-Chrome data source; otherwise uses chrome. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-TracingBackend MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the Backend as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. Backend : github.com/goccy/go-json.Marshaler *Backend : github.com/goccy/go-json.Unmarshaler Backend : github.com/mailru/easyjson.Marshaler *Backend : github.com/mailru/easyjson.MarshalerUnmarshaler *Backend : github.com/mailru/easyjson.Unmarshaler Backend : encoding/json.Marshaler *Backend : encoding/json.Unmarshaler Backend : expvar.Var Backend : fmt.Stringer func StartParams.WithTracingBackend(tracingBackend Backend) *StartParams const BackendAuto const BackendChrome const BackendSystem
EndParams stop trace events collection. Do executes Tracing.end against the provided context. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface *EndParams : github.com/chromedp/chromedp.Action *EndParams : github.com/chromedp/chromedp.CallAction *EndParams : github.com/chromedp/chromedp.EmulateAction *EndParams : github.com/chromedp/chromedp.EvaluateAction *EndParams : github.com/chromedp/chromedp.KeyAction *EndParams : github.com/chromedp/chromedp.MouseAction *EndParams : github.com/chromedp/chromedp.NavigateAction *EndParams : github.com/chromedp/chromedp.PollAction *EndParams : github.com/chromedp/chromedp.QueryAction EndParams : github.com/goccy/go-json.Marshaler *EndParams : github.com/goccy/go-json.Unmarshaler EndParams : github.com/mailru/easyjson.Marshaler *EndParams : github.com/mailru/easyjson.MarshalerUnmarshaler *EndParams : github.com/mailru/easyjson.Unmarshaler EndParams : encoding/json.Marshaler *EndParams : encoding/json.Unmarshaler func End() *EndParams
EventBufferUsage [no description]. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#event-bufferUsage // An approximate number of events in the trace log. // A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size. // A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface EventBufferUsage : github.com/goccy/go-json.Marshaler *EventBufferUsage : github.com/goccy/go-json.Unmarshaler EventBufferUsage : github.com/mailru/easyjson.Marshaler *EventBufferUsage : github.com/mailru/easyjson.MarshalerUnmarshaler *EventBufferUsage : github.com/mailru/easyjson.Unmarshaler EventBufferUsage : encoding/json.Marshaler *EventBufferUsage : encoding/json.Unmarshaler
EventDataCollected contains a bucket of collected trace events. When tracing is stopped collected events will be sent as a sequence of dataCollected events followed by tracingComplete event. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#event-dataCollected Value []easyjson.RawMessage MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface EventDataCollected : github.com/goccy/go-json.Marshaler *EventDataCollected : github.com/goccy/go-json.Unmarshaler EventDataCollected : github.com/mailru/easyjson.Marshaler *EventDataCollected : github.com/mailru/easyjson.MarshalerUnmarshaler *EventDataCollected : github.com/mailru/easyjson.Unmarshaler EventDataCollected : encoding/json.Marshaler *EventDataCollected : encoding/json.Unmarshaler
EventTracingComplete signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#event-tracingComplete // Indicates whether some trace data is known to have been lost, e.g. because the trace ring buffer wrapped around. // A handle of the stream that holds resulting trace data. // Compression format of returned stream. // Trace data format of returned stream. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface EventTracingComplete : github.com/goccy/go-json.Marshaler *EventTracingComplete : github.com/goccy/go-json.Unmarshaler EventTracingComplete : github.com/mailru/easyjson.Marshaler *EventTracingComplete : github.com/mailru/easyjson.MarshalerUnmarshaler *EventTracingComplete : github.com/mailru/easyjson.Unmarshaler EventTracingComplete : encoding/json.Marshaler *EventTracingComplete : encoding/json.Unmarshaler
GetCategoriesParams gets supported tracing categories. Do executes Tracing.getCategories against the provided context. returns: categories - A list of supported tracing categories. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface GetCategoriesParams : github.com/goccy/go-json.Marshaler *GetCategoriesParams : github.com/goccy/go-json.Unmarshaler GetCategoriesParams : github.com/mailru/easyjson.Marshaler *GetCategoriesParams : github.com/mailru/easyjson.MarshalerUnmarshaler *GetCategoriesParams : github.com/mailru/easyjson.Unmarshaler GetCategoriesParams : encoding/json.Marshaler *GetCategoriesParams : encoding/json.Unmarshaler func GetCategories() *GetCategoriesParams
GetCategoriesReturns return values. // A list of supported tracing categories. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface GetCategoriesReturns : github.com/goccy/go-json.Marshaler *GetCategoriesReturns : github.com/goccy/go-json.Unmarshaler GetCategoriesReturns : github.com/mailru/easyjson.Marshaler *GetCategoriesReturns : github.com/mailru/easyjson.MarshalerUnmarshaler *GetCategoriesReturns : github.com/mailru/easyjson.Unmarshaler GetCategoriesReturns : encoding/json.Marshaler *GetCategoriesReturns : encoding/json.Unmarshaler
MemoryDumpConfig configuration for memory dump. Used only when "memory-infra" category is enabled. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-MemoryDumpConfig MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface MemoryDumpConfig : github.com/goccy/go-json.Marshaler *MemoryDumpConfig : github.com/goccy/go-json.Unmarshaler MemoryDumpConfig : github.com/mailru/easyjson.Marshaler *MemoryDumpConfig : github.com/mailru/easyjson.MarshalerUnmarshaler *MemoryDumpConfig : github.com/mailru/easyjson.Unmarshaler MemoryDumpConfig : encoding/json.Marshaler *MemoryDumpConfig : encoding/json.Unmarshaler
MemoryDumpLevelOfDetail details exposed when memory request explicitly declared. Keep consistent with memory_dump_request_args.h and memory_instrumentation.mojom. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-MemoryDumpLevelOfDetail MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the MemoryDumpLevelOfDetail as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. MemoryDumpLevelOfDetail : github.com/goccy/go-json.Marshaler *MemoryDumpLevelOfDetail : github.com/goccy/go-json.Unmarshaler MemoryDumpLevelOfDetail : github.com/mailru/easyjson.Marshaler *MemoryDumpLevelOfDetail : github.com/mailru/easyjson.MarshalerUnmarshaler *MemoryDumpLevelOfDetail : github.com/mailru/easyjson.Unmarshaler MemoryDumpLevelOfDetail : encoding/json.Marshaler *MemoryDumpLevelOfDetail : encoding/json.Unmarshaler MemoryDumpLevelOfDetail : expvar.Var MemoryDumpLevelOfDetail : fmt.Stringer func RequestMemoryDumpParams.WithLevelOfDetail(levelOfDetail MemoryDumpLevelOfDetail) *RequestMemoryDumpParams const MemoryDumpLevelOfDetailBackground const MemoryDumpLevelOfDetailDetailed const MemoryDumpLevelOfDetailLight
RecordClockSyncMarkerParams record a clock sync marker in the trace. // The ID of this clock sync marker Do executes Tracing.recordClockSyncMarker against the provided context. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.Action *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.CallAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.EmulateAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.EvaluateAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.KeyAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.MouseAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.NavigateAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.PollAction *RecordClockSyncMarkerParams : github.com/chromedp/chromedp.QueryAction RecordClockSyncMarkerParams : github.com/goccy/go-json.Marshaler *RecordClockSyncMarkerParams : github.com/goccy/go-json.Unmarshaler RecordClockSyncMarkerParams : github.com/mailru/easyjson.Marshaler *RecordClockSyncMarkerParams : github.com/mailru/easyjson.MarshalerUnmarshaler *RecordClockSyncMarkerParams : github.com/mailru/easyjson.Unmarshaler RecordClockSyncMarkerParams : encoding/json.Marshaler *RecordClockSyncMarkerParams : encoding/json.Unmarshaler func RecordClockSyncMarker(syncID string) *RecordClockSyncMarkerParams
RecordMode controls how the trace buffer stores data. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-TraceConfig MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the RecordMode as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. RecordMode : github.com/goccy/go-json.Marshaler *RecordMode : github.com/goccy/go-json.Unmarshaler RecordMode : github.com/mailru/easyjson.Marshaler *RecordMode : github.com/mailru/easyjson.MarshalerUnmarshaler *RecordMode : github.com/mailru/easyjson.Unmarshaler RecordMode : encoding/json.Marshaler *RecordMode : encoding/json.Unmarshaler RecordMode : expvar.Var RecordMode : fmt.Stringer const RecordModeEchoToConsole const RecordModeRecordAsMuchAsPossible const RecordModeRecordContinuously const RecordModeRecordUntilFull
RequestMemoryDumpParams request a global memory dump. // Enables more deterministic results by forcing garbage collection // Specifies level of details in memory dump. Defaults to "detailed". Do executes Tracing.requestMemoryDump against the provided context. returns: dumpGUID - GUID of the resulting global memory dump. success - True iff the global memory dump succeeded. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface WithDeterministic enables more deterministic results by forcing garbage collection. WithLevelOfDetail specifies level of details in memory dump. Defaults to "detailed". RequestMemoryDumpParams : github.com/goccy/go-json.Marshaler *RequestMemoryDumpParams : github.com/goccy/go-json.Unmarshaler RequestMemoryDumpParams : github.com/mailru/easyjson.Marshaler *RequestMemoryDumpParams : github.com/mailru/easyjson.MarshalerUnmarshaler *RequestMemoryDumpParams : github.com/mailru/easyjson.Unmarshaler RequestMemoryDumpParams : encoding/json.Marshaler *RequestMemoryDumpParams : encoding/json.Unmarshaler func RequestMemoryDump() *RequestMemoryDumpParams func RequestMemoryDumpParams.WithDeterministic(deterministic bool) *RequestMemoryDumpParams func RequestMemoryDumpParams.WithLevelOfDetail(levelOfDetail MemoryDumpLevelOfDetail) *RequestMemoryDumpParams
RequestMemoryDumpReturns return values. // GUID of the resulting global memory dump. // True iff the global memory dump succeeded. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface RequestMemoryDumpReturns : github.com/goccy/go-json.Marshaler *RequestMemoryDumpReturns : github.com/goccy/go-json.Unmarshaler RequestMemoryDumpReturns : github.com/mailru/easyjson.Marshaler *RequestMemoryDumpReturns : github.com/mailru/easyjson.MarshalerUnmarshaler *RequestMemoryDumpReturns : github.com/mailru/easyjson.Unmarshaler RequestMemoryDumpReturns : encoding/json.Marshaler *RequestMemoryDumpReturns : encoding/json.Unmarshaler
StartParams start trace events collection. // If set, the agent will issue bufferUsage events at this interval, specified in milliseconds // Base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters categories, options, traceConfig are ignored. // Compression format to use. This only applies when using ReturnAsStream transfer mode (defaults to none) // Trace data format to use. This only applies when using ReturnAsStream transfer mode (defaults to json). TraceConfig *TraceConfig // Backend type (defaults to auto) // Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents). Do executes Tracing.start against the provided context. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface WithBufferUsageReportingInterval if set, the agent will issue bufferUsage events at this interval, specified in milliseconds. WithPerfettoConfig base64-encoded serialized perfetto.protos.TraceConfig protobuf message When specified, the parameters categories, options, traceConfig are ignored. WithStreamCompression compression format to use. This only applies when using ReturnAsStream transfer mode (defaults to none). WithStreamFormat trace data format to use. This only applies when using ReturnAsStream transfer mode (defaults to json). WithTraceConfig [no description]. WithTracingBackend backend type (defaults to auto). WithTransferMode whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents). *StartParams : github.com/chromedp/chromedp.Action *StartParams : github.com/chromedp/chromedp.CallAction *StartParams : github.com/chromedp/chromedp.EmulateAction *StartParams : github.com/chromedp/chromedp.EvaluateAction *StartParams : github.com/chromedp/chromedp.KeyAction *StartParams : github.com/chromedp/chromedp.MouseAction *StartParams : github.com/chromedp/chromedp.NavigateAction *StartParams : github.com/chromedp/chromedp.PollAction *StartParams : github.com/chromedp/chromedp.QueryAction StartParams : github.com/goccy/go-json.Marshaler *StartParams : github.com/goccy/go-json.Unmarshaler StartParams : github.com/mailru/easyjson.Marshaler *StartParams : github.com/mailru/easyjson.MarshalerUnmarshaler *StartParams : github.com/mailru/easyjson.Unmarshaler StartParams : encoding/json.Marshaler *StartParams : encoding/json.Unmarshaler func Start() *StartParams func StartParams.WithBufferUsageReportingInterval(bufferUsageReportingInterval float64) *StartParams func StartParams.WithPerfettoConfig(perfettoConfig string) *StartParams func StartParams.WithStreamCompression(streamCompression StreamCompression) *StartParams func StartParams.WithStreamFormat(streamFormat StreamFormat) *StartParams func StartParams.WithTraceConfig(traceConfig *TraceConfig) *StartParams func StartParams.WithTracingBackend(tracingBackend Backend) *StartParams func StartParams.WithTransferMode(transferMode TransferMode) *StartParams
StreamCompression compression type to use for traces returned via streams. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-StreamCompression MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the StreamCompression as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. StreamCompression : github.com/goccy/go-json.Marshaler *StreamCompression : github.com/goccy/go-json.Unmarshaler StreamCompression : github.com/mailru/easyjson.Marshaler *StreamCompression : github.com/mailru/easyjson.MarshalerUnmarshaler *StreamCompression : github.com/mailru/easyjson.Unmarshaler StreamCompression : encoding/json.Marshaler *StreamCompression : encoding/json.Unmarshaler StreamCompression : expvar.Var StreamCompression : fmt.Stringer func StartParams.WithStreamCompression(streamCompression StreamCompression) *StartParams const StreamCompressionGzip const StreamCompressionNone
StreamFormat data format of a trace. Can be either the legacy JSON format or the protocol buffer format. Note that the JSON format will be deprecated soon. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-StreamFormat MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the StreamFormat as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. StreamFormat : github.com/goccy/go-json.Marshaler *StreamFormat : github.com/goccy/go-json.Unmarshaler StreamFormat : github.com/mailru/easyjson.Marshaler *StreamFormat : github.com/mailru/easyjson.MarshalerUnmarshaler *StreamFormat : github.com/mailru/easyjson.Unmarshaler StreamFormat : encoding/json.Marshaler *StreamFormat : encoding/json.Unmarshaler StreamFormat : expvar.Var StreamFormat : fmt.Stringer func StartParams.WithStreamFormat(streamFormat StreamFormat) *StartParams const StreamFormatJSON const StreamFormatProto
TraceConfig [no description]. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#type-TraceConfig // Turns on argument filter. // Turns on JavaScript stack sampling. // Turns on system tracing. // Excluded category filters. // Included category filters. // Configuration for memory dump triggers. Used only when "memory-infra" category is enabled. // Controls how the trace buffer stores data. // Configuration to synthesize the delays in tracing. // Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value of 200 MB would be used. MarshalEasyJSON supports easyjson.Marshaler interface MarshalJSON supports json.Marshaler interface UnmarshalEasyJSON supports easyjson.Unmarshaler interface UnmarshalJSON supports json.Unmarshaler interface TraceConfig : github.com/goccy/go-json.Marshaler *TraceConfig : github.com/goccy/go-json.Unmarshaler TraceConfig : github.com/mailru/easyjson.Marshaler *TraceConfig : github.com/mailru/easyjson.MarshalerUnmarshaler *TraceConfig : github.com/mailru/easyjson.Unmarshaler TraceConfig : encoding/json.Marshaler *TraceConfig : encoding/json.Unmarshaler func StartParams.WithTraceConfig(traceConfig *TraceConfig) *StartParams
TransferMode whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to ReportEvents). See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#method-start MarshalEasyJSON satisfies easyjson.Marshaler. MarshalJSON satisfies json.Marshaler. String returns the TransferMode as string value. UnmarshalEasyJSON satisfies easyjson.Unmarshaler. UnmarshalJSON satisfies json.Unmarshaler. TransferMode : github.com/goccy/go-json.Marshaler *TransferMode : github.com/goccy/go-json.Unmarshaler TransferMode : github.com/mailru/easyjson.Marshaler *TransferMode : github.com/mailru/easyjson.MarshalerUnmarshaler *TransferMode : github.com/mailru/easyjson.Unmarshaler TransferMode : encoding/json.Marshaler *TransferMode : encoding/json.Unmarshaler TransferMode : expvar.Var TransferMode : fmt.Stringer func StartParams.WithTransferMode(transferMode TransferMode) *StartParams const TransferModeReportEvents const TransferModeReturnAsStream
Package-Level Functions (total 5)
RecordClockSyncMarker record a clock sync marker in the trace. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#method-recordClockSyncMarker parameters: syncID - The ID of this clock sync marker
Start start trace events collection. See: https://chromedevtools.github.io/devtools-protocol/tot/Tracing#method-start parameters:
Package-Level Constants (total 21)
Backend values.
Backend values.
Backend values.
Command names.
Command names.
Command names.
Command names.
Command names.
MemoryDumpLevelOfDetail values.
MemoryDumpLevelOfDetail values.
MemoryDumpLevelOfDetail values.
RecordMode values.
RecordMode values.
RecordMode values.
RecordMode values.
StreamCompression values.
StreamCompression values.
StreamFormat values.
StreamFormat values.
TransferMode values.
TransferMode values.