2020-03-05 18:36:36 +00:00
|
|
|
# Stackdriver Google Cloud Monitoring Output Plugin
|
2018-10-16 18:47:10 +00:00
|
|
|
|
2020-03-05 18:36:36 +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`
|
|
|
|
|
|
2019-02-08 20:13:33 +00:00
|
|
|
[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]]
|
2019-02-11 22:58:30 +00:00
|
|
|
## GCP Project
|
2018-10-16 18:47:10 +00:00
|
|
|
project = "erudite-bloom-151019"
|
|
|
|
|
|
2019-02-11 22:58:30 +00:00
|
|
|
## The namespace for the metric descriptor
|
2018-10-16 18:47:10 +00:00
|
|
|
namespace = "telegraf"
|
2019-02-08 20:13:33 +00:00
|
|
|
|
2019-02-11 22:58:30 +00:00
|
|
|
## Custom resource type
|
|
|
|
|
# resource_type = "generic_node"
|
2019-02-08 20:13:33 +00:00
|
|
|
|
2020-05-14 07:41:58 +00:00
|
|
|
## Additional resource labels
|
2019-02-11 22:58:30 +00:00
|
|
|
# [outputs.stackdriver.resource_labels]
|
|
|
|
|
# node_id = "$HOSTNAME"
|
|
|
|
|
# namespace = "myapp"
|
|
|
|
|
# location = "eu-north0"
|
2018-10-16 19:23:05 +00:00
|
|
|
```
|
2019-02-06 02:22:42 +00:00
|
|
|
|
|
|
|
|
### Restrictions
|
|
|
|
|
|
|
|
|
|
Stackdriver does not support string values in custom metrics, any string
|
|
|
|
|
fields will not be written.
|
2019-02-06 22:17:51 +00:00
|
|
|
|
|
|
|
|
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
|
2020-03-05 18:36:36 +00:00
|
|
|
[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
|
