OpenSearch/docs/reference/cluster
Lee Hinman 58db63b610 Expose the ClusterInfo object in the allocation explain output
This adds an optional parameter to the cluster allocation explain API
that will return the cluster info object, `include_disk_info`, the
output looks like:

GET /_cluster/allocation/explain?include_disk_info -d'
{"index": "i", "shard": 0, "primary": false}'

{
  ... other info ...

  "cluster_info" : {
    "nodes" : {
      "7Uws-vL7R6WVm3ZwQA1n5A" : {
        "node_name" : "Kraven the Hunter",
        "least_available" : {
          "path" : "/path/to/data1",
          "total_bytes" : 165999570944,
          "used_bytes" : 118180614144,
          "free_bytes" : 47818956800,
          "free_disk_percent" : 28.80667493781158,
          "used_disk_percent" : 71.19332506218842
        },
        "most_available" : {
          "path" : "/path/to/data2",
          "total_bytes" : 165999570944,
          "used_bytes" : 118180614144,
          "free_bytes" : 47818956800,
          "free_disk_percent" : 28.80667493781158,
          "used_disk_percent" : 71.19332506218842
        }
      }
    },
    "shard_sizes" : {
      "[i][2][p]_bytes" : 0,
      "[i][4][p]_bytes" : 130,
      "[i][1][p]_bytes" : 0,
      "[i][3][p]_bytes" : 0,
      "[i][0][p]_bytes" : 130
    },
    "shard_paths" : {
      "[i][3], node[7Uws-vL7R6WVm3ZwQA1n5A], [P], s[STARTED], a[id=LegZLDniTVaw0Y1urv7s3g]" : "/path/to/data1/nodes/0",
      "[i][1], node[7Uws-vL7R6WVm3ZwQA1n5A], [P], s[STARTED], a[id=lAU_4vf_SKmoRdtg0ACnjQ]" : "/path/to/data1/nodes/0",
      "[i][2], node[7Uws-vL7R6WVm3ZwQA1n5A], [P], s[STARTED], a[id=Aurpeuj7SeGeyPDDpCtRgg]" : "/path/to/data1/nodes/0",
      "[i][0], node[7Uws-vL7R6WVm3ZwQA1n5A], [P], s[STARTED], a[id=Vgg8GlQTQ82C2j6HYBq8DQ]" : "/path/to/data1/nodes/0",
      "[i][4], node[7Uws-vL7R6WVm3ZwQA1n5A], [P], s[STARTED], a[id=t8hQlVSxQe-58fSeaXcAqg]" : "/path/to/data1/nodes/0"
    }
  }
}

Resolves #14405
2016-07-12 15:52:20 -06:00
..
allocation-explain.asciidoc Expose the ClusterInfo object in the allocation explain output 2016-07-12 15:52:20 -06:00
health.asciidoc Added desc for parameter <local> 2015-12-11 22:26:33 -02:00
nodes-hot-threads.asciidoc Core: ignore known idle threads by default in /_nodes/hot_threads 2014-12-17 11:59:31 -05:00
nodes-info.asciidoc add indices nodes info flag to docs 2016-06-20 14:23:32 -04:00
nodes-stats.asciidoc Add I/O statistics on Linux 2016-05-17 16:16:39 -04:00
pending.asciidoc Update task management docs to reflect the latest changes in the interface 2016-03-29 12:26:37 -04:00
reroute.asciidoc Limit retries of failed allocations per index (#18467) 2016-05-20 20:37:45 +02:00
state.asciidoc Cluster State API: Remove index template filtering 2014-05-05 14:54:14 +02:00
stats.asciidoc Remove index_writer_max_memory stat from segment stats 2016-05-31 06:29:29 -04:00
tasks.asciidoc Create get task API that falls back to the .tasks index 2016-06-14 13:37:34 -04:00
update-settings.asciidoc Clarification about precedence of settings 2016-03-10 14:29:51 +01:00