History

Joshua Powers 0d8d118319 chore: clean up all markdown lint errors in output plugins (#10159 )		2021-11-24 11:47:33 -07:00
..
README.md	chore: clean up all markdown lint errors in output plugins (#10159 )	2021-11-24 11:47:33 -07:00
instrumental.go	Allow more characters in graphite tags (#9249 )	2021-05-18 12:29:30 -04:00
instrumental_test.go	Remove error return type from metric.New method (#9116 )	2021-04-13 14:40:03 -04:00

README.md

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