History

Joshua Powers 49ac03fa80 docs: add global configuration header (#12107 )		2022-10-26 14:58:36 -05:00
..
README.md	docs: add global configuration header (#12107 )	2022-10-26 14:58:36 -05:00
instrumental.go	docs: Remove warning not to remove go:embed (#11797 )	2022-09-13 12:47:58 -05:00
instrumental_test.go	fix: check net.Listen() error in tests (#11093 )	2022-05-16 13:37:53 -06:00
sample.conf	chore(outputs): migrate sample configs into separate files (#11131 )	2022-05-18 11:30:06 -05: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]].

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Configuration for sending metrics to an Instrumental project
[[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