telegraf/plugins/outputs/stackdriver/README.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

# Stackdriver Google Cloud Monitoring Output Plugin
2018-10-16 18:47:10 +00:00
This plugin writes to the [Google Cloud Monitoring API][stackdriver] (formerly
Stackdriver) and requires [authentication][] with Google Cloud using either a
service account or user credentials
This plugin accesses APIs which are [chargeable][pricing]; you might incur
costs.
2018-10-16 18:47:10 +00:00
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](https://cloud.google.com/monitoring/api/resources) 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.
2018-10-16 18:47:10 +00:00
### Configuration
2018-10-16 19:23:05 +00:00
```toml
[[outputs.stackdriver]]
## GCP Project
2018-10-16 18:47:10 +00:00
project = "erudite-bloom-151019"
## The namespace for the metric descriptor
2018-10-16 18:47:10 +00:00
namespace = "telegraf"
## Custom resource type
# resource_type = "generic_node"
## Additional resource labels
# [outputs.stackdriver.resource_labels]
# node_id = "$HOSTNAME"
# namespace = "myapp"
# location = "eu-north0"
2018-10-16 19:23:05 +00:00
```
### 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.
[basicstats]: /plugins/aggregators/basicstats/README.md
[stackdriver]: https://cloud.google.com/monitoring/api/v3/
[authentication]: https://cloud.google.com/docs/authentication/getting-started
[pricing]: https://cloud.google.com/stackdriver/pricing#stackdriver_monitoring_services