Elasticsearch index_recovery 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.

This is the index_recovery metricset of the module Elasticsearch.

By default only data about indices which are under active recovery are fetched. To gather data about all indices set index_recovery.active_only: false:

- module: elasticsearch
    - index_recovery
  hosts: ["localhost:9200"]
  index_recovery.active_only: false


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": {
        "index": {
            "name": "test-index",
            "recovery": {
                "id": 0,
                "primary": true,
                "source": {},
                "stage": "DONE",
                "target": {
                    "host": "",
                    "id": "ODWb5m6zT9q0lf8YTPyWWg",
                    "name": "ODWb5m6"
                "type": "EMPTY_STORE"
    "metricset": {
        "host": "",
        "module": "elasticsearch",
        "name": "index_recovery",
        "namespace": "elasticsearch.index.recovery",
        "rtt": 115
    "service": {
        "name": "elasticsearch"