tracer

Documentation

Index

• type CloudTraceConfig
  • func NewCloudTraceConfig() CloudTraceConfig
• type Config
  • func NewConfig() Config
  • func (conf *Config) UnmarshalYAML(value *yaml.Node) error
• type JaegerConfig
  • func NewJaegerConfig() JaegerConfig
• type Noop
  • func (n Noop) Close() error
• type Type

Types

type CloudTraceConfig

type CloudTraceConfig struct {
	Project       string            `json:"project" yaml:"project"`
	SamplingRatio float64           `json:"sampling_ratio" yaml:"sampling_ratio"`
	Tags          map[string]string `json:"tags" yaml:"tags"`
	FlushInterval string            `json:"flush_interval" yaml:"flush_interval"`
}

CloudTraceConfig is config for the Google Cloud Trace tracer.

func NewCloudTraceConfig

func NewCloudTraceConfig() CloudTraceConfig

NewCloudTraceConfig creates an CloudTraceConfig struct with default values.

type Config

type Config struct {
	Type       string           `json:"type" yaml:"type"`
	Jaeger     JaegerConfig     `json:"jaeger" yaml:"jaeger"`
	CloudTrace CloudTraceConfig `json:"gcp_cloudtrace" yaml:"gcp_cloudtrace"`
	None       struct{}         `json:"none" yaml:"none"`
}

Config is the all encompassing configuration struct for all tracer types.

func NewConfig

func NewConfig() Config

NewConfig returns a configuration struct fully populated with default values.

func (*Config) UnmarshalYAML

func (conf *Config) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML ensures that when parsing configs that are in a map or slice the default values are still applied.

type JaegerConfig

type JaegerConfig struct {
	AgentAddress  string            `json:"agent_address" yaml:"agent_address"`
	CollectorURL  string            `json:"collector_url" yaml:"collector_url"`
	SamplerType   string            `json:"sampler_type" yaml:"sampler_type"`
	SamplerParam  float64           `json:"sampler_param" yaml:"sampler_param"`
	Tags          map[string]string `json:"tags" yaml:"tags"`
	FlushInterval string            `json:"flush_interval" yaml:"flush_interval"`
}

JaegerConfig is config for the Jaeger metrics type.

func NewJaegerConfig

func NewJaegerConfig() JaegerConfig

NewJaegerConfig creates an JaegerConfig struct with default values.

type Noop

type Noop struct{}

Noop is a no-operation implementation of a tracer.

func (Noop) Close

func (n Noop) Close() error

Close does nothing.

type Type

type Type interface {
	// Close stops and cleans up the tracers resources.
	Close() error
}

Type is an interface implemented by all tracer types.