dotnet

Documentation

Index

• type Metric
  • func (m Metric) Count() int32
  • func (m Metric) CounterType() string
  • func (m Metric) DisplayName() string
  • func (m Metric) DisplayRateTimeScale() string
  • func (m Metric) DisplayUnits() string
  • func (m Metric) Increment() float64
  • func (m Metric) IntervalSec() float32
  • func (m Metric) Max() float64
  • func (m Metric) Mean() float64
  • func (m Metric) Min() float64
  • func (m Metric) Name() string
  • func (m Metric) Series() string
  • func (m Metric) StandardDeviation() float64
• type MetricsConsumer
• type Parser
  • func NewParser(rdr io.Reader, mc MetricsConsumer, bw network.BlobWriter, logger *zap.Logger) *Parser
  • func (p *Parser) ParseAll(ctx context.Context) error
  • func (p *Parser) ParseIPC() error
  • func (p *Parser) ParseNettrace() error
• type RequestWriter
  • func NewRequestWriter(w io.Writer, intervalSec int, providerNames ...string) *RequestWriter
  • func (w *RequestWriter) SendRequest() error

Types

type Metric

type Metric map[string]interface{}

Metric is a map containing all of the keys and values for a Metric extracted from the event parser. Most metrics will have some subset of the keys defined below, but some metrics/messages will have keys that deviate from this list.

func (Metric) Count

func (m Metric) Count() int32

func (Metric) CounterType

func (m Metric) CounterType() string

func (Metric) DisplayName

func (m Metric) DisplayName() string

func (Metric) DisplayRateTimeScale

func (m Metric) DisplayRateTimeScale() string

func (Metric) DisplayUnits

func (m Metric) DisplayUnits() string

func (Metric) Increment

func (m Metric) Increment() float64

func (Metric) IntervalSec

func (m Metric) IntervalSec() float32

func (Metric) Max

func (m Metric) Max() float64

func (Metric) Mean

func (m Metric) Mean() float64

func (Metric) Min

func (m Metric) Min() float64

func (Metric) Name

func (m Metric) Name() string

func (Metric) Series

func (m Metric) Series() string

func (Metric) StandardDeviation

func (m Metric) StandardDeviation() float64

type MetricsConsumer

type MetricsConsumer func([]Metric)

MetricsConsumer is a function that accepts a slice of Metrics. Parser has a member consumer function, used to send Metrics as they are created.

type Parser

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

Parser encapsulates all of the functionality to parse an IPC stream.

func NewParser

func NewParser(rdr io.Reader, mc MetricsConsumer, bw network.BlobWriter, logger *zap.Logger) *Parser

NewParser accepts an io.Reader, a MetricsConsumer, and logger, and returns a Parser for processing an IPC stream.

func (*Parser) ParseAll

func (p *Parser) ParseAll(ctx context.Context) error

ParseAll parses all of the blocks until an error occurs or the context is cancelled.

func (*Parser) ParseIPC

func (p *Parser) ParseIPC() error

ParseIPC parses the IPC response from the initial request to a dotnet process.

func (*Parser) ParseNettrace

func (p *Parser) ParseNettrace() error

ParseNettrace parses the nettrace magic message.

type RequestWriter

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

RequestWriter submits the initial request to the dotnet diagnostics backend, after which it starts sending us metrics at the specified interval. ByteBuffer is swappable for testing. For docs on the protocol, see https://github.com/dotnet/diagnostics/blob/master/documentation/design-docs/ipc-protocol.md

func NewRequestWriter

func NewRequestWriter(w io.Writer, intervalSec int, providerNames ...string) *RequestWriter

func (*RequestWriter) SendRequest

func (w *RequestWriter) SendRequest() error