otel

Documentation

Overview

Package otel handles the configuration and lifecycle of the opentelemetry-collector Its' purpose is to generate a resolver setting that incorporates multiple providers collector consumes otel/providers which consume otel/config

Index

• type Collector
  • func NewCollector(cfg CollectorCfg) (Collector, error)
• type CollectorCfg

Types

type Collector

type Collector interface {
	Run(context.Context) error
	GetState() otelcol.State
	Shutdown()
}

Collector is an interface that is satisfied by the otelcol.Collector struct. This allows us to wrap the opentelemetry collector and not necessarily run it ourselves.

func NewCollector

func NewCollector(cfg CollectorCfg) (Collector, error)

NewCollector will create a new open-telemetry collector service and configuration based on the provided values.

type CollectorCfg

type CollectorCfg struct {
	ClientID          string
	ClientSecret      string
	ResourceID        string
	Client            hcp.TelemetryClient
	ForwarderEndpoint string
	ExporterConfig    *config.ExporterConfig
	MetricsPort       int
	EnvoyPort         int
	BatchTimeout      time.Duration
}

CollectorCfg is the configuration needed to start the collector.