otlpmetric

Documentation

Index

• type Client
• type Exporter
  • func New(ctx context.Context, client Client, opts ...Option) (*Exporter, error)
  • func NewUnstarted(client Client, opts ...Option) *Exporter
  • func (e *Exporter) Export(ctx context.Context, res *resource.Resource, ...) error
  • func (e *Exporter) Shutdown(ctx context.Context) error
  • func (e *Exporter) Start(ctx context.Context) error
  • func (e *Exporter) TemporalityFor(descriptor *sdkapi.Descriptor, kind aggregation.Kind) aggregation.Temporality
• type Option
  • func WithMetricAggregationTemporalitySelector(selector aggregation.TemporalitySelector) Option

Types

type Client

type Client interface {
	// Start should establish connection(s) to endpoint(s). It is
	// called just once by the exporter, so the implementation
	// does not need to worry about idempotence and locking.
	Start(ctx context.Context) error
	// Stop should close the connections. The function is called
	// only once by the exporter, so the implementation does not
	// need to worry about idempotence, but it may be called
	// concurrently with UploadMetrics, so proper
	// locking is required. The function serves as a
	// synchronization point - after the function returns, the
	// process of closing connections is assumed to be finished.
	Stop(ctx context.Context) error
	// UploadMetrics should transform the passed metrics to the
	// wire format and send it to the collector. May be called
	// concurrently.
	UploadMetrics(ctx context.Context, protoMetrics []*metricpb.ResourceMetrics) error
}

Client manages connections to the collector, handles the transformation of data into wire format, and the transmission of that data to the collector.

type Exporter

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

Exporter exports metrics data in the OTLP wire format.

func New

func New(ctx context.Context, client Client, opts ...Option) (*Exporter, error)

New constructs a new Exporter and starts it.

func NewUnstarted

func NewUnstarted(client Client, opts ...Option) *Exporter

NewUnstarted constructs a new Exporter and does not start it.

func (*Exporter) Export

func (e *Exporter) Export(ctx context.Context, res *resource.Resource, ilr metricsdk.InstrumentationLibraryReader) error

Export exports a batch of metrics.

func (*Exporter) Shutdown

func (e *Exporter) Shutdown(ctx context.Context) error

Shutdown flushes all exports and closes all connections to the receiving endpoint.

func (*Exporter) Start

func (e *Exporter) Start(ctx context.Context) error

Start establishes a connection to the receiving endpoint.

func (*Exporter) TemporalityFor

func (e *Exporter) TemporalityFor(descriptor *sdkapi.Descriptor, kind aggregation.Kind) aggregation.Temporality

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option are setting options passed to an Exporter on creation.

func WithMetricAggregationTemporalitySelector

func WithMetricAggregationTemporalitySelector(selector aggregation.TemporalitySelector) Option

WithMetricAggregationTemporalitySelector defines the aggregation.TemporalitySelector used for selecting aggregation.Temporality (i.e., Cumulative vs. Delta aggregation). If not specified otherwise, exporter will use a cumulative temporality selector.