telegraf

README

Telegraf - A native agent for InfluxDB

Quickstart

• Build from source or download telegraf (binaries forthcoming)
• Run telegraf -sample-config > telegraf.toml to create an initial configuration
• Edit the configuration to match your needs
• Run telegraf -config telegraf.toml -test to output one full measurement sample to STDOUT
• Run telegraf -config telegraf.toml to gather and send metrics to InfluxDB

Telegraf Options

Telegraf has a few options you can configure under the agent section of the config. If you don't see an agent section run telegraf -sample-config > telegraf.toml to create a valid initial configuration:

• hostname: The hostname is passed as a tag. By default this will be the value retured by hostname on the machine running Telegraf. You can override that value here.
• interval: How ofter to gather metrics. Uses a simple number + unit parser, ie "10s" for 10 seconds or "5m" for 5 minutes.
• debug: Set to true to gather and send metrics to STDOUT as well as InfluxDB.

Plugin Options

There are 3 configuration options that are configurable per plugin:

• pass: An array of strings that is used to filter metrics generated by the current plugin. Each string in the array is tested as a prefix against metrics and if it matches, the metric is emitted.
• drop: The inverse of pass, if a metric matches, it is not emitted.
• interval: How often to gather this metric. Normal plugins use a single global interval, but if one particular plugin should be run less or more often, you can configure that here.

Documentation

Index

• Variables
• func PrintSampleConfig()
• type Agent
  • func NewAgent(config *Config) (*Agent, error)
  • func (agent *Agent) Connect() error
  • func (a *Agent) LoadPlugins() ([]string, error)
  • func (a *Agent) Run(shutdown chan struct{}) error
  • func (a *Agent) Test() error
  • func (a *Agent) TestAllPlugins() error
• type BatchPoints
  • func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]string)
  • func (bp *BatchPoints) AddValuesWithTime(measurement string, values map[string]interface{}, tags map[string]string, ...)
• type Config
  • func DefaultConfig() *Config
  • func LoadConfig(path string) (*Config, error)
  • func (c *Config) ApplyAgent(v interface{}) error
  • func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, error)
  • func (c *Config) ListTags() string
  • func (c *Config) Plugins() map[string]*ast.Table
  • func (c *Config) PluginsDeclared() []string
• type ConfiguredPlugin
  • func (cp *ConfiguredPlugin) ShouldPass(measurement string) bool
• type Duration
  • func (d *Duration) UnmarshalTOML(b []byte) error

Variables

var ErrInvalidConfig = errors.New("invalid configuration")

Functions

func PrintSampleConfig

func PrintSampleConfig()

Types

type Agent

type Agent struct {
	Interval Duration
	Debug    bool
	Hostname string

	Config *Config
	// contains filtered or unexported fields
}

func NewAgent

func NewAgent(config *Config) (*Agent, error)

func (*Agent) Connect

func (agent *Agent) Connect() error

func (*Agent) LoadPlugins

func (a *Agent) LoadPlugins() ([]string, error)

func (*Agent) Run

func (a *Agent) Run(shutdown chan struct{}) error

func (*Agent) Test

func (a *Agent) Test() error

func (*Agent) TestAllPlugins

func (a *Agent) TestAllPlugins() error

type BatchPoints

type BatchPoints struct {
	client.BatchPoints

	Debug bool

	Prefix string

	Config *ConfiguredPlugin
}

func (*BatchPoints) Add

func (bp *BatchPoints) Add(measurement string, val interface{}, tags map[string]string)

func (*BatchPoints) AddValuesWithTime

func (bp *BatchPoints) AddValuesWithTime(
	measurement string,
	values map[string]interface{},
	tags map[string]string,
	timestamp time.Time,
)

type Config

type Config struct {
	URL       string
	Username  string
	Password  string
	Database  string
	UserAgent string
	Tags      map[string]string
	// contains filtered or unexported fields
}

func DefaultConfig

func DefaultConfig() *Config

func LoadConfig

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

func (*Config) ApplyAgent

func (c *Config) ApplyAgent(v interface{}) error

func (*Config) ApplyPlugin

func (c *Config) ApplyPlugin(name string, v interface{}) (*ConfiguredPlugin, error)

func (*Config) ListTags

func (c *Config) ListTags() string

func (*Config) Plugins

func (c *Config) Plugins() map[string]*ast.Table

func (*Config) PluginsDeclared

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

type ConfiguredPlugin

type ConfiguredPlugin struct {
	Name string

	Drop []string
	Pass []string

	Interval time.Duration
}

func (*ConfiguredPlugin) ShouldPass

func (cp *ConfiguredPlugin) ShouldPass(measurement string) bool

type Duration

type Duration struct {
	time.Duration
}

func (*Duration) UnmarshalTOML

func (d *Duration) UnmarshalTOML(b []byte) error