tracing

Documentation

Overview

(experimental)

Index

• type BufferUsageEvent
• type Client
  • func (d *Client) End() *EndRequest
  • func (d *Client) GetCategories() *GetCategoriesRequest
  • func (d *Client) RecordClockSyncMarker() *RecordClockSyncMarkerRequest
  • func (d *Client) RequestMemoryDump() *RequestMemoryDumpRequest
  • func (d *Client) Start() *StartRequest
• type DataCollectedEvent
• type EndRequest
  • func (r *EndRequest) Do() error
• type GetCategoriesRequest
  • func (r *GetCategoriesRequest) Do() (*GetCategoriesResult, error)
• type GetCategoriesResult
• type MemoryDumpConfig
• type RecordClockSyncMarkerRequest
  • func (r *RecordClockSyncMarkerRequest) Do() error
  • func (r *RecordClockSyncMarkerRequest) SyncId(v string) *RecordClockSyncMarkerRequest
• type RequestMemoryDumpRequest
  • func (r *RequestMemoryDumpRequest) Do() (*RequestMemoryDumpResult, error)
• type RequestMemoryDumpResult
• type StartRequest
  • func (r *StartRequest) BufferUsageReportingInterval(v float64) *StartRequest
  • func (r *StartRequest) Categories(v string) *StartRequest
  • func (r *StartRequest) Do() error
  • func (r *StartRequest) Options(v string) *StartRequest
  • func (r *StartRequest) TraceConfig(v *TraceConfig) *StartRequest
  • func (r *StartRequest) TransferMode(v string) *StartRequest
• type TraceConfig
• type TracingCompleteEvent

Types

type BufferUsageEvent

type BufferUsageEvent struct {
	// A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size. (optional)
	PercentFull float64 `json:"percentFull"`

	// An approximate number of events in the trace log. (optional)
	EventCount float64 `json:"eventCount"`

	// A number in range [0..1] that indicates the used size of event buffer as a fraction of its total size. (optional)
	Value float64 `json:"value"`
}

type Client

type Client struct {
	*rpc.Client
}

(experimental)

func (*Client) End

func (d *Client) End() *EndRequest

Stop trace events collection.

func (*Client) GetCategories

func (d *Client) GetCategories() *GetCategoriesRequest

Gets supported tracing categories.

func (*Client) RecordClockSyncMarker

func (d *Client) RecordClockSyncMarker() *RecordClockSyncMarkerRequest

Record a clock sync marker in the trace.

func (*Client) RequestMemoryDump

func (d *Client) RequestMemoryDump() *RequestMemoryDumpRequest

Request a global memory dump.

func (*Client) Start

func (d *Client) Start() *StartRequest

Start trace events collection.

type DataCollectedEvent

type DataCollectedEvent struct {
	Value []interface{} `json:"value"`
}

Contains an bucket of collected trace events. When tracing is stopped collected events will be send as a sequence of dataCollected events followed by tracingComplete event.

type EndRequest

type EndRequest struct {
	// contains filtered or unexported fields
}

func (*EndRequest) Do

func (r *EndRequest) Do() error

type GetCategoriesRequest

type GetCategoriesRequest struct {
	// contains filtered or unexported fields
}

func (*GetCategoriesRequest) Do

func (r *GetCategoriesRequest) Do() (*GetCategoriesResult, error)

type GetCategoriesResult

type GetCategoriesResult struct {
	// A list of supported tracing categories.
	Categories []string `json:"categories"`
}

type MemoryDumpConfig

type MemoryDumpConfig struct {
}

type RecordClockSyncMarkerRequest

type RecordClockSyncMarkerRequest struct {
	// contains filtered or unexported fields
}

func (*RecordClockSyncMarkerRequest) Do

func (r *RecordClockSyncMarkerRequest) Do() error

func (*RecordClockSyncMarkerRequest) SyncId

func (r *RecordClockSyncMarkerRequest) SyncId(v string) *RecordClockSyncMarkerRequest

The ID of this clock sync marker

type RequestMemoryDumpRequest

type RequestMemoryDumpRequest struct {
	// contains filtered or unexported fields
}

func (*RequestMemoryDumpRequest) Do

func (r *RequestMemoryDumpRequest) Do() (*RequestMemoryDumpResult, error)

type RequestMemoryDumpResult

type RequestMemoryDumpResult struct {
	// GUID of the resulting global memory dump.
	DumpGuid string `json:"dumpGuid"`

	// True iff the global memory dump succeeded.
	Success bool `json:"success"`
}

type StartRequest

type StartRequest struct {
	// contains filtered or unexported fields
}

func (*StartRequest) BufferUsageReportingInterval

func (r *StartRequest) BufferUsageReportingInterval(v float64) *StartRequest

If set, the agent will issue bufferUsage events at this interval, specified in milliseconds (optional)

func (*StartRequest) Categories

func (r *StartRequest) Categories(v string) *StartRequest

Category/tag filter (optional)

func (*StartRequest) Do

func (r *StartRequest) Do() error

func (*StartRequest) Options

func (r *StartRequest) Options(v string) *StartRequest

Tracing options (optional)

func (*StartRequest) TraceConfig

func (r *StartRequest) TraceConfig(v *TraceConfig) *StartRequest

(optional)

func (*StartRequest) TransferMode

func (r *StartRequest) TransferMode(v string) *StartRequest

Whether to report trace events as series of dataCollected events or to save trace to a stream (defaults to <code>ReportEvents</code>). (optional)

type TraceConfig

type TraceConfig struct {
	// Controls how the trace buffer stores data. (optional)
	RecordMode string `json:"recordMode,omitempty"`

	// Turns on JavaScript stack sampling. (optional)
	EnableSampling bool `json:"enableSampling,omitempty"`

	// Turns on system tracing. (optional)
	EnableSystrace bool `json:"enableSystrace,omitempty"`

	// Turns on argument filter. (optional)
	EnableArgumentFilter bool `json:"enableArgumentFilter,omitempty"`

	// Included category filters. (optional)
	IncludedCategories []string `json:"includedCategories,omitempty"`

	// Excluded category filters. (optional)
	ExcludedCategories []string `json:"excludedCategories,omitempty"`

	// Configuration to synthesize the delays in tracing. (optional)
	SyntheticDelays []string `json:"syntheticDelays,omitempty"`

	// Configuration for memory dump triggers. Used only when "memory-infra" category is enabled. (optional)
	MemoryDumpConfig *MemoryDumpConfig `json:"memoryDumpConfig,omitempty"`
}

type TracingCompleteEvent

type TracingCompleteEvent struct {
	// A handle of the stream that holds resulting trace data. (optional)
	Stream io.StreamHandle `json:"stream"`
}

Signals that tracing is stopped and there is no trace buffers pending flush, all data were delivered via dataCollected events.