correlation

Documentation

Overview

Package correlation performs span to metric correlation for SignalFx.

Index

• type Config
  • func DefaultConfig() *Config
• type Tracker
  • func NewTracker(cfg *Config, accessToken configopaque.String, params exporter.CreateSettings) *Tracker
  • func (cor *Tracker) AddSpans(ctx context.Context, traces ptrace.Traces) error
  • func (cor *Tracker) Shutdown(_ context.Context) error
  • func (cor *Tracker) Start(_ context.Context, host component.Host) (err error)

Types

type Config

type Config struct {
	confighttp.HTTPClientSettings `mapstructure:",squash"`
	correlations.Config           `mapstructure:",squash"`

	// How long to wait after a trace span's service name is last seen before
	// uncorrelating that service.
	StaleServiceTimeout time.Duration `mapstructure:"stale_service_timeout"`
	// SyncAttributes is a key of the span attribute name to sync to the dimension as the value.
	SyncAttributes map[string]string `mapstructure:"sync_attributes"`
}

Config defines configuration for correlation via traces.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns default configuration correlation values.

type Tracker

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

Tracker correlation

func NewTracker

func NewTracker(cfg *Config, accessToken configopaque.String, params exporter.CreateSettings) *Tracker

NewTracker creates a new tracker instance for correlation.

func (*Tracker) AddSpans

func (cor *Tracker) AddSpans(ctx context.Context, traces ptrace.Traces) error

AddSpans processes the provided spans to correlate the services and environment observed to the resources (host, pods, etc.) emitting the spans.

func (*Tracker) Shutdown

func (cor *Tracker) Shutdown(_ context.Context) error

Shutdown correlation tracking.

func (*Tracker) Start

func (cor *Tracker) Start(_ context.Context, host component.Host) (err error)

Start correlation tracking.