models

Documentation

Index

• Constants
• Variables
• type AggregatorConfig
• type Filter
  • func (f *Filter) Compile() error
  • func (f *Filter) IsActive() bool
  • func (f *Filter) Modify(metric telegraf.Metric)
  • func (f *Filter) Select(metric telegraf.Metric) bool
• type InputConfig
• type OutputConfig
• type ProcessorConfig
• type RunningAggregator
  • func NewRunningAggregator(a telegraf.Aggregator, conf *AggregatorConfig) *RunningAggregator
  • func (r *RunningAggregator) Add(metric telegraf.Metric) bool
  • func (r *RunningAggregator) MakeMetric(metric telegraf.Metric) telegraf.Metric
  • func (r *RunningAggregator) Name() string
  • func (r *RunningAggregator) Run(acc telegraf.Accumulator, shutdown chan struct{})
• type RunningInput
  • func NewRunningInput(input telegraf.Input, config *InputConfig) *RunningInput
  • func (r *RunningInput) MakeMetric(metric telegraf.Metric) telegraf.Metric
  • func (r *RunningInput) Name() string
  • func (r *RunningInput) SetDefaultTags(tags map[string]string)
  • func (r *RunningInput) SetTrace(trace bool)
  • func (r *RunningInput) Trace() bool
• type RunningOutput
  • func NewRunningOutput(name string, output telegraf.Output, conf *OutputConfig, batchSize int, ...) *RunningOutput
  • func (ro *RunningOutput) AddMetric(metric telegraf.Metric)
  • func (ro *RunningOutput) Write() error
• type RunningProcessor
  • func (rp *RunningProcessor) Apply(in ...telegraf.Metric) []telegraf.Metric
• type RunningProcessors
  • func (rp RunningProcessors) Len() int
  • func (rp RunningProcessors) Less(i, j int) bool
  • func (rp RunningProcessors) Swap(i, j int)
• type TagFilter

Constants

const (
	// Default size of metrics batch size.
	DEFAULT_METRIC_BATCH_SIZE = 1000

	// Default number of metrics kept. It should be a multiple of batch size.
	DEFAULT_METRIC_BUFFER_LIMIT = 10000
)

Variables

var GlobalMetricsGathered = selfstat.Register("agent", "metrics_gathered", map[string]string{})

Types

type AggregatorConfig

type AggregatorConfig struct {
	Name         string
	DropOriginal bool
	Period       time.Duration
	Delay        time.Duration

	NameOverride      string
	MeasurementPrefix string
	MeasurementSuffix string
	Tags              map[string]string
	Filter            Filter
}

AggregatorConfig is the common config for all aggregators.

type Filter

type Filter struct {
	NameDrop []string

	NamePass []string

	FieldDrop []string

	FieldPass []string

	TagDrop []TagFilter
	TagPass []TagFilter

	TagExclude []string

	TagInclude []string
	// contains filtered or unexported fields
}

Filter containing drop/pass and tagdrop/tagpass rules

func (*Filter) Compile

func (f *Filter) Compile() error

Compile all Filter lists into filter.Filter objects.

func (*Filter) IsActive

func (f *Filter) IsActive() bool

IsActive checking if filter is active

func (*Filter) Modify

func (f *Filter) Modify(metric telegraf.Metric)

Modify removes any tags and fields from the metric according to the fieldpass/fielddrop and taginclude/tagexclude filters.

func (*Filter) Select

func (f *Filter) Select(metric telegraf.Metric) bool

Select returns true if the metric matches according to the namepass/namedrop and tagpass/tagdrop filters. The metric is not modified.

type InputConfig

type InputConfig struct {
	Name     string
	Interval time.Duration

	NameOverride      string
	MeasurementPrefix string
	MeasurementSuffix string
	Tags              map[string]string
	Filter            Filter
}

InputConfig is the common config for all inputs.

type OutputConfig

type OutputConfig struct {
	Name   string
	Filter Filter
}

OutputConfig containing name and filter

type ProcessorConfig

type ProcessorConfig struct {
	Name   string
	Order  int64
	Filter Filter
}

FilterConfig containing a name and filter

type RunningAggregator

type RunningAggregator struct {
	Config *AggregatorConfig
	// contains filtered or unexported fields
}

func NewRunningAggregator

func NewRunningAggregator(
	a telegraf.Aggregator,
	conf *AggregatorConfig,
) *RunningAggregator

func (*RunningAggregator) Add

func (r *RunningAggregator) Add(metric telegraf.Metric) bool

Add a metric to the aggregator and return true if the original metric should be dropped.

func (*RunningAggregator) MakeMetric

func (r *RunningAggregator) MakeMetric(metric telegraf.Metric) telegraf.Metric

func (*RunningAggregator) Name

func (r *RunningAggregator) Name() string

func (*RunningAggregator) Run

func (r *RunningAggregator) Run(
	acc telegraf.Accumulator,
	shutdown chan struct{},
)

Run runs the running aggregator, listens for incoming metrics, and waits for period ticks to tell it when to push and reset the aggregator.

type RunningInput

type RunningInput struct {
	Input  telegraf.Input
	Config *InputConfig

	MetricsGathered selfstat.Stat
	// contains filtered or unexported fields
}

func NewRunningInput

func NewRunningInput(
	input telegraf.Input,
	config *InputConfig,
) *RunningInput

func (*RunningInput) MakeMetric

func (r *RunningInput) MakeMetric(metric telegraf.Metric) telegraf.Metric

func (*RunningInput) Name

func (r *RunningInput) Name() string

func (*RunningInput) SetDefaultTags

func (r *RunningInput) SetDefaultTags(tags map[string]string)

func (*RunningInput) SetTrace

func (r *RunningInput) SetTrace(trace bool)

func (*RunningInput) Trace

func (r *RunningInput) Trace() bool

type RunningOutput

type RunningOutput struct {
	Name              string
	Output            telegraf.Output
	Config            *OutputConfig
	MetricBufferLimit int
	MetricBatchSize   int

	MetricsFiltered selfstat.Stat
	MetricsWritten  selfstat.Stat
	BufferSize      selfstat.Stat
	BufferLimit     selfstat.Stat
	WriteTime       selfstat.Stat
	// contains filtered or unexported fields
}

RunningOutput contains the output configuration

func NewRunningOutput

func NewRunningOutput(
	name string,
	output telegraf.Output,
	conf *OutputConfig,
	batchSize int,
	bufferLimit int,
) *RunningOutput

func (*RunningOutput) AddMetric

func (ro *RunningOutput) AddMetric(metric telegraf.Metric)

AddMetric adds a metric to the output. This function can also write cached points if FlushBufferWhenFull is true.

func (*RunningOutput) Write

func (ro *RunningOutput) Write() error

Write writes all cached points to this output.

type RunningProcessor

type RunningProcessor struct {
	Name string

	sync.Mutex
	Processor telegraf.Processor
	Config    *ProcessorConfig
}

func (*RunningProcessor) Apply

func (rp *RunningProcessor) Apply(in ...telegraf.Metric) []telegraf.Metric

type RunningProcessors

type RunningProcessors []*RunningProcessor

func (RunningProcessors) Len

func (rp RunningProcessors) Len() int

func (RunningProcessors) Less

func (rp RunningProcessors) Less(i, j int) bool

func (RunningProcessors) Swap

func (rp RunningProcessors) Swap(i, j int)

type TagFilter

type TagFilter struct {
	Name   string
	Filter []string
	// contains filtered or unexported fields
}

TagFilter is the name of a tag, and the values on which to filter