---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Google Cloud Storage
url: https://docs.influxdata.com/telegraf/v1/input-plugins/google_cloud_storage/
estimated_tokens: 1725
product: Telegraf
version: v1
---

-   Telegraf v1.25.0+

# Google Cloud Storage Input Plugin

This plugin will collect metrics from the given [Google Cloud Storage](https://cloud.google.com/storage) buckets in any of the supported [data formats](/telegraf/v1/data_formats/input).

**Introduced in:** Telegraf v1.25.0 **Tags:** cloud, datastore **OS support:** all

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# 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](/telegraf/v1/data_formats/input) is set to `json`.

## Example Output

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

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Google Cloud Storage Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/google_cloud_storage/README.md)