dotnetdiag

type Client ¶

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

Client implement Diagnostic IPC Protocol client. https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md

func NewClient(addr string, options ...Option) *Client

func (c *Client) CollectTracing(config CollectTracingConfig) (s *Session, err error)

func (c *Client) StopTracing(sessionID uint64) error

type CollectTracingConfig ¶

type CollectTracingConfig struct {
	// CircularBufferSizeMB specifies the size of the circular buffer used for
	// buffering event data while streaming
	CircularBufferSizeMB uint32
	// Providers member lists providers to turn on for a streaming session.
	// See ETW documentation for a more detailed explanation of Keywords, Filters, and Log Level:
	// https://docs.microsoft.com/en-us/message-analyzer/system-etw-provider-event-keyword-level-settings
	Providers []ProviderConfig
}

CollectTracingConfig contains supported parameters for CollectTracing command.

type CollectTracingPayload ¶

type CollectTracingPayload struct {
	CircularBufferSizeMB uint32
	Format               Format
	Providers            []ProviderConfig
}

func (p CollectTracingPayload) Bytes() []byte

type CollectTracingResponse ¶

type CollectTracingResponse struct {
	SessionID uint64
}

type Dialer ¶ added in v1.2.0

type Dialer func(addr string) (net.Conn, error)

Dialer establishes connection to the given address. Due to the potential for an optional continuation in the Diagnostics IPC Protocol, each successful connection between the runtime and a Diagnostic Port is only usable once.

Note that the dialer is OS-specific, refer to documentation for details: https://github.com/dotnet/diagnostics/blob/main/documentation/design-docs/ipc-protocol.md#transport

func DefaultDialer() Dialer

type ErrorResponse ¶

type ErrorResponse struct {
	Code uint32
}

type Format ¶

type Format uint32

const (
	FormatNetPerf Format = iota
	FormatNetTrace
)

type Header ¶

type Header struct {
	Magic      [14]uint8
	Size       uint16
	CommandSet uint8
	CommandID  uint8
	Reserved   uint16
}

type Option ¶ added in v1.2.0

type Option func(*Client)

Option overrides default Client parameters.

func WithDialer(d Dialer) Option

type ProviderConfig ¶

type ProviderConfig struct {
	Keywords     uint64
	LogLevel     uint32
	ProviderName string
	FilterData   string
}

type Session ¶

type Session struct {
	ID uint64
	// contains filtered or unexported fields
}

Session represents EventPipe stream of NetTrace data created with `CollectTracing` command.

A session is expected to be closed with `StopTracing` call (or `Close`), as there is a "run down" at the end of a stream session that transmits additional metadata. If the stream is stopped prematurely due to a client or server error, the NetTrace stream will be incomplete and should be considered corrupted.

func (s *Session) Close() error

func (s *Session) Read(b []byte) (int, error)

type StopTracingPayload ¶

type StopTracingPayload struct {
	SessionID uint64
}

func (p StopTracingPayload) Bytes() []byte

type StopTracingResponse ¶

type StopTracingResponse struct {
	SessionID uint64
}