Stats API

    Introduced 1.2

    Returns node-level and shard-level stats for indexing request rejections.

    Request

    Sample response

    1. {
    2.   "_nodes": {
    3.     "total": 1,
    4.     "successful": 1,
    5.     "failed": 0
    6.   },
    7.   "cluster_name": "runTask",
    8.   "nodes": {
    9.     "q3e1dQjFSqyPSLAgpyQlfw": {
    10.       "timestamp": 1613072111162,
    11.       "name": "runTask-0",
    12.       "transport_address": "127.0.0.1:9300",
    13.       "host": "127.0.0.1",
    14.       "ip": "127.0.0.1:9300",
    15.       "roles": [
    16.         "data",
    17.         "ingest",
    18.         "cluster_manager",
    19.         "remote_cluster_client"
    20.       ],
    21.       "attributes": {
    22.         "testattr": "test"
    23.       },
    24.       "shard_indexing_pressure": {
    25.         "stats": {
    26.           "[index_name][0]": {
    27.             "memory": {
    28.               "current": {
    29.                 "coordinating_in_bytes": 0,
    30.                 "primary_in_bytes": 0,
    31.                 "replica_in_bytes": 0
    32.               },
    33.               "total": {
    34.                 "coordinating_in_bytes": 299,
    35.                 "primary_in_bytes": 299,
    36.                 "replica_in_bytes": 0
    37.               }
    38.             },
    39.             "rejection": {
    40.               "coordinating": {
    41.                 "coordinating_rejections": 0,
    42.                 "breakup": {
    43.                   "node_limits": 0,
    44.                   "no_successful_request_limits": 0,
    45.                   "throughput_degradation_limits": 0
    46.                 }
    47.               },
    48.               "primary": {
    49.                 "primary_rejections": 0,
    50.                 "breakup": {
    51.                   "node_limits": 0,
    52.                   "no_successful_request_limits": 0,
    53.                   "throughput_degradation_limits": 0
    54.                 }
    55.               },
    56.               "replica": {
    57.                 "replica_rejections": 0,
    58.                 "breakup": {
    59.                   "node_limits": 0,
    60.                   "no_successful_request_limits": 0,
    61.                   "throughput_degradation_limits": 0
    62.                 }
    63.               }
    64.             },
    65.             "last_successful_timestamp": {
    66.               "coordinating_last_successful_request_timestamp_in_millis": 1613072107990,
    67.               "primary_last_successful_request_timestamp_in_millis": 0,
    68.               "replica_last_successful_request_timestamp_in_millis": 0
    69.             },
    70.             "indexing": {
    71.               "coordinating_time_in_millis": 96,
    72.               "coordinating_count": 1,
    73.               "primary_time_in_millis": 0,
    74.               "primary_count": 0,
    75.               "replica_time_in_millis": 0,
    76.               "replica_count": 0
    77.             },
    78.             "memory_allocation": {
    79.               "current": {
    80.                 "current_coordinating_and_primary_bytes": 0,
    81.                 "current_replica_bytes": 0
    82.               },
    83.               "limit": {
    84.                 "current_coordinating_and_primary_limits_in_bytes": 51897,
    85.                 "current_replica_limits_in_bytes": 77845
    86.               }
    87.             }
    88.           }
    89.         },
    90.         "total_rejections_breakup": {
    91.           "node_limits": 0,
    92.           "no_successful_request_limits": 0,
    93.           "throughput_degradation_limits": 0
    94.         },
    95.         "enabled": true,
    96.         "enforced" : true
    97.       }
    98.     }
    99.   }
    100. }

    If enforced is false:

    Sample response

    1. {
    2.   "_nodes": {
    3.     "total": 1,
    4.     "successful": 1,
    5.   },
    6.   "cluster_name": "runTask",
    7.   "nodes": {
    8.     "q3e1dQjFSqyPSLAgpyQlfw": {
    9.       "timestamp": 1613072111162,
    10.       "name": "runTask-0",
    11.       "transport_address": "127.0.0.1:9300",
    13.       "ip": "127.0.0.1:9300",
    14.       "roles": [
    15.         "data",
    16.         "ingest",
    17.         "cluster_manager",
    18.         "remote_cluster_client"
    19.       ],
    20.       "attributes": {
    21.         "testattr": "test"
    22.       },
    23.       "shard_indexing_pressure": {
    24.         "stats": {
    25.           "[index_name][0]": {
    26.             "memory": {
    27.               "current": {
    28.                 "coordinating_in_bytes": 0,
    29.                 "primary_in_bytes": 0,
    30.                 "replica_in_bytes": 0
    31.               },
    32.               "total": {
    33.                 "coordinating_in_bytes": 299,
    34.                 "primary_in_bytes": 299,
    35.                 "replica_in_bytes": 0
    36.               }
    37.             },
    38.             "rejection": {
    39.               "coordinating": {
    40.                 "coordinating_rejections": 0,
    41.                 "breakup_shadow_mode": {
    42.                   "node_limits": 0,
    43.                   "no_successful_request_limits": 0,
    44.                   "throughput_degradation_limits": 0
    45.                 }
    46.               },
    47.               "primary": {
    48.                 "primary_rejections": 0,
    49.                 "breakup_shadow_mode": {
    50.                   "node_limits": 0,
    51.                   "no_successful_request_limits": 0,
    52.                   "throughput_degradation_limits": 0
    53.                 }
    54.               },
    55.               "replica": {
    56.                 "replica_rejections": 0,
    57.                 "breakup_shadow_mode": {
    58.                   "node_limits": 0,
    59.                   "no_successful_request_limits": 0,
    60.                   "throughput_degradation_limits": 0
    61.                 }
    62.               }
    63.             },
    64.             "last_successful_timestamp": {
    65.               "coordinating_last_successful_request_timestamp_in_millis": 1613072107990,
    66.               "primary_last_successful_request_timestamp_in_millis": 0,
    67.               "replica_last_successful_request_timestamp_in_millis": 0
    68.             },
    69.             "indexing": {
    70.               "coordinating_time_in_millis": 96,
    71.               "coordinating_count": 1,
    72.               "primary_time_in_millis": 0,
    73.               "primary_count": 0,
    74.               "replica_time_in_millis": 0,
    75.               "replica_count": 0
    76.             },
    77.             "memory_allocation": {
    78.               "current": {
    79.                 "current_coordinating_and_primary_bytes": 0,
    80.                 "current_replica_bytes": 0
    81.               },
    82.               "limit": {
    83.                 "current_coordinating_and_primary_limits_in_bytes": 51897,
    84.                 "current_replica_limits_in_bytes": 77845
    85.               }
    86.             }
    87.           }
    88.         },
    89.         "total_rejections_breakup_shadow_mode": {
    90.           "node_limits": 0,
    91.           "no_successful_request_limits": 0,
    92.           "throughput_degradation_limits": 0
    93.         },
    94.         "enabled": true,
    95.         "enforced" : false
    96.       }
    97.     }
    98.   }
    99. }

    To include all the shards with both active and previous write operations performed on them, specify the include_all parameter:

    Request

    Sample response

    1. {
    2.   "_nodes": {
    3.     "total": 1,
    4.     "successful": 1,
    5.     "failed": 0
    6.   },
    7.   "cluster_name": "runTask",
    8.   "nodes": {
    9.     "q3e1dQjFSqyPSLAgpyQlfw": {
    10.       "timestamp": 1613072198171,
    11.       "name": "runTask-0",
    12.       "transport_address": "127.0.0.1:9300",
    13.       "host": "127.0.0.1",
    14.       "ip": "127.0.0.1:9300",
    15.       "roles": [
    16.         "data",
    17.         "ingest",
    18.         "cluster_manager",
    19.         "remote_cluster_client"
    20.       ],
    21.         "testattr": "test"
    22.       },
    23.       "shard_indexing_pressure": {
    24.         "stats": {
    25.           "[index_name][0]": {
    26.             "memory": {
    28.                 "coordinating_in_bytes": 0,
    29.                 "primary_in_bytes": 0,
    30.                 "replica_in_bytes": 0
    31.               },
    32.               "total": {
    33.                 "coordinating_in_bytes": 604,
    34.                 "primary_in_bytes": 604,
    35.                 "replica_in_bytes": 0
    36.               }
    37.             },
    38.             "rejection": {
    39.               "coordinating": {
    40.                 "coordinating_rejections": 0,
    41.                 "breakup": {
    42.                   "node_limits": 0,
    43.                   "no_successful_request_limits": 0,
    44.                   "throughput_degradation_limits": 0
    45.                 }
    46.               },
    47.               "primary": {
    48.                 "primary_rejections": 0,
    49.                 "breakup": {
    50.                   "node_limits": 0,
    51.                   "no_successful_request_limits": 0,
    52.                   "throughput_degradation_limits": 0
    53.                 }
    54.               },
    55.               "replica": {
    56.                 "replica_rejections": 0,
    57.                 "breakup": {
    58.                   "node_limits": 0,
    59.                   "no_successful_request_limits": 0,
    60.                   "throughput_degradation_limits": 0
    61.                 }
    62.               }
    63.             },
    64.             "last_successful_timestamp": {
    65.               "coordinating_last_successful_request_timestamp_in_millis": 1613072194656,
    66.               "primary_last_successful_request_timestamp_in_millis": 0,
    67.               "replica_last_successful_request_timestamp_in_millis": 0
    68.             },
    69.             "indexing": {
    70.               "coordinating_time_in_millis": 145,
    71.               "coordinating_count": 2,
    72.               "primary_time_in_millis": 0,
    73.               "primary_count": 0,
    74.               "replica_time_in_millis": 0,
    75.               "replica_count": 0
    76.             },
    77.             "memory_allocation": {
    78.               "current": {
    79.                 "current_coordinating_and_primary_bytes": 0,
    80.                 "current_replica_bytes": 0
    81.               },
    82.               "limit": {
    83.                 "current_coordinating_and_primary_limits_in_bytes": 51897,
    84.                 "current_replica_limits_in_bytes": 77845
    85.               }
    86.             }
    87.           }
    88.         },
    89.         "total_rejections_breakup": {
    90.           "node_limits": 0,
    91.           "no_successful_request_limits": 0,
    92.           "throughput_degradation_limits": 0
    93.         },
    94.         "enabled": true,
    95.         "enforced": true
    96.       }
    97.     }
    98.   }
    99. }

    Request

    1. GET _nodes/_local/stats/shard_indexing_pressure?top

    If enforced is true:

    Sample response

    If enforced is false:

    Sample response

    1. {
    2.   "_nodes": {
    3.     "total": 1,
    4.     "successful": 1,
    5.     "failed": 0
    6.   },
    7.   "cluster_name": "runTask",
    8.   "nodes": {
    9.     "q3e1dQjFSqyPSLAgpyQlfw": {
    10.       "timestamp": 1613072382719,
    11.       "name": "runTask-0",
    12.       "transport_address": "127.0.0.1:9300",
    13.       "host": "127.0.0.1",
    14.       "ip": "127.0.0.1:9300",
    15.       "roles": [
    16.         "data",
    17.         "ingest",
    18.         "cluster_manager",
    19.         "remote_cluster_client"
    20.       ],
    21.       "attributes": {
    22.         "testattr": "test"
    23.       },
    24.       "shard_indexing_pressure": {
    25.         "stats": {},
    26.         "total_rejections_breakup_shadow_mode": {
    27.           "node_limits": 0,
    28.           "no_successful_request_limits": 0,
    29.           "throughput_degradation_limits": 0
    30.         },
    31.         "enabled": true,
    32.         "enforced" : false
    33.       }
    34.     }
    35.   }

    Request

    1. GET _nodes/stats/shard_indexing_pressure

    Sample response