docs-v2/content/telegraf/v1/output-plugins/instrumental/_index.md

description	menu	tags	introduced	os_support	related
Telegraf plugin for sending metrics to Instrumental	telegraf_v1_ref parent name identifier output_plugins_reference Instrumental output-instrumental	Instrumental output-plugins configuration applications	v0.13.1	freebsd, linux, macos, solaris, windows	/telegraf/v1/configure_plugins/ https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/outputs/instrumental/README.md, Instrumental Plugin Source

Instrumental Output Plugin

This plugin writes metrics 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 via the statsd input plugin.

Introduced in: Telegraf v0.13.1 Tags: applications OS support: all

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.

Secret-store support

This plugin supports secrets from secret-stores for the api_token option. See the secret-store documentation for more details on how to use them.

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