% This file is generated! See metricbeat/scripts/mage/docs_collector.go

Google Cloud Platform firestore metricset [metricbeat-metricset-gcp-firestore]

Firestore metricset fetches metrics from Firestore in Google Cloud Platform.

The firestore metricset contains all metrics exported from the GCP Firestore Monitoring API. The field names are aligned to Beats naming conventions with minor modifications to their GCP metrics name counterpart.

You can specify a single region to fetch metrics like us-central1. Be aware that GCP Storage does not use zones so us-central1-a will return nothing. If no region is specified, metrics are returned from all buckets.

Fields [_fields]

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

json

{
    "@timestamp": "2016-05-23T08:05:34.853Z",
    "cloud": {
        "account": {
            "id": "elastic-apm"
        },
        "provider": "gcp"
    },
    "event": {
        "dataset": "gcp.firestore",
        "duration": 115000,
        "module": "gcp"
    },
    "gcp": {
        "labels": {
            "metrics": {
                "storage_class": "MULTI_REGIONAL"
            },
            "resource": {
                "bucket_name": "artifacts.elastic-apm.appspot.com",
                "location": "us"
            }
        },
        "firestore": {
            "document": {
                "delete_count": {
                    "value": 15
                }
            }
        }
    },
    "metricset": {
        "name": "firestore",
        "period": 10000
    },
    "service": {
        "type": "gcp"
    }
}