Elasticsearch shard metricsetedit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

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


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": {
            "name": "elasticsearch",
            "state": {
                "id": "MBE4XrQOSf6ScXRTuCO1Pw"
        "index": {
            "name": "heartbeat-7.0.0-alpha1-2018.08.27"
        "node": {
            "name": "Z4hBonPxQVW9qPKEHpwWCg"
        "shard": {
            "number": 0,
            "primary": true,
            "state": "STARTED"
    "metricset": {
        "host": "",
        "module": "elasticsearch",
        "name": "shard",
        "namespace": "elasticsearch.shard",
        "rtt": 115
    "service": {
        "name": "elasticsearch"