Docs
Metricbeat Reference [7.16] » Modules » Elasticsearch module » Elasticsearch shard metricset
« Elasticsearch pending_tasks metricset Enterprise Search module »

Elasticsearch shard metricsetedit

The shard metricset interrogates the Cluster State API endpoint to fetch information about all shards.

This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.

Fieldsedit

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

Here is an example document generated by this metricset:

{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "beat": {
        "hostname": "host.example.com",
        "name": "host.example.com"
    },
    "elasticsearch": {
        "cluster": {
            "id": "91RpCx2xSQ21pVPTZfDK0Q",
            "name": "elasticsearch",
            "state": {
                "id": "MBE4XrQOSf6ScXRTuCO1Pw"
            }
        },
        "index": {
            "name": "heartbeat-7.0.0-alpha1-2018.08.27"
        },
        "node": {
            "name": "Z4hBonPxQVW9qPKEHpwWCg"
        },
        "shard": {
            "number": 0,
            "primary": true,
            "relocating_node": {
                "name": null
            },
            "state": "STARTED"
        }
    },
    "metricset": {
        "host": "127.0.0.1:9200",
        "module": "elasticsearch",
        "name": "shard",
        "namespace": "elasticsearch.shard",
        "rtt": 115
    },
    "service": {
        "name": "elasticsearch"
    }
}
« Elasticsearch pending_tasks metricset Enterprise Search module »