launcher

Documentation

Index

• Constants
• type Config
• type DefaultLogger
  • func (l *DefaultLogger) Debugf(format string, v ...interface{})
  • func (l *DefaultLogger) Fatalf(format string, v ...interface{})
• type Launcher
  • func ConfigureOpentelemetry(opts ...Option) Launcher
  • func (ls Launcher) Shutdown()
• type Logger
• type Option
  • func WithAccessToken(accessToken string) Option
  • func WithErrorHandler(handler otel.ErrorHandler) Option
  • func WithHeaders(headers map[string]string) Option
  • func WithLogLevel(loglevel string) Option
  • func WithLogger(logger Logger) Option
  • func WithMetricExporterEndpoint(url string) Option
  • func WithMetricExporterInsecure(insecure bool) Option
  • func WithMetricReportingPeriod(p time.Duration) Option
  • func WithMetricsEnabled(enabled bool) Option
  • func WithPropagators(propagators []string) Option
  • func WithResourceAttributes(attributes map[string]string) Option
  • func WithServiceName(name string) Option
  • func WithServiceVersion(version string) Option
  • func WithSpanExporterEndpoint(url string) Option
  • func WithSpanExporterInsecure(insecure bool) Option

Constants

const (
	DefaultSpanExporterEndpoint   = "ingest.lightstep.com:443"
	DefaultMetricExporterEndpoint = "ingest.lightstep.com:443"
)

Types

type Config

type Config struct {
	SpanExporterEndpoint           string            `env:"OTEL_EXPORTER_OTLP_SPAN_ENDPOINT,default=localhost"`
	SpanExporterEndpointInsecure   bool              `env:"OTEL_EXPORTER_OTLP_SPAN_INSECURE,default=false"`
	ServiceName                    string            `env:"LS_SERVICE_NAME"`
	ServiceVersion                 string            `env:"LS_SERVICE_VERSION,default=unknown"`
	Headers                        map[string]string `env:"OTEL_EXPORTER_OTLP_HEADERS"`
	MetricExporterEndpoint         string            `env:"OTEL_EXPORTER_OTLP_METRIC_ENDPOINT,default=localhost"`
	MetricExporterEndpointInsecure bool              `env:"OTEL_EXPORTER_OTLP_METRIC_INSECURE,default=false"`
	MetricsEnabled                 bool              `env:"LS_METRICS_ENABLED,default=true"`
	AccessToken                    string            `env:"LS_ACCESS_TOKEN"`
	LogLevel                       string            `env:"OTEL_LOG_LEVEL,default=info"`
	Propagators                    []string          `env:"OTEL_PROPAGATORS,default=b3"`
	MetricReportingPeriod          string            `env:"OTEL_EXPORTER_OTLP_METRIC_PERIOD,default=30s"`

	Resource *resource.Resource
	// contains filtered or unexported fields
}

type DefaultLogger

type DefaultLogger struct {
}

func (*DefaultLogger) Debugf

func (l *DefaultLogger) Debugf(format string, v ...interface{})

func (*DefaultLogger) Fatalf

func (l *DefaultLogger) Fatalf(format string, v ...interface{})

type Launcher

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

func ConfigureOpentelemetry

func ConfigureOpentelemetry(opts ...Option) Launcher

func (Launcher) Shutdown

func (ls Launcher) Shutdown()

type Logger

type Logger interface {
	Fatalf(format string, v ...interface{})
	Debugf(format string, v ...interface{})
}

type Option

type Option func(*Config)

func WithAccessToken

func WithAccessToken(accessToken string) Option

WithAccessToken configures the lightstep access token remain compatible with the Lightstep-only launcher for now...

func WithErrorHandler

func WithErrorHandler(handler otel.ErrorHandler) Option

Configures a global error handler to be used throughout an OpenTelemetry instrumented project. See "go.opentelemetry.io/otel"

func WithHeaders

func WithHeaders(headers map[string]string) Option

WithHeaders configures OTLP/gRPC connection headers

func WithLogLevel

func WithLogLevel(loglevel string) Option

WithLogLevel configures the logging level for OpenTelemetry

func WithLogger

func WithLogger(logger Logger) Option

func WithMetricExporterEndpoint

func WithMetricExporterEndpoint(url string) Option

WithMetricExporterEndpoint configures the endpoint for sending metrics via OTLP

func WithMetricExporterInsecure

func WithMetricExporterInsecure(insecure bool) Option

WithMetricExporterInsecure permits connecting to the metric endpoint without a certificate

func WithMetricReportingPeriod

func WithMetricReportingPeriod(p time.Duration) Option

WithMetricReportingPeriod configures the metric reporting period, how often the controller collects and exports metric data.

func WithMetricsEnabled

func WithMetricsEnabled(enabled bool) Option

WithMetricEnabled configures whether metrics should be enabled

func WithPropagators

func WithPropagators(propagators []string) Option

WithPropagators configures propagators

func WithResourceAttributes

func WithResourceAttributes(attributes map[string]string) Option

WithResourceAttributes configures attributes on the resource

func WithServiceName

func WithServiceName(name string) Option

WithServiceName configures a "service.name" resource label

func WithServiceVersion

func WithServiceVersion(version string) Option

WithServiceVersion configures a "service.version" resource label

func WithSpanExporterEndpoint

func WithSpanExporterEndpoint(url string) Option

WithSpanExporterEndpoint configures the endpoint for sending traces via OTLP

func WithSpanExporterInsecure

func WithSpanExporterInsecure(insecure bool) Option

WithSpanExporterInsecure permits connecting to the trace endpoint without a certificate