mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
5fca68a155
This commit adds telemetry for our data tier formalization. This telemetry helps determine the
topology of the cluster with regard to the content, hot, warm, & cold tiers/roles.
An example of the telemetry looks like:
```
GET /_xpack/usage?human
{
...
"data_tiers" : {
"available" : true,
"enabled" : true,
"data_warm" : {
...
},
"data_cold" : {
...
},
"data_content" : {
"node_count" : 1,
"index_count" : 6,
"total_shard_count" : 6,
"primary_shard_count" : 6,
"doc_count" : 71,
"total_size" : "59.6kb",
"total_size_bytes" : 61110,
"primary_size" : "59.6kb",
"primary_size_bytes" : 61110,
"primary_shard_size_avg" : "9.9kb",
"primary_shard_size_avg_bytes" : 10185,
"primary_shard_size_median" : "8kb",
"primary_shard_size_median_bytes" : 8254,
"primary_shard_size_mad" : "7.2kb",
"primary_shard_size_mad_bytes" : 7391
},
"data_hot" : {
...
}
}
}
```
The fields are as follows:
- node_count :: number of nodes with this tier/role
- index_count :: number of indices on this tier
- total_shard_count :: total number of shards for all nodes in this tier
- primary_shard_count :: number of primary shards for all nodes in this tier
- doc_count :: number of documents for all nodes in this tier
- total_size_bytes :: total number of bytes for all shards for all nodes in this tier
- primary_size_bytes :: number of bytes for all primary shards on all nodes in this tier
- primary_shard_size_avg_bytes :: average shard size for primary shard in this tier
- primary_shard_size_median_bytes :: median shard size for primary shard in this tier
- primary_shard_size_mad_bytes :: [median absolute deviation](https://en.wikipedia.org/wiki/Median_absolute_deviation) of shard size for primary shard in this tier
Relates to #60848
180 lines
4.9 KiB
Text
180 lines
4.9 KiB
Text
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[info-api]]
|
|
== Info API
|
|
|
|
Provides general information about the installed {xpack} features.
|
|
|
|
[discrete]
|
|
[[info-api-request]]
|
|
=== {api-request-title}
|
|
|
|
`GET /_xpack`
|
|
|
|
[discrete]
|
|
[[info-api-desc]]
|
|
=== {api-description-title}
|
|
|
|
The information provided by this API includes:
|
|
|
|
* Build Information - including the build number and timestamp.
|
|
* License Information - basic information about the currently installed license.
|
|
* Features Information - The features that are currently enabled and available
|
|
under the current license.
|
|
|
|
[discrete]
|
|
[[info-api-path-params]]
|
|
=== {api-path-parms-title}
|
|
|
|
`categories`::
|
|
(Optional, list) A comma-separated list of the information categories to
|
|
include in the response. For example, `build,license,features`.
|
|
|
|
`human`::
|
|
(Optional, boolean) Defines whether additional human-readable information is
|
|
included in the response. In particular, it adds descriptions and a tag line.
|
|
The default value is `true`.
|
|
|
|
[discrete]
|
|
[[info-api-example]]
|
|
=== {api-examples-title}
|
|
|
|
The following example queries the info API:
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
GET /_xpack
|
|
------------------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
------------------------------------------------------------
|
|
{
|
|
"build" : {
|
|
"hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
|
|
"date" : "2015-04-07T13:34:42Z"
|
|
},
|
|
"license" : {
|
|
"uid" : "893361dc-9749-4997-93cb-xxx",
|
|
"type" : "trial",
|
|
"mode" : "trial",
|
|
"status" : "active",
|
|
"expiry_date_in_millis" : 1542665112332
|
|
},
|
|
"features" : {
|
|
"ccr" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"analytics" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"enrich" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"frozen_indices" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"graph" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"ilm" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"logstash" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"ml" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"monitoring" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"rollup": {
|
|
"available": true,
|
|
"enabled": true
|
|
},
|
|
"searchable_snapshots" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"security" : {
|
|
"available" : true,
|
|
"enabled" : false
|
|
},
|
|
"slm" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"spatial" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"eql" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"sql" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"transform" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"vectors" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"voting_only" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"watcher" : {
|
|
"available" : true,
|
|
"enabled" : true
|
|
},
|
|
"data_streams" : {
|
|
"available" : true,
|
|
"enabled" : true,
|
|
},
|
|
"data_tiers" : {
|
|
"available" : true,
|
|
"enabled" : true,
|
|
}
|
|
},
|
|
"tagline" : "You know, for X"
|
|
}
|
|
------------------------------------------------------------
|
|
// TESTRESPONSE[s/"hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",/"hash" : "$body.build.hash",/]
|
|
// TESTRESPONSE[s/"date" : "2015-04-07T13:34:42Z"/"date" : "$body.build.date"/]
|
|
// TESTRESPONSE[s/"uid" : "893361dc-9749-4997-93cb-xxx",/"uid": "$body.license.uid",/]
|
|
// TESTRESPONSE[s/"expiry_date_in_millis" : 1542665112332/"expiry_date_in_millis" : "$body.license.expiry_date_in_millis"/]
|
|
// TESTRESPONSE[s/"version" : "7.0.0-alpha1-SNAPSHOT",/"version": "$body.features.ml.native_code_info.version",/]
|
|
// TESTRESPONSE[s/"build_hash" : "99a07c016d5a73"/"build_hash": "$body.features.ml.native_code_info.build_hash"/]
|
|
// TESTRESPONSE[s/"eql" : \{[^\}]*\},/"eql": $body.$_path,/]
|
|
// eql is disabled by default on release builds and enabled everywhere else during the initial implementation phase until its release
|
|
// So much s/// but at least we test that the layout is close to matching....
|
|
|
|
The following example only returns the build and features information:
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
GET /_xpack?categories=build,features
|
|
------------------------------------------------------------
|
|
|
|
The following example removes the descriptions from the response:
|
|
|
|
[source,console]
|
|
------------------------------------------------------------
|
|
GET /_xpack?human=false
|
|
------------------------------------------------------------
|