metricexp

Documentation

Overview

metricexp provides metric exporter for OpenTelemetry.

Index

• func InstallNewPipeline(ctx context.Context, config *Config, options ...controller.Option) (*controller.Controller, error)
• func NewExportPipeline(cfg *Config, options ...controller.Option) (*controller.Controller, error)
• type Config
• type Exporter
  • func NewExporter(cfg *Config) (*Exporter, error)
  • func (e *Exporter) Export(_ context.Context, checkpointSet export.CheckpointSet) error
  • func (e *Exporter) ExportKindFor(*metric.Descriptor, aggregation.Kind) export.ExportKind

Functions

func InstallNewPipeline

func InstallNewPipeline(
	ctx context.Context, config *Config, options ...controller.Option,
) (*controller.Controller, error)

InstallNewPipeline instantiates a NewExportPipeline and registers it globally. Typically called as:

pipeline := stdout.InstallNewPipeline(stdout.Config{...})
defer pipeline.Stop()
... Done

func NewExportPipeline

func NewExportPipeline(
	cfg *Config, options ...controller.Option,
) (*controller.Controller, error)

NewExportPipeline sets up a complete export pipeline with the recommended setup, chaining a NewRawExporter into the recommended selectors and integrators.

Types

type Config

type Config struct {
	// DSN is a data source name that is used to connect to uptrace.dev.
	// Example: https://<token>@api.uptrace.dev/<project_id>
	// The default is to use UPTRACE_DSN environment var.
	DSN string

	// HTTPClient that is used to send data to Uptrace.
	HTTPClient *http.Client
	// Max number of retries when sending data to Uptrace.
	// The default is 3.
	MaxRetries int

	// Disabled disables the exporter.
	// The default is to use UPTRACE_DISABLED environment var.
	Disabled bool
	// contains filtered or unexported fields
}

Config is the configuration to be used when initializing a client.

type Exporter

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

func NewExporter

func NewExporter(cfg *Config) (*Exporter, error)

func (*Exporter) Export

func (e *Exporter) Export(_ context.Context, checkpointSet export.CheckpointSet) error

func (*Exporter) ExportKindFor

func (e *Exporter) ExportKindFor(*metric.Descriptor, aggregation.Kind) export.ExportKind