ocmetrics

Documentation

Overview

Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.

Index

• type Option
  • func WithMetricBufferCount(count int) Option
  • func WithMetricBufferPeriod(period time.Duration) Option
• type Receiver
  • func New(nextConsumer consumer.MetricsConsumer, opts ...Option) (*Receiver, error)
  • func (ocr *Receiver) Export(mes agentmetricspb.MetricsService_ExportServer) error

Types

type Option

type Option interface {
	WithReceiver(*Receiver)
}

Option interface defines for configuration settings to be applied to receivers.

WithReceiver applies the configuration to the given receiver.

func WithMetricBufferCount

func WithMetricBufferCount(count int) Option

WithMetricBufferCount is an option that allows one to configure the number of metrics that are buffered before the Receiver send them to its MetricsReceiverSink.

func WithMetricBufferPeriod

func WithMetricBufferPeriod(period time.Duration) Option

WithMetricBufferPeriod is an option that allows one to configure the period that spans are buffered for before the Receiver sends them to its MetricsReceiver.

type Receiver

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

Receiver is the type used to handle metrics from OpenCensus exporters.

func New

func New(nextConsumer consumer.MetricsConsumer, opts ...Option) (*Receiver, error)

New creates a new ocmetrics.Receiver reference.

func (*Receiver) Export

func (ocr *Receiver) Export(mes agentmetricspb.MetricsService_ExportServer) error

Export is the gRPC method that receives streamed metrics from OpenCensus-metricproto compatible libraries/applications.