telegraf/plugins/inputs/google_cloud_storage
Dane Strandboge 19737fcb52
chore(linters): Fix remaining errcheck warnings (#15518)
Co-authored-by: Joshua Powers <powersj@fastmail.com>
2024-07-10 12:51:25 +02:00
..
testdata chore: Wrap long lines in plugins/inputs/[e-h]* (#12186) 2022-11-08 14:42:05 -06:00
README.md chore: Update README.md (#12989) 2023-04-04 13:43:49 +02:00
google_cloud_storage.go chore: Fix typos throughout codebase (#15338) 2024-05-31 10:26:37 +02:00
google_cloud_storage_test.go chore(linters): Fix remaining errcheck warnings (#15518) 2024-07-10 12:51:25 +02:00
sample.conf docs: remove trailing whitespace (#12660) 2023-02-09 12:35:18 -07:00

README.md

Google Cloud Storage Input Plugin

The Google Cloud Storage plugin will collect metrics on the given Google Cloud Storage Buckets.

Global configuration options

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 for more details.

Configuration

# 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

{
  "metrics": [
    {
      "fields": {
        "cosine": 10,
        "sine": -1.0975806427415925e-12
      },
      "name": "cpu",
      "tags": {
        "datacenter": "us-east-1",
        "host": "localhost"
      },
      "timestamp": 1604148850990
    }
  ]
}

Example Output

google_cloud_storage,datacenter=us-east-1,host=localhost cosine=10,sine=-1.0975806427415925e-12 1604148850990000000