82 lines
2.4 KiB
Markdown
82 lines
2.4 KiB
Markdown
|
# Google Cloud Storage Input Plugin
|
||
|
|
|
||
|
|
This plugin will collect metrics from the given [Google Cloud Storage][gcs]
|
||
|
|
buckets in any of the supported [data formats][data_formats].
|
||
|
|
|
||
|
|
⭐ Telegraf v1.25.0
|
||
|
|
🏷️ cloud, datastore
|
||
|
|
💻 all
|
||
|
|
|
||
|
|
[gcs]: https://cloud.google.com/storage
|
||
|
|
[data_formats]: /docs/DATA_FORMATS_INPUT.md
|
||
|
|
|
||
|
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
||
|
|
|
||
|
|
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][CONFIGURATION.md] for more details.
|
||
|
|
|
||
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
```toml @sample.conf
|
||
|
|
# Gather metrics by iterating the files located on a Cloud Storage Bucket.
|
||
|
|
[[inputs.google_cloud_storage]]
|
||
|
|
## Required. Name of Cloud Storage bucket to ingest metrics from.
|
||
|
|
bucket = "my-bucket"
|
||
|
|
|
||
|
|
## Optional. Prefix of Cloud Storage bucket keys to list metrics from.
|
||
|
|
# key_prefix = "my-bucket"
|
||
|
|
|
||
|
|
## Key that will store the offsets in order to pick up where the ingestion was left.
|
||
|
|
offset_key = "offset_key"
|
||
|
|
|
||
|
|
## Key that will store the offsets in order to pick up where the ingestion was left.
|
||
|
|
objects_per_iteration = 10
|
||
|
|
|
||
|
|
## Required. Data format to consume.
|
||
|
|
## Each data format has its own unique set of configuration options.
|
||
|
|
## Read more about them here:
|
||
|
|
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
|
||
|
|
data_format = "influx"
|
||
|
|
|
||
|
|
## Optional. Filepath for GCP credentials JSON file to authorize calls to
|
||
|
|
## Google Cloud Storage APIs. If not set explicitly, Telegraf will attempt to use
|
||
|
|
## Application Default Credentials, which is preferred.
|
||
|
|
# credentials_file = "path/to/my/creds.json"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Metrics
|
||
|
|
|
||
|
|
Measurements will reside on Google Cloud Storage with the format specified, for
|
||
|
|
example like
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"metrics": [
|
||
|
|
{
|
||
|
|
"fields": {
|
||
|
|
"cosine": 10,
|
||
|
|
"sine": -1.0975806427415925e-12
|
||
|
|
},
|
||
|
|
"name": "cpu",
|
||
|
|
"tags": {
|
||
|
|
"datacenter": "us-east-1",
|
||
|
|
"host": "localhost"
|
||
|
|
},
|
||
|
|
"timestamp": 1604148850990
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
when the [data format][data_formats] is set to `json`.
|
||
|
|
|
||
|
|
## Example Output
|
||
|
|
|
||
|
|
```text
|
||
|
|
google_cloud_storage,datacenter=us-east-1,host=localhost cosine=10,sine=-1.0975806427415925e-12 1604148850990000000
|
||
|
|
```
|