README
¶
Instrumental Output Plugin
This plugin writes to the Instrumental Collector API and requires a Project-specific API token.
Instrumental accepts stats in a format very close to Graphite, with the only difference being that
the type of stat (gauge, increment) is the first token, separated from the metric itself
by whitespace. The increment
type is only used if the metric comes in as a counter through [[input.statsd]]
.
Configuration:
[[outputs.instrumental]]
## Project API Token (required)
api_token = "API Token" # required
## Prefix the metrics with a given name
prefix = ""
## Stats output template (Graphite formatting)
## see https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md#graphite
template = "host.tags.measurement.field"
## Timeout in seconds to connect
timeout = "2s"
## Debug true - Print communication to Instrumental
debug = false
Documentation
¶
Index ¶
Constants ¶
View Source
const ( DefaultHost = "collector.instrumentalapp.com" HelloMessage = "hello version go/telegraf/1.1\n" AuthFormat = "authenticate %s\n" HandshakeFormat = HelloMessage + AuthFormat )
Variables ¶
View Source
var ( ValueIncludesBadChar = regexp.MustCompile("[^[:digit:].]") MetricNameReplacer = regexp.MustCompile("[^-[:alnum:]_.]+") )
Functions ¶
This section is empty.
Types ¶
type Instrumental ¶
type Instrumental struct { Host string `toml:"host"` APIToken string `toml:"api_token"` Prefix string `toml:"prefix"` DataFormat string `toml:"data_format"` Template string `toml:"template"` Templates []string `toml:"templates"` Timeout config.Duration `toml:"timeout"` Debug bool `toml:"debug"` Log telegraf.Logger `toml:"-"` // contains filtered or unexported fields }
func (*Instrumental) Close ¶
func (i *Instrumental) Close() error
func (*Instrumental) Connect ¶
func (i *Instrumental) Connect() error
func (*Instrumental) Description ¶
func (i *Instrumental) Description() string
func (*Instrumental) SampleConfig ¶
func (i *Instrumental) SampleConfig() string
Click to show internal directories.
Click to hide internal directories.