telegraf/plugins/outputs/stackdriver
Javier Kohen adb7a52b93 Set user agent in stackdriver output (#5901) 2019-05-24 11:24:14 -07:00
..
README.md
stackdriver.go Set user agent in stackdriver output (#5901) 2019-05-24 11:24:14 -07:00
stackdriver_test.go

README.md

Stackdriver Output Plugin

This plugin writes to the Google Cloud Stackdriver API and requires authentication with Google Cloud using either a service account or user credentials. See the Stackdriver documentation for details on pricing.

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"

  ## Additonal 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.