common

Documentation

Index

• type Collector
  • func (c *Collector) Collect(containers []stats.SampleContainer)
  • func (c *Collector) GetRequiredSystemTags() stats.SystemTagSet
  • func (c *Collector) Init() (err error)
  • func (c *Collector) Link() string
  • func (c *Collector) Run(ctx context.Context)
  • func (c *Collector) SetRunStatus(status lib.RunStatus)
• type Config
  • func NewConfig() Config
  • func (c Config) Apply(cfg Config) Config
• type Sample

Types

type Collector

type Collector struct {
	Config Config
	Type   string
	// ProcessTags is called on a map of all tags for each metric and returns a slice representation
	// of those tags that should be sent. No tags are send in case of ProcessTags being null
	ProcessTags func(map[string]string) []string

	Logger logrus.FieldLogger
	// contains filtered or unexported fields
}

Collector sends result data to statsd daemons with the ability to send to datadog as well

func (*Collector) Collect

func (c *Collector) Collect(containers []stats.SampleContainer)

Collect metrics

func (*Collector) GetRequiredSystemTags

func (c *Collector) GetRequiredSystemTags() stats.SystemTagSet

GetRequiredSystemTags Return the required system sample tags for the specific collector

func (*Collector) Init

func (c *Collector) Init() (err error)

Init sets up the collector

func (*Collector) Link

func (c *Collector) Link() string

Link returns the address of the client

func (*Collector) Run

func (c *Collector) Run(ctx context.Context)

Run the collector

func (*Collector) SetRunStatus

func (c *Collector) SetRunStatus(status lib.RunStatus)

SetRunStatus does nothing in statsd collector

type Config

type Config struct {
	Addr         null.String        `json:"addr,omitempty" envconfig:"ADDR"`
	BufferSize   null.Int           `json:"bufferSize,omitempty" envconfig:"BUFFER_SIZE"`
	Namespace    null.String        `json:"namespace,omitempty" envconfig:"NAMESPACE"`
	PushInterval types.NullDuration `json:"pushInterval,omitempty" envconfig:"PUSH_INTERVAL"`
}

Config defines the statsd configuration

func NewConfig

func NewConfig() Config

NewConfig creates a new Config instance with default values for some fields.

func (Config) Apply

func (c Config) Apply(cfg Config) Config

Apply saves config non-zero config values from the passed config in the receiver.

type Sample

type Sample struct {
	Type   stats.MetricType  `json:"type"`
	Metric string            `json:"metric"`
	Time   time.Time         `json:"time"`
	Value  float64           `json:"value"`
	Tags   map[string]string `json:"tags,omitempty"`
}

Sample defines a sample type