config

Documentation

Index

• func PrintOutputConfig(name string) error
• func PrintPluginConfig(name string) error
• func PrintSampleConfig(pluginFilters []string, outputFilters []string)
• type AgentConfig
• type Config
  • func NewConfig() *Config
  • func (c *Config) ListTags() string
  • func (c *Config) LoadConfig(path string) error
  • func (c *Config) LoadDirectory(path string) error
  • func (c *Config) OutputNames() []string
  • func (c *Config) PluginNames() []string
• type Filter
  • func (f Filter) ShouldPass(fieldkey string) bool
  • func (f Filter) ShouldTagsPass(tags map[string]string) bool
• type OutputConfig
• type PluginConfig
• type RunningOutput
  • func (ro *RunningOutput) FilterPoints(points []*client.Point) []*client.Point
• type RunningPlugin
• type TagFilter

Functions

func PrintOutputConfig

func PrintOutputConfig(name string) error

PrintOutputConfig prints the config usage of a single output.

func PrintPluginConfig

func PrintPluginConfig(name string) error

PrintPluginConfig prints the config usage of a single plugin.

func PrintSampleConfig

func PrintSampleConfig(pluginFilters []string, outputFilters []string)

PrintSampleConfig prints the sample config

Types

type AgentConfig

type AgentConfig struct {
	// Interval at which to gather information
	Interval internal.Duration

	// RoundInterval rounds collection interval to 'interval'.
	//     ie, if Interval=10s then always collect on :00, :10, :20, etc.
	RoundInterval bool

	// Interval at which to flush data
	FlushInterval internal.Duration

	// FlushRetries is the number of times to retry each data flush
	FlushRetries int

	// FlushJitter tells
	FlushJitter internal.Duration

	// TODO(cam): Remove UTC and Precision parameters, they are no longer
	// valid for the agent config. Leaving them here for now for backwards-
	// compatability
	UTC       bool `toml:"utc"`
	Precision string

	// Option for running in debug mode
	Debug    bool
	Hostname string
}

type Config

type Config struct {
	Tags          map[string]string
	PluginFilters []string
	OutputFilters []string

	Agent   *AgentConfig
	Plugins []*RunningPlugin
	Outputs []*RunningOutput
}

Config specifies the URL/user/password for the database that telegraf will be logging to, as well as all the plugins that the user has specified

func NewConfig

func NewConfig() *Config

func (*Config) ListTags

func (c *Config) ListTags() string

ListTags returns a string of tags specified in the config, line-protocol style

func (*Config) LoadConfig

func (c *Config) LoadConfig(path string) error

LoadConfig loads the given config file and applies it to c

func (*Config) LoadDirectory

func (c *Config) LoadDirectory(path string) error

func (*Config) OutputNames

func (c *Config) OutputNames() []string

Outputs returns a list of strings of the configured plugins.

func (*Config) PluginNames

func (c *Config) PluginNames() []string

Plugins returns a list of strings of the configured plugins.

type Filter

type Filter struct {
	Drop []string
	Pass []string

	TagDrop []TagFilter
	TagPass []TagFilter

	IsActive bool
}

Filter containing drop/pass and tagdrop/tagpass rules

func (Filter) ShouldPass

func (f Filter) ShouldPass(fieldkey string) bool

ShouldPass returns true if the metric should pass, false if should drop based on the drop/pass filter parameters

func (Filter) ShouldTagsPass

func (f Filter) ShouldTagsPass(tags map[string]string) bool

ShouldTagsPass returns true if the metric should pass, false if should drop based on the tagdrop/tagpass filter parameters

type OutputConfig

type OutputConfig struct {
	Name   string
	Filter Filter
}

OutputConfig containing name and filter

type PluginConfig

type PluginConfig struct {
	Name              string
	NameOverride      string
	MeasurementPrefix string
	MeasurementSuffix string
	Tags              map[string]string
	Filter            Filter
	Interval          time.Duration
}

PluginConfig containing a name, interval, and filter

type RunningOutput

type RunningOutput struct {
	Name   string
	Output outputs.Output
	Config *OutputConfig
}

func (*RunningOutput) FilterPoints

func (ro *RunningOutput) FilterPoints(points []*client.Point) []*client.Point

Filter returns filtered slice of client.Points based on whether filters are active for this RunningOutput.

type RunningPlugin

type RunningPlugin struct {
	Name   string
	Plugin plugins.Plugin
	Config *PluginConfig
}

type TagFilter

type TagFilter struct {
	Name   string
	Filter []string
}

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