telegraf/plugins/outputs/stackdriver
Josh Soref 2c56d6de81
Fix spelling errors in comments and documentation (#7492)
2020-05-14 00:41:58 -07:00
..
README.md Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
stackdriver.go Fix spelling errors in comments and documentation (#7492) 2020-05-14 00:41:58 -07:00
stackdriver_test.go Fix delete in place of keys in stackdriver output (#5465) 2019-02-21 12:19:50 -08:00

README.md

Stackdriver Google Cloud Monitoring Output Plugin

This plugin writes to the Google Cloud Monitoring API (formerly Stackdriver) and requires authentication with Google Cloud using either a service account or user credentials

This plugin accesses APIs which are chargeable; you might incur costs.

Requires project to specify where Stackdriver metrics will be delivered to.

Metrics are grouped by the namespace variable and metric key - eg: custom.googleapis.com/telegraf/system/load5

Resource type is configured by the resource_type variable (default global).

Additional resource labels can be configured by resource_labels. By default the required project_id label is always set to the project variable.

Configuration

[[outputs.stackdriver]]
  ## GCP Project
  project = "erudite-bloom-151019"

  ## The namespace for the metric descriptor
  namespace = "telegraf"

  ## Custom resource type
  # resource_type = "generic_node"

  ## Additional resource labels
  # [outputs.stackdriver.resource_labels]
  #   node_id = "$HOSTNAME"
  #   namespace = "myapp"
  #   location = "eu-north0"

Restrictions

Stackdriver does not support string values in custom metrics, any string fields will not be written.

The Stackdriver API does not allow writing points which are out of order, older than 24 hours, or more with resolution greater than than one per point minute. Since Telegraf writes the newest points first and moves backwards through the metric buffer, it may not be possible to write historical data after an interruption.

Points collected with greater than 1 minute precision may need to be aggregated before then can be written. Consider using the basicstats aggregator to do this.