From 66fa0731308843081b733e020d1d40ac30ca2b8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 23 Aug 2023 15:25:13 +0200 Subject: [PATCH 1/8] [DOCS] Adds description to node APIs. --- .../reload_secure_settings/ReloadSecureSettingsRequest.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts index 4f57bf7e0e..1a44999d77 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts @@ -27,12 +27,18 @@ import { Duration } from '@_types/Time' */ export interface Request extends RequestBase { path_parts: { + /** + * The names of particular nodes in the cluster to target. + */ node_id?: NodeIds } query_parameters: { timeout?: Duration } body: { + /** + * The password for the Elasticsearch keystore. + */ secure_settings_password?: Password } } From 8cd5417d47bcb52bee63b3b0aec3e8ea981e1c7a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 13:17:01 +0200 Subject: [PATCH 2/8] [DOCS] Adds description to Node APIs. --- output/schema/schema.json | 353 +++++++-- specification/nodes/_types/Stats.ts | 669 ++++++++++++++++++ specification/nodes/info/NodesInfoRequest.ts | 1 + .../ReloadSecureSettingsRequest.ts | 6 + .../nodes/stats/NodesStatsRequest.ts | 6 + .../nodes/usage/NodesUsageRequest.ts | 11 + 6 files changed, 984 insertions(+), 62 deletions(-) diff --git a/output/schema/schema.json b/output/schema/schema.json index 0a474d54d5..d06995feb7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -12103,6 +12103,12 @@ "docId": "cluster-nodes-stats", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-stats.html", "name": "nodes.stats", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", "namespace": "nodes.stats" @@ -12172,6 +12178,12 @@ "docId": "cluster-nodes-usage", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-nodes-usage.html", "name": "nodes.usage", + "privileges": { + "cluster": [ + "monitor", + "manage" + ] + }, "request": { "name": "Request", "namespace": "nodes.usage" @@ -156366,6 +156378,7 @@ }, "properties": [ { + "description": "The exponentially weighted moving average queue size of search requests on the keyed node.", "name": "avg_queue_size", "required": false, "type": { @@ -156377,6 +156390,7 @@ } }, { + "description": "The exponentially weighted moving average response time of search requests on the keyed node.", "name": "avg_response_time", "required": false, "type": { @@ -156388,6 +156402,7 @@ } }, { + "description": "The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node.", "name": "avg_response_time_ns", "required": false, "type": { @@ -156399,6 +156414,7 @@ } }, { + "description": "The exponentially weighted moving average service time of search requests on the keyed node.", "name": "avg_service_time", "required": false, "type": { @@ -156410,6 +156426,7 @@ } }, { + "description": "The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node.", "name": "avg_service_time_ns", "required": false, "type": { @@ -156421,6 +156438,7 @@ } }, { + "description": "The number of outstanding search requests from the node these stats are for to the keyed node.", "name": "outgoing_searches", "required": false, "type": { @@ -156432,6 +156450,7 @@ } }, { + "description": "The rank of this node; used for shard selection when routing search requests.", "name": "rank", "required": false, "type": { @@ -156443,7 +156462,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L169-L177" + "specLocation": "nodes/_types/Stats.ts#L403-L432" }, { "kind": "interface", @@ -156453,6 +156472,7 @@ }, "properties": [ { + "description": "Estimated memory used for the operation.", "name": "estimated_size", "required": false, "type": { @@ -156464,6 +156484,7 @@ } }, { + "description": "Estimated memory used, in bytes, for the operation.", "name": "estimated_size_in_bytes", "required": false, "type": { @@ -156475,6 +156496,7 @@ } }, { + "description": "Memory limit for the circuit breaker.", "name": "limit_size", "required": false, "type": { @@ -156486,6 +156508,7 @@ } }, { + "description": "Memory limit, in bytes, for the circuit breaker.", "name": "limit_size_in_bytes", "required": false, "type": { @@ -156497,6 +156520,7 @@ } }, { + "description": "A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate.", "name": "overhead", "required": false, "type": { @@ -156508,6 +156532,7 @@ } }, { + "description": "Total number of times the circuit breaker has been triggered and prevented an out of memory error.", "name": "tripped", "required": false, "type": { @@ -156519,7 +156544,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L179-L186" + "specLocation": "nodes/_types/Stats.ts#L434-L459" }, { "kind": "interface", @@ -156529,6 +156554,7 @@ }, "properties": [ { + "description": "Contains statistics about cpuacct control group for the node.", "name": "cpuacct", "required": false, "type": { @@ -156540,6 +156566,7 @@ } }, { + "description": "Contains statistics about `cpu` control group for the node.", "name": "cpu", "required": false, "type": { @@ -156551,6 +156578,7 @@ } }, { + "description": "Contains statistics about the memory control group for the node.", "name": "memory", "required": false, "type": { @@ -156562,7 +156590,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L188-L192" + "specLocation": "nodes/_types/Stats.ts#L461-L474" }, { "kind": "interface", @@ -156572,6 +156600,7 @@ }, "properties": [ { + "description": "The `cpu` control group to which the Elasticsearch process belongs.", "name": "control_group", "required": false, "type": { @@ -156583,6 +156612,7 @@ } }, { + "description": "The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated.", "name": "cfs_period_micros", "required": false, "type": { @@ -156594,6 +156624,7 @@ } }, { + "description": "The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`.", "name": "cfs_quota_micros", "required": false, "type": { @@ -156605,6 +156636,7 @@ } }, { + "description": "Contains CPU statistics for the node.", "name": "stat", "required": false, "type": { @@ -156616,7 +156648,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L199-L204" + "specLocation": "nodes/_types/Stats.ts#L487-L504" }, { "kind": "interface", @@ -156626,6 +156658,7 @@ }, "properties": [ { + "description": "The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed.", "name": "number_of_elapsed_periods", "required": false, "type": { @@ -156637,6 +156670,7 @@ } }, { + "description": "The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled.", "name": "number_of_times_throttled", "required": false, "type": { @@ -156648,6 +156682,7 @@ } }, { + "description": "The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled.", "name": "time_throttled_nanos", "required": false, "type": { @@ -156668,7 +156703,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L206-L210" + "specLocation": "nodes/_types/Stats.ts#L506-L519" }, { "kind": "interface", @@ -156678,6 +156713,7 @@ }, "properties": [ { + "description": "The `memory` control group to which the Elasticsearch process belongs.", "name": "control_group", "required": false, "type": { @@ -156689,6 +156725,7 @@ } }, { + "description": "The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process.\nThis value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns.\nAny value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup.", "name": "limit_in_bytes", "required": false, "type": { @@ -156700,6 +156737,7 @@ } }, { + "description": "The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process.\nThis value is stored as a string for consistency with `limit_in_bytes`.", "name": "usage_in_bytes", "required": false, "type": { @@ -156711,7 +156749,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L212-L216" + "specLocation": "nodes/_types/Stats.ts#L521-L537" }, { "kind": "interface", @@ -156721,6 +156759,7 @@ }, "properties": [ { + "description": "Unique ID for the HTTP client.", "name": "id", "required": false, "type": { @@ -156732,6 +156771,7 @@ } }, { + "description": "Reported agent for the HTTP client.\nIf unavailable, this property is not included in the response.", "name": "agent", "required": false, "type": { @@ -156743,6 +156783,7 @@ } }, { + "description": "Local address for the HTTP connection.", "name": "local_address", "required": false, "type": { @@ -156754,6 +156795,7 @@ } }, { + "description": "Remote address for the HTTP connection.", "name": "remote_address", "required": false, "type": { @@ -156765,6 +156807,7 @@ } }, { + "description": "The URI of the client’s most recent request.", "name": "last_uri", "required": false, "type": { @@ -156776,6 +156819,7 @@ } }, { + "description": "Time at which the client opened the connection.", "name": "opened_time_millis", "required": false, "type": { @@ -156787,6 +156831,7 @@ } }, { + "description": "Time at which the client closed the connection if the connection is closed.", "name": "closed_time_millis", "required": false, "type": { @@ -156798,6 +156843,7 @@ } }, { + "description": "Time of the most recent request from this client.", "name": "last_request_time_millis", "required": false, "type": { @@ -156809,6 +156855,7 @@ } }, { + "description": "Number of requests from this client.", "name": "request_count", "required": false, "type": { @@ -156820,6 +156867,7 @@ } }, { + "description": "Cumulative size in bytes of all requests from this client.", "name": "request_size_bytes", "required": false, "type": { @@ -156831,6 +156879,7 @@ } }, { + "description": "Value from the client’s `x-opaque-id` HTTP header.\nIf unavailable, this property is not included in the response.", "name": "x_opaque_id", "required": false, "type": { @@ -156842,7 +156891,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L272-L284" + "specLocation": "nodes/_types/Stats.ts#L649-L696" }, { "kind": "interface", @@ -156866,7 +156915,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L90-L92" + "specLocation": "nodes/_types/Stats.ts#L221-L223" }, { "kind": "interface", @@ -156876,6 +156925,7 @@ }, "properties": [ { + "description": "Total number of cluster states in queue.", "name": "total", "required": false, "type": { @@ -156887,6 +156937,7 @@ } }, { + "description": "Number of pending cluster states in queue.", "name": "pending", "required": false, "type": { @@ -156898,6 +156949,7 @@ } }, { + "description": "Number of committed cluster states in queue.", "name": "committed", "required": false, "type": { @@ -156909,7 +156961,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L114-L118" + "specLocation": "nodes/_types/Stats.ts#L248-L261" }, { "kind": "interface", @@ -156919,6 +156971,7 @@ }, "properties": [ { + "description": "The number of cluster state update attempts that did not change the cluster state since the node started.", "name": "count", "required": true, "type": { @@ -156930,6 +156983,7 @@ } }, { + "description": "The cumulative amount of time spent computing no-op cluster state updates since the node started.", "name": "computation_time", "required": false, "type": { @@ -156941,6 +156995,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started.", "name": "computation_time_millis", "required": false, "type": { @@ -156961,6 +157016,7 @@ } }, { + "description": "The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", "name": "publication_time", "required": false, "type": { @@ -156972,6 +157028,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update.\nThis includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`.", "name": "publication_time_millis", "required": false, "type": { @@ -156992,6 +157049,7 @@ } }, { + "description": "The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", "name": "context_construction_time", "required": false, "type": { @@ -157003,6 +157061,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded.\nThis statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference.", "name": "context_construction_time_millis", "required": false, "type": { @@ -157023,6 +157082,7 @@ } }, { + "description": "The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", "name": "commit_time", "required": false, "type": { @@ -157034,6 +157094,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master.", "name": "commit_time_millis", "required": false, "type": { @@ -157054,6 +157115,7 @@ } }, { + "description": "The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", "name": "completion_time", "required": false, "type": { @@ -157065,6 +157127,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state.", "name": "completion_time_millis", "required": false, "type": { @@ -157085,6 +157148,7 @@ } }, { + "description": "The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started.", "name": "master_apply_time", "required": false, "type": { @@ -157096,6 +157160,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started.", "name": "master_apply_time_millis", "required": false, "type": { @@ -157116,6 +157181,7 @@ } }, { + "description": "The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started.", "name": "notification_time", "required": false, "type": { @@ -157127,6 +157193,7 @@ } }, { + "description": "The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started.", "name": "notification_time_millis", "required": false, "type": { @@ -157147,7 +157214,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L126-L142" + "specLocation": "nodes/_types/Stats.ts#L278-L343" }, { "kind": "interface", @@ -157201,7 +157268,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L397-L402" + "specLocation": "nodes/_types/Stats.ts#L997-L1002" }, { "kind": "interface", @@ -157337,7 +157404,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L218-L227" + "specLocation": "nodes/_types/Stats.ts#L539-L548" }, { "kind": "interface", @@ -157347,6 +157414,7 @@ }, "properties": [ { + "description": "The `cpuacct` control group to which the Elasticsearch process belongs.", "name": "control_group", "required": false, "type": { @@ -157358,6 +157426,7 @@ } }, { + "description": "The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process.", "name": "usage_nanos", "required": false, "type": { @@ -157378,7 +157447,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L194-L197" + "specLocation": "nodes/_types/Stats.ts#L476-L485" }, { "kind": "interface", @@ -157388,6 +157457,7 @@ }, "properties": [ { + "description": "Total amount of disk space available to this Java virtual machine on this file store.", "name": "available", "required": false, "type": { @@ -157399,6 +157469,7 @@ } }, { + "description": "Total number of bytes available to this Java virtual machine on this file store.", "name": "available_in_bytes", "required": false, "type": { @@ -157487,6 +157558,7 @@ } }, { + "description": "Total amount of unallocated disk space in the file store.", "name": "free", "required": false, "type": { @@ -157498,6 +157570,7 @@ } }, { + "description": "Total number of unallocated bytes in the file store.", "name": "free_in_bytes", "required": false, "type": { @@ -157509,6 +157582,7 @@ } }, { + "description": "Mount point of the file store (ex: /dev/sda2).", "name": "mount", "required": false, "type": { @@ -157520,6 +157594,7 @@ } }, { + "description": "Path to the file store.", "name": "path", "required": false, "type": { @@ -157531,6 +157606,7 @@ } }, { + "description": "Total size of the file store.", "name": "total", "required": false, "type": { @@ -157542,6 +157618,7 @@ } }, { + "description": "Total size of the file store in bytes.", "name": "total_in_bytes", "required": false, "type": { @@ -157553,6 +157630,7 @@ } }, { + "description": "Type of the file store (ex: ext4).", "name": "type", "required": false, "type": { @@ -157564,7 +157642,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L229-L246" + "specLocation": "nodes/_types/Stats.ts#L550-L594" }, { "kind": "interface", @@ -157574,6 +157652,7 @@ }, "properties": [ { + "description": "Contains statistics for the cluster state queue of the node.", "name": "cluster_state_queue", "required": false, "type": { @@ -157585,6 +157664,7 @@ } }, { + "description": "Contains statistics for the published cluster states of the node.", "name": "published_cluster_states", "required": false, "type": { @@ -157596,6 +157676,7 @@ } }, { + "description": "Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master.\nOmitted if the node is not master-eligible.\nEvery field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`.\nThe human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter.", "name": "cluster_state_update", "required": false, "type": { @@ -157640,7 +157721,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L82-L88" + "specLocation": "nodes/_types/Stats.ts#L201-L219" }, { "inherits": { @@ -157656,6 +157737,7 @@ }, "properties": [ { + "description": "Percentage of free memory.", "name": "free_percent", "required": false, "type": { @@ -157667,6 +157749,7 @@ } }, { + "description": "Percentage of used memory.", "name": "used_percent", "required": false, "type": { @@ -157678,7 +157761,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L261-L264" + "specLocation": "nodes/_types/Stats.ts#L622-L631" }, { "kind": "interface", @@ -157688,6 +157771,7 @@ }, "properties": [ { + "description": "List of all file stores.", "name": "data", "required": false, "type": { @@ -157702,6 +157786,7 @@ } }, { + "description": "Last time the file stores statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.", "name": "timestamp", "required": false, "type": { @@ -157713,6 +157798,7 @@ } }, { + "description": "Contains statistics for all file stores of the node.", "name": "total", "required": false, "type": { @@ -157724,6 +157810,7 @@ } }, { + "description": "Contains I/O statistics for the node.", "name": "io_stats", "required": false, "type": { @@ -157735,7 +157822,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L286-L291" + "specLocation": "nodes/_types/Stats.ts#L698-L716" }, { "kind": "interface", @@ -157745,6 +157832,7 @@ }, "properties": [ { + "description": "Total disk space available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.", "name": "available", "required": false, "type": { @@ -157756,6 +157844,7 @@ } }, { + "description": "Total number of bytes available to this Java virtual machine on all file stores.\nDepending on OS or process level restrictions, this might appear less than `free_in_bytes`.\nThis is the actual amount of free disk space the Elasticsearch node can utilise.", "name": "available_in_bytes", "required": false, "type": { @@ -157767,6 +157856,7 @@ } }, { + "description": "Total unallocated disk space in all file stores.", "name": "free", "required": false, "type": { @@ -157778,6 +157868,7 @@ } }, { + "description": "Total number of unallocated bytes in all file stores.", "name": "free_in_bytes", "required": false, "type": { @@ -157789,6 +157880,7 @@ } }, { + "description": "Total size of all file stores.", "name": "total", "required": false, "type": { @@ -157800,6 +157892,7 @@ } }, { + "description": "Total size of all file stores in bytes.", "name": "total_in_bytes", "required": false, "type": { @@ -157811,7 +157904,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L307-L314" + "specLocation": "nodes/_types/Stats.ts#L757-L786" }, { "kind": "interface", @@ -157821,6 +157914,7 @@ }, "properties": [ { + "description": "Contains statistics about JVM garbage collectors for the node.", "name": "collectors", "required": false, "type": { @@ -157843,7 +157937,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L363-L365" + "specLocation": "nodes/_types/Stats.ts#L923-L928" }, { "kind": "interface", @@ -157853,6 +157947,7 @@ }, "properties": [ { + "description": "Total number of JVM garbage collectors that collect objects.", "name": "collection_count", "required": false, "type": { @@ -157864,6 +157959,7 @@ } }, { + "description": "Total time spent by JVM collecting objects.", "name": "collection_time", "required": false, "type": { @@ -157875,6 +157971,7 @@ } }, { + "description": "Total time, in milliseconds, spent by JVM collecting objects.", "name": "collection_time_in_millis", "required": false, "type": { @@ -157886,7 +157983,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L367-L371" + "specLocation": "nodes/_types/Stats.ts#L930-L943" }, { "kind": "interface", @@ -157896,6 +157993,7 @@ }, "properties": [ { + "description": "Current number of open HTTP connections for the node.", "name": "current_open", "required": false, "type": { @@ -157907,6 +158005,7 @@ } }, { + "description": "Total number of HTTP connections opened for the node.", "name": "total_opened", "required": false, "type": { @@ -157918,6 +158017,7 @@ } }, { + "description": "Information on current and recently-closed HTTP client connections.\nClients that have been closed longer than the `http`.`client_stats`.`closed_channels`.`max_age` setting will not be represented here.", "name": "clients", "required": false, "type": { @@ -157932,7 +158032,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L266-L270" + "specLocation": "nodes/_types/Stats.ts#L633-L647" }, { "kind": "interface", @@ -157942,6 +158042,7 @@ }, "properties": [ { + "description": "Contains statistics for memory consumption from indexing load.", "name": "memory", "required": false, "type": { @@ -157953,7 +158054,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L55-L57" + "specLocation": "nodes/_types/Stats.ts#L116-L121" }, { "kind": "interface", @@ -157963,6 +158064,7 @@ }, "properties": [ { + "description": "Configured memory limit for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", "name": "limit", "required": false, "type": { @@ -157974,6 +158076,7 @@ } }, { + "description": "Configured memory limit, in bytes, for the indexing requests.\nReplica requests have an automatic limit that is 1.5x this value.", "name": "limit_in_bytes", "required": false, "type": { @@ -157985,6 +158088,7 @@ } }, { + "description": "Contains statistics for current indexing load.", "name": "current", "required": false, "type": { @@ -157996,6 +158100,7 @@ } }, { + "description": "Contains statistics for the cumulative indexing load since the node started.", "name": "total", "required": false, "type": { @@ -158007,7 +158112,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L59-L64" + "specLocation": "nodes/_types/Stats.ts#L123-L142" }, { "kind": "interface", @@ -158017,6 +158122,7 @@ }, "properties": [ { + "description": "Contains statistics about ingest pipelines for the node.", "name": "pipelines", "required": false, "type": { @@ -158039,6 +158145,7 @@ } }, { + "description": "Contains statistics about ingest operations for the node.", "name": "total", "required": false, "type": { @@ -158050,7 +158157,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L144-L147" + "specLocation": "nodes/_types/Stats.ts#L345-L354" }, { "kind": "interface", @@ -158060,6 +158167,7 @@ }, "properties": [ { + "description": "Total number of documents ingested during the lifetime of this node.", "name": "count", "required": false, "type": { @@ -158071,6 +158179,7 @@ } }, { + "description": "Total number of documents currently being ingested.", "name": "current", "required": false, "type": { @@ -158082,6 +158191,7 @@ } }, { + "description": "Total number of failed ingest operations during the lifetime of this node.", "name": "failed", "required": false, "type": { @@ -158093,6 +158203,7 @@ } }, { + "description": "Total number of ingest processors.", "name": "processors", "required": false, "type": { @@ -158118,6 +158229,7 @@ } }, { + "description": "Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node.", "name": "time_in_millis", "required": false, "type": { @@ -158138,7 +158250,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L149-L155" + "specLocation": "nodes/_types/Stats.ts#L356-L377" }, { "kind": "interface", @@ -158148,6 +158260,7 @@ }, "properties": [ { + "description": "The Linux device name.", "name": "device_name", "required": false, "type": { @@ -158159,6 +158272,7 @@ } }, { + "description": "The total number of read and write operations for the device completed since starting Elasticsearch.", "name": "operations", "required": false, "type": { @@ -158170,6 +158284,7 @@ } }, { + "description": "The total number of kilobytes read for the device since starting Elasticsearch.", "name": "read_kilobytes", "required": false, "type": { @@ -158181,6 +158296,7 @@ } }, { + "description": "The total number of read operations for the device completed since starting Elasticsearch.", "name": "read_operations", "required": false, "type": { @@ -158192,6 +158308,7 @@ } }, { + "description": "The total number of kilobytes written for the device since starting Elasticsearch.", "name": "write_kilobytes", "required": false, "type": { @@ -158203,6 +158320,7 @@ } }, { + "description": "The total number of write operations for the device completed since starting Elasticsearch.", "name": "write_operations", "required": false, "type": { @@ -158214,7 +158332,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L298-L305" + "specLocation": "nodes/_types/Stats.ts#L730-L755" }, { "kind": "interface", @@ -158224,6 +158342,7 @@ }, "properties": [ { + "description": "Array of disk metrics for each device that is backing an Elasticsearch data path.\nThese disk metrics are probed periodically and averages between the last probe and the current probe are computed.", "name": "devices", "required": false, "type": { @@ -158238,6 +158357,7 @@ } }, { + "description": "The sum of the disk metrics for all devices that back an Elasticsearch data path.", "name": "total", "required": false, "type": { @@ -158249,7 +158369,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L293-L296" + "specLocation": "nodes/_types/Stats.ts#L718-L728" }, { "kind": "interface", @@ -158259,6 +158379,7 @@ }, "properties": [ { + "description": "Contains statistics about JVM buffer pools for the node.", "name": "buffer_pools", "required": false, "type": { @@ -158281,6 +158402,7 @@ } }, { + "description": "Contains statistics about classes loaded by JVM for the node.", "name": "classes", "required": false, "type": { @@ -158292,6 +158414,7 @@ } }, { + "description": "Contains statistics about JVM garbage collectors for the node.", "name": "gc", "required": false, "type": { @@ -158303,6 +158426,7 @@ } }, { + "description": "Contains JVM memory usage statistics for the node.", "name": "mem", "required": false, "type": { @@ -158314,6 +158438,7 @@ } }, { + "description": "Contains statistics about JVM thread usage for the node.", "name": "threads", "required": false, "type": { @@ -158325,6 +158450,7 @@ } }, { + "description": "Last time JVM statistics were refreshed.", "name": "timestamp", "required": false, "type": { @@ -158336,6 +158462,7 @@ } }, { + "description": "Human-readable JVM uptime.\nOnly returned if the `human` query parameter is `true`.", "name": "uptime", "required": false, "type": { @@ -158347,6 +158474,7 @@ } }, { + "description": "JVM uptime in milliseconds.", "name": "uptime_in_millis", "required": false, "type": { @@ -158358,7 +158486,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L324-L333" + "specLocation": "nodes/_types/Stats.ts#L811-L845" }, { "kind": "interface", @@ -158368,6 +158496,7 @@ }, "properties": [ { + "description": "Number of classes currently loaded by JVM.", "name": "current_loaded_count", "required": false, "type": { @@ -158379,6 +158508,7 @@ } }, { + "description": "Total number of classes loaded since the JVM started.", "name": "total_loaded_count", "required": false, "type": { @@ -158390,6 +158520,7 @@ } }, { + "description": "Total number of classes unloaded since the JVM started.", "name": "total_unloaded_count", "required": false, "type": { @@ -158401,7 +158532,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L357-L361" + "specLocation": "nodes/_types/Stats.ts#L908-L921" }, { "kind": "interface", @@ -158411,6 +158542,7 @@ }, "properties": [ { + "description": "Memory, in bytes, currently in use by the heap.", "name": "heap_used_in_bytes", "required": false, "type": { @@ -158422,6 +158554,7 @@ } }, { + "description": "Percentage of memory currently in use by the heap.", "name": "heap_used_percent", "required": false, "type": { @@ -158433,6 +158566,7 @@ } }, { + "description": "Amount of memory, in bytes, available for use by the heap.", "name": "heap_committed_in_bytes", "required": false, "type": { @@ -158444,6 +158578,7 @@ } }, { + "description": "Maximum amount of memory, in bytes, available for use by the heap.", "name": "heap_max_in_bytes", "required": false, "type": { @@ -158455,6 +158590,7 @@ } }, { + "description": "Non-heap memory used, in bytes.", "name": "non_heap_used_in_bytes", "required": false, "type": { @@ -158466,6 +158602,7 @@ } }, { + "description": "Amount of non-heap memory available, in bytes.", "name": "non_heap_committed_in_bytes", "required": false, "type": { @@ -158477,6 +158614,7 @@ } }, { + "description": "Contains statistics about heap memory usage for the node.", "name": "pools", "required": false, "type": { @@ -158499,7 +158637,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L335-L343" + "specLocation": "nodes/_types/Stats.ts#L847-L876" }, { "kind": "interface", @@ -158509,6 +158647,7 @@ }, "properties": [ { + "description": "Number of active threads in use by JVM.", "name": "count", "required": false, "type": { @@ -158520,6 +158659,7 @@ } }, { + "description": "Highest number of threads used by JVM.", "name": "peak_count", "required": false, "type": { @@ -158531,7 +158671,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L352-L355" + "specLocation": "nodes/_types/Stats.ts#L897-L906" }, { "kind": "interface", @@ -158563,7 +158703,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L157-L160" + "specLocation": "nodes/_types/Stats.ts#L379-L382" }, { "kind": "interface", @@ -158573,6 +158713,7 @@ }, "properties": [ { + "description": "If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes.\nOtherwise it reports the same value as `total_in_bytes`.", "name": "adjusted_total_in_bytes", "required": false, "type": { @@ -158650,6 +158791,7 @@ } }, { + "description": "Total amount of physical memory in bytes.", "name": "total_in_bytes", "required": false, "type": { @@ -158661,6 +158803,7 @@ } }, { + "description": "Amount of free physical memory in bytes.", "name": "free_in_bytes", "required": false, "type": { @@ -158672,6 +158815,7 @@ } }, { + "description": "Amount of used physical memory in bytes.", "name": "used_in_bytes", "required": false, "type": { @@ -158683,7 +158827,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L248-L259" + "specLocation": "nodes/_types/Stats.ts#L596-L620" }, { "kind": "interface", @@ -158693,6 +158837,7 @@ }, "properties": [ { + "description": "Number of buffer pools.", "name": "count", "required": false, "type": { @@ -158704,6 +158849,7 @@ } }, { + "description": "Total capacity of buffer pools.", "name": "total_capacity", "required": false, "type": { @@ -158715,6 +158861,7 @@ } }, { + "description": "Total capacity of buffer pools in bytes.", "name": "total_capacity_in_bytes", "required": false, "type": { @@ -158726,6 +158873,7 @@ } }, { + "description": "Size of buffer pools.", "name": "used", "required": false, "type": { @@ -158737,6 +158885,7 @@ } }, { + "description": "Size of buffer pools in bytes.", "name": "used_in_bytes", "required": false, "type": { @@ -158748,7 +158897,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L316-L322" + "specLocation": "nodes/_types/Stats.ts#L788-L809" }, { "kind": "interface", @@ -158901,7 +159050,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L373-L379" + "specLocation": "nodes/_types/Stats.ts#L945-L951" }, { "kind": "interface", @@ -158911,6 +159060,7 @@ }, "properties": [ { + "description": "Memory, in bytes, used by the heap.", "name": "used_in_bytes", "required": false, "type": { @@ -158922,6 +159072,7 @@ } }, { + "description": "Maximum amount of memory, in bytes, available for use by the heap.", "name": "max_in_bytes", "required": false, "type": { @@ -158933,6 +159084,7 @@ } }, { + "description": "Largest amount of memory, in bytes, historically used by the heap.", "name": "peak_used_in_bytes", "required": false, "type": { @@ -158944,6 +159096,7 @@ } }, { + "description": "Largest amount of memory, in bytes, historically used by the heap.", "name": "peak_max_in_bytes", "required": false, "type": { @@ -158955,7 +159108,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L345-L350" + "specLocation": "nodes/_types/Stats.ts#L878-L895" }, { "kind": "interface", @@ -158965,6 +159118,7 @@ }, "properties": [ { + "description": "Memory consumed by indexing requests in the coordinating, primary, or replica stage.", "name": "all", "required": false, "type": { @@ -158976,6 +159130,7 @@ } }, { + "description": "Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage.", "name": "all_in_bytes", "required": false, "type": { @@ -158987,6 +159142,7 @@ } }, { + "description": "Memory consumed by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", "name": "combined_coordinating_and_primary", "required": false, "type": { @@ -158998,6 +159154,7 @@ } }, { + "description": "Memory consumed, in bytes, by indexing requests in the coordinating or primary stage.\nThis value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally.", "name": "combined_coordinating_and_primary_in_bytes", "required": false, "type": { @@ -159009,6 +159166,7 @@ } }, { + "description": "Memory consumed by indexing requests in the coordinating stage.", "name": "coordinating", "required": false, "type": { @@ -159020,6 +159178,7 @@ } }, { + "description": "Memory consumed, in bytes, by indexing requests in the coordinating stage.", "name": "coordinating_in_bytes", "required": false, "type": { @@ -159031,6 +159190,7 @@ } }, { + "description": "Memory consumed by indexing requests in the primary stage.", "name": "primary", "required": false, "type": { @@ -159042,6 +159202,7 @@ } }, { + "description": "Memory consumed, in bytes, by indexing requests in the primary stage.", "name": "primary_in_bytes", "required": false, "type": { @@ -159053,6 +159214,7 @@ } }, { + "description": "Memory consumed by indexing requests in the replica stage.", "name": "replica", "required": false, "type": { @@ -159064,6 +159226,7 @@ } }, { + "description": "Memory consumed, in bytes, by indexing requests in the replica stage.", "name": "replica_in_bytes", "required": false, "type": { @@ -159075,6 +159238,7 @@ } }, { + "description": "Number of indexing requests rejected in the coordinating stage.", "name": "coordinating_rejections", "required": false, "type": { @@ -159086,6 +159250,7 @@ } }, { + "description": "Number of indexing requests rejected in the primary stage.", "name": "primary_rejections", "required": false, "type": { @@ -159097,6 +159262,7 @@ } }, { + "description": "Number of indexing requests rejected in the replica stage.", "name": "replica_rejections", "required": false, "type": { @@ -159108,7 +159274,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L66-L80" + "specLocation": "nodes/_types/Stats.ts#L144-L199" }, { "kind": "interface", @@ -159118,6 +159284,7 @@ }, "properties": [ { + "description": "Contains CPU statistics for the node.", "name": "cpu", "required": false, "type": { @@ -159129,6 +159296,7 @@ } }, { + "description": "Contains virtual memory statistics for the node.", "name": "mem", "required": false, "type": { @@ -159140,6 +159308,7 @@ } }, { + "description": "Number of opened file descriptors associated with the current or `-1` if not supported.", "name": "open_file_descriptors", "required": false, "type": { @@ -159151,6 +159320,7 @@ } }, { + "description": "Maximum number of file descriptors allowed on the system, or `-1` if not supported.", "name": "max_file_descriptors", "required": false, "type": { @@ -159162,6 +159332,7 @@ } }, { + "description": "Last time the statistics were refreshed.\nRecorded in milliseconds since the Unix Epoch.", "name": "timestamp", "required": false, "type": { @@ -159173,7 +159344,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L381-L387" + "specLocation": "nodes/_types/Stats.ts#L953-L975" }, { "kind": "interface", @@ -159183,6 +159354,7 @@ }, "properties": [ { + "description": "Number of documents transformed by the processor.", "name": "count", "required": false, "type": { @@ -159194,6 +159366,7 @@ } }, { + "description": "Number of documents currently being transformed by the processor.", "name": "current", "required": false, "type": { @@ -159205,6 +159378,7 @@ } }, { + "description": "Number of failed operations for the processor.", "name": "failed", "required": false, "type": { @@ -159216,6 +159390,7 @@ } }, { + "description": "Time, in milliseconds, spent by the processor transforming documents.", "name": "time_in_millis", "required": false, "type": { @@ -159236,7 +159411,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L162-L167" + "specLocation": "nodes/_types/Stats.ts#L384-L401" }, { "kind": "interface", @@ -159246,6 +159421,7 @@ }, "properties": [ { + "description": "Number of published cluster states.", "name": "full_states", "required": false, "type": { @@ -159257,6 +159433,7 @@ } }, { + "description": "Number of incompatible differences between published cluster states.", "name": "incompatible_diffs", "required": false, "type": { @@ -159268,6 +159445,7 @@ } }, { + "description": "Number of compatible differences between published cluster states.", "name": "compatible_diffs", "required": false, "type": { @@ -159279,7 +159457,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L120-L124" + "specLocation": "nodes/_types/Stats.ts#L263-L276" }, { "kind": "interface", @@ -159342,7 +159520,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L94-L99" + "specLocation": "nodes/_types/Stats.ts#L225-L230" }, { "kind": "interface", @@ -159675,6 +159853,7 @@ }, "properties": [ { + "description": "Total number of times the script cache has evicted old data.", "name": "cache_evictions", "required": false, "type": { @@ -159686,6 +159865,7 @@ } }, { + "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", "name": "compilation_limit_triggered", "required": false, "type": { @@ -159697,6 +159877,7 @@ } }, { + "description": "Total number of inline script compilations performed by the node.", "name": "compilations", "required": false, "type": { @@ -159719,7 +159900,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L413-L418" + "specLocation": "nodes/_types/Stats.ts#L1031-L1045" }, { "kind": "interface", @@ -159729,6 +159910,7 @@ }, "properties": [ { + "description": "Total number of times the script cache has evicted old data.", "name": "cache_evictions", "required": false, "type": { @@ -159740,6 +159922,7 @@ } }, { + "description": "Total number of inline script compilations performed by the node.", "name": "compilations", "required": false, "type": { @@ -159751,6 +159934,7 @@ } }, { + "description": "Contains this recent history of script compilations.", "name": "compilations_history", "required": false, "type": { @@ -159773,6 +159957,7 @@ } }, { + "description": "Total number of times the script compilation circuit breaker has limited inline script compilations.", "name": "compilation_limit_triggered", "required": false, "type": { @@ -159798,7 +159983,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L389-L395" + "specLocation": "nodes/_types/Stats.ts#L977-L995" }, { "kind": "interface", @@ -159808,6 +159993,7 @@ }, "properties": [ { + "description": "Number of published cluster states.", "name": "full_states", "required": false, "type": { @@ -159830,7 +160016,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L101-L104" + "specLocation": "nodes/_types/Stats.ts#L232-L238" }, { "kind": "interface", @@ -159895,7 +160081,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L106-L112" + "specLocation": "nodes/_types/Stats.ts#L240-L246" }, { "kind": "interface", @@ -159905,6 +160091,7 @@ }, "properties": [ { + "description": "Statistics about adaptive replica selection.", "name": "adaptive_selection", "required": false, "type": { @@ -159927,6 +160114,7 @@ } }, { + "description": "Statistics about the field data circuit breaker.", "name": "breakers", "required": false, "type": { @@ -159949,6 +160137,7 @@ } }, { + "description": "File system information, data path, free disk space, read/write stats.", "name": "fs", "required": false, "type": { @@ -159960,6 +160149,7 @@ } }, { + "description": "Network host for the node, based on the network host setting.", "name": "host", "required": false, "type": { @@ -159971,6 +160161,7 @@ } }, { + "description": "HTTP connection information.", "name": "http", "required": false, "type": { @@ -159982,6 +160173,7 @@ } }, { + "description": "Statistics about ingest preprocessing.", "name": "ingest", "required": false, "type": { @@ -159993,6 +160185,7 @@ } }, { + "description": "IP address and port for the node.", "name": "ip", "required": false, "type": { @@ -160019,6 +160212,7 @@ } }, { + "description": "JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.", "name": "jvm", "required": false, "type": { @@ -160030,6 +160224,7 @@ } }, { + "description": "Human-readable identifier for the node.\nBased on the node name setting.", "name": "name", "required": false, "type": { @@ -160041,6 +160236,7 @@ } }, { + "description": "Operating system stats, load average, mem, swap.", "name": "os", "required": false, "type": { @@ -160052,6 +160248,7 @@ } }, { + "description": "Process statistics, memory consumption, cpu usage, open file descriptors.", "name": "process", "required": false, "type": { @@ -160063,6 +160260,7 @@ } }, { + "description": "Roles assigned to the node.", "name": "roles", "required": false, "type": { @@ -160074,6 +160272,7 @@ } }, { + "description": "Contains script statistics for the node.", "name": "script", "required": false, "type": { @@ -160122,6 +160321,7 @@ } }, { + "description": "Statistics about each thread pool, including current size, queue and rejected tasks.", "name": "thread_pool", "required": false, "type": { @@ -160155,6 +160355,7 @@ } }, { + "description": "Transport statistics about sent and received bytes in cluster communication.", "name": "transport", "required": false, "type": { @@ -160166,6 +160367,7 @@ } }, { + "description": "Host and port for the transport layer, used for internal communication between nodes in a cluster.", "name": "transport_address", "required": false, "type": { @@ -160177,6 +160379,7 @@ } }, { + "description": "Contains a list of attributes for the node.", "name": "attributes", "required": false, "type": { @@ -160199,6 +160402,7 @@ } }, { + "description": "Contains node discovery statistics for the node.", "name": "discovery", "required": false, "type": { @@ -160210,6 +160414,7 @@ } }, { + "description": "Contains indexing pressure statistics for the node.", "name": "indexing_pressure", "required": false, "type": { @@ -160221,6 +160426,7 @@ } }, { + "description": "Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes.", "name": "indices", "required": false, "type": { @@ -160232,7 +160438,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L30-L53" + "specLocation": "nodes/_types/Stats.ts#L30-L114" }, { "kind": "interface", @@ -160242,6 +160448,7 @@ }, "properties": [ { + "description": "Number of active threads in the thread pool.", "name": "active", "required": false, "type": { @@ -160253,6 +160460,7 @@ } }, { + "description": "Number of tasks completed by the thread pool executor.", "name": "completed", "required": false, "type": { @@ -160264,6 +160472,7 @@ } }, { + "description": "Highest number of active threads in the thread pool.", "name": "largest", "required": false, "type": { @@ -160275,6 +160484,7 @@ } }, { + "description": "Number of tasks in queue for the thread pool.", "name": "queue", "required": false, "type": { @@ -160286,6 +160496,7 @@ } }, { + "description": "Number of tasks rejected by the thread pool executor.", "name": "rejected", "required": false, "type": { @@ -160297,6 +160508,7 @@ } }, { + "description": "Number of threads in the thread pool.", "name": "threads", "required": false, "type": { @@ -160308,7 +160520,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L404-L411" + "specLocation": "nodes/_types/Stats.ts#L1004-L1029" }, { "kind": "interface", @@ -160318,6 +160530,7 @@ }, "properties": [ { + "description": "The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram.", "name": "inbound_handling_time_histogram", "required": false, "type": { @@ -160332,6 +160545,7 @@ } }, { + "description": "The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram.", "name": "outbound_handling_time_histogram", "required": false, "type": { @@ -160346,6 +160560,7 @@ } }, { + "description": "Total number of RX (receive) packets received by the node during internal cluster communication.", "name": "rx_count", "required": false, "type": { @@ -160357,6 +160572,7 @@ } }, { + "description": "Size of RX packets received by the node during internal cluster communication.", "name": "rx_size", "required": false, "type": { @@ -160368,6 +160584,7 @@ } }, { + "description": "Size, in bytes, of RX packets received by the node during internal cluster communication.", "name": "rx_size_in_bytes", "required": false, "type": { @@ -160379,6 +160596,7 @@ } }, { + "description": "Current number of inbound TCP connections used for internal communication between nodes.", "name": "server_open", "required": false, "type": { @@ -160390,6 +160608,7 @@ } }, { + "description": "Total number of TX (transmit) packets sent by the node during internal cluster communication.", "name": "tx_count", "required": false, "type": { @@ -160401,6 +160620,7 @@ } }, { + "description": "Size of TX packets sent by the node during internal cluster communication.", "name": "tx_size", "required": false, "type": { @@ -160412,6 +160632,7 @@ } }, { + "description": "Size, in bytes, of TX packets sent by the node during internal cluster communication.", "name": "tx_size_in_bytes", "required": false, "type": { @@ -160423,6 +160644,7 @@ } }, { + "description": "The cumulative number of outbound transport connections that this node has opened since it started.\nEach transport connection may comprise multiple TCP connections but is only counted once in this statistic.\nTransport connections are typically long-lived so this statistic should remain constant in a stable cluster.", "name": "total_outbound_connections", "required": false, "type": { @@ -160434,7 +160656,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L420-L431" + "specLocation": "nodes/_types/Stats.ts#L1047-L1090" }, { "kind": "interface", @@ -160444,6 +160666,7 @@ }, "properties": [ { + "description": "The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message.", "name": "count", "required": false, "type": { @@ -160455,6 +160678,7 @@ } }, { + "description": "The exclusive upper bound of the bucket in milliseconds.\nMay be omitted on the last bucket if this bucket has no upper bound.", "name": "lt_millis", "required": false, "type": { @@ -160466,6 +160690,7 @@ } }, { + "description": "The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound.", "name": "ge_millis", "required": false, "type": { @@ -160477,7 +160702,7 @@ } } ], - "specLocation": "nodes/_types/Stats.ts#L433-L437" + "specLocation": "nodes/_types/Stats.ts#L1092-L1106" }, { "attachedBehaviors": [ @@ -163790,7 +164015,7 @@ "body": { "kind": "no_body" }, - "description": "Returns information about nodes in the cluster.", + "description": "Returns cluster nodes information.", "inherits": { "type": { "name": "RequestBase", @@ -163869,7 +164094,7 @@ } } ], - "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L54" + "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L55" }, { "body": { @@ -163946,6 +164171,7 @@ "kind": "properties", "properties": [ { + "description": "The password for the Elasticsearch keystore.", "name": "secure_settings_password", "required": false, "type": { @@ -163958,7 +164184,7 @@ } ] }, - "description": "Reloads secure settings.", + "description": "Reloads the keystore on nodes in the cluster.", "inherits": { "type": { "name": "RequestBase", @@ -163972,7 +164198,7 @@ }, "path": [ { - "description": "A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes.", + "description": "The names of particular nodes in the cluster to target.", "name": "node_id", "required": false, "type": { @@ -163986,9 +164212,10 @@ ], "query": [ { - "description": "Explicit operation timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -163998,7 +164225,7 @@ } } ], - "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L38" + "specLocation": "nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L50" }, { "body": { @@ -164074,7 +164301,7 @@ "body": { "kind": "no_body" }, - "description": "Returns statistical information about nodes in the cluster.", + "description": "Returns cluster nodes statistics.", "inherits": { "type": { "name": "RequestBase", @@ -164240,9 +164467,10 @@ } }, { - "description": "If set to true segment stats will include stats for segments that are not currently loaded into memory", + "description": "If `true`, the response includes information from segments that are not loaded into memory.", "name": "include_unloaded_segments", "required": false, + "serverDefault": false, "type": { "kind": "instance_of", "type": { @@ -164252,7 +164480,7 @@ } } ], - "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L69" + "specLocation": "nodes/stats/NodesStatsRequest.ts#L24-L75" }, { "body": { @@ -164418,7 +164646,7 @@ "body": { "kind": "no_body" }, - "description": "Returns low-level information about REST actions usage on nodes.", + "description": "Returns information on the usage of features.", "inherits": { "type": { "name": "RequestBase", @@ -164444,7 +164672,7 @@ } }, { - "description": "Limit the information returned to the specified metrics", + "description": "Limits the information returned to the specific metrics.\nA comma-separated list of the following options: `_all`, `rest_actions`.", "name": "metric", "required": false, "type": { @@ -164458,9 +164686,10 @@ ], "query": [ { - "description": "Explicit operation timeout", + "description": "Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "name": "timeout", "required": false, + "serverDefault": "30s", "type": { "kind": "instance_of", "type": { @@ -164470,7 +164699,7 @@ } } ], - "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L38" + "specLocation": "nodes/usage/NodesUsageRequest.ts#L24-L49" }, { "body": { diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 195583d1ff..7c40a66d7b 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -28,60 +28,191 @@ import { Duration, DurationValue, UnitMillis, UnitNanos } from '@_types/Time' // The node stats response can be filtered both by `metric` and `filter_path`, // every property needs to be optional to be compliant with the API behavior. export class Stats { + /** + * Statistics about adaptive replica selection. + */ adaptive_selection?: Dictionary + /** + * Statistics about the field data circuit breaker. + */ breakers?: Dictionary + /** + * File system information, data path, free disk space, read/write stats. + */ fs?: FileSystem + /** + * Network host for the node, based on the network host setting. + */ host?: Host + /** + * HTTP connection information. + */ http?: Http + /** + * Statistics about ingest preprocessing. + */ ingest?: Ingest + /** + * IP address and port for the node. + */ ip?: Ip | Ip[] + /** + * JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes. + */ jvm?: Jvm + /** + * Human-readable identifier for the node. + * Based on the node name setting. + */ name?: Name + /** + * Operating system stats, load average, mem, swap. + */ os?: OperatingSystem + /** + * Process statistics, memory consumption, cpu usage, open file descriptors. + */ process?: Process + /** + * Roles assigned to the node. + */ roles?: NodeRoles + /** + * Contains script statistics for the node. + */ script?: Scripting script_cache?: Dictionary + /** + * Statistics about each thread pool, including current size, queue and rejected tasks. + */ thread_pool?: Dictionary timestamp?: long + /** + * Transport statistics about sent and received bytes in cluster communication. + */ transport?: Transport + /** + * Host and port for the transport layer, used for internal communication between nodes in a cluster. + */ transport_address?: TransportAddress + /** + * Contains a list of attributes for the node. + */ attributes?: Dictionary + /** + * Contains node discovery statistics for the node. + */ discovery?: Discovery + /** + * Contains indexing pressure statistics for the node. + */ indexing_pressure?: IndexingPressure + /** + * Indices stats about size, document count, indexing and deletion times, search times, field cache size, merges and flushes. + */ indices?: ShardStats } export class IndexingPressure { + /** + * Contains statistics for memory consumption from indexing load. + */ memory?: IndexingPressureMemory } export class IndexingPressureMemory { + /** + * Configured memory limit for the indexing requests. + * Replica requests have an automatic limit that is 1.5x this value. + */ limit?: ByteSize + /** + * Configured memory limit, in bytes, for the indexing requests. + * Replica requests have an automatic limit that is 1.5x this value. + */ limit_in_bytes?: long + /** + * Contains statistics for current indexing load. + */ current?: PressureMemory + /** + * Contains statistics for the cumulative indexing load since the node started. + */ total?: PressureMemory } export interface PressureMemory { + /** + * Memory consumed by indexing requests in the coordinating, primary, or replica stage. + */ all?: ByteSize + /** + * Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. + */ all_in_bytes?: long + /** + * Memory consumed by indexing requests in the coordinating or primary stage. + * This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + */ combined_coordinating_and_primary?: ByteSize + /** + * Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. + * This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. + */ combined_coordinating_and_primary_in_bytes?: long + /** + * Memory consumed by indexing requests in the coordinating stage. + */ coordinating?: ByteSize + /** + * Memory consumed, in bytes, by indexing requests in the coordinating stage. + */ coordinating_in_bytes?: long + /** + * Memory consumed by indexing requests in the primary stage. + */ primary?: ByteSize + /** + * Memory consumed, in bytes, by indexing requests in the primary stage. + */ primary_in_bytes?: long + /** + * Memory consumed by indexing requests in the replica stage. + */ replica?: ByteSize + /** + * Memory consumed, in bytes, by indexing requests in the replica stage. + */ replica_in_bytes?: long + /** + * Number of indexing requests rejected in the coordinating stage. + */ coordinating_rejections?: long + /** + * Number of indexing requests rejected in the primary stage. + */ primary_rejections?: long + /** + * Number of indexing requests rejected in the replica stage. + */ replica_rejections?: long } export class Discovery { + /** + * Contains statistics for the cluster state queue of the node. + */ cluster_state_queue?: ClusterStateQueue + /** + * Contains statistics for the published cluster states of the node. + */ published_cluster_states?: PublishedClusterStates + /** + * Contains low-level statistics about how long various activities took during cluster state updates while the node was the elected master. + * Omitted if the node is not master-eligible. + * Every field whose name ends in `_time` within this object is also represented as a raw number of milliseconds in a field whose name ends in `_time_millis`. + * The human-readable fields with a `_time` suffix are only returned if requested with the `?human=true` query parameter. + */ cluster_state_update?: Dictionary serialized_cluster_states?: SerializedClusterState cluster_applier_stats?: ClusterAppliedStats @@ -99,6 +230,9 @@ export class Recording { } export class SerializedClusterState { + /** + * Number of published cluster states. + */ full_states?: SerializedClusterStateDetail diffs?: SerializedClusterStateDetail } @@ -112,45 +246,133 @@ export class SerializedClusterStateDetail { } export class ClusterStateQueue { + /** + * Total number of cluster states in queue. + */ total?: long + /** + * Number of pending cluster states in queue. + */ pending?: long + /** + * Number of committed cluster states in queue. + */ committed?: long } export class PublishedClusterStates { + /** + * Number of published cluster states. + */ full_states?: long + /** + * Number of incompatible differences between published cluster states. + */ incompatible_diffs?: long + /** + * Number of compatible differences between published cluster states. + */ compatible_diffs?: long } export class ClusterStateUpdate { + /** + * The number of cluster state update attempts that did not change the cluster state since the node started. + */ count: long + /** + * The cumulative amount of time spent computing no-op cluster state updates since the node started. + */ computation_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent computing no-op cluster state updates since the node started. + */ computation_time_millis?: DurationValue + /** + * The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + * This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + */ publication_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + * This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. + */ publication_time_millis?: DurationValue + /** + * The cumulative amount of time spent constructing a publication context since the node started for publications that ultimately succeeded. + * This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + */ context_construction_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent constructing a publication context since the node started for publications that ultimately succeeded. + * This statistic includes the time spent computing the difference between the current and new cluster state preparing a serialized representation of this difference. + */ context_construction_time_millis?: DurationValue + /** + * The cumulative amount of time spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + */ commit_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to commit, which measures the time from the start of each publication until a majority of the master-eligible nodes have written the state to disk and confirmed the write to the elected master. + */ commit_time_millis?: DurationValue + /** + * The cumulative amount of time spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + */ completion_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent waiting for a successful cluster state update to complete, which measures the time from the start of each publication until all the other nodes have notified the elected master that they have applied the cluster state. + */ completion_time_millis?: DurationValue + /** + * The cumulative amount of time spent successfully applying cluster state updates on the elected master since the node started. + */ master_apply_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent successfully applying cluster state updates on the elected master since the node started. + */ master_apply_time_millis?: DurationValue + /** + * The cumulative amount of time spent notifying listeners of a no-op cluster state update since the node started. + */ notification_time?: Duration + /** + * The cumulative amount of time, in milliseconds, spent notifying listeners of a no-op cluster state update since the node started. + */ notification_time_millis?: DurationValue } export class Ingest { + /** + * Contains statistics about ingest pipelines for the node. + */ pipelines?: Dictionary + /** + * Contains statistics about ingest operations for the node. + */ total?: IngestTotal } export class IngestTotal { + /** + * Total number of documents ingested during the lifetime of this node. + */ count?: long + /** + * Total number of documents currently being ingested. + */ current?: long + /** + * Total number of failed ingest operations during the lifetime of this node. + */ failed?: long + /** + * Total number of ingest processors. + */ processors?: Dictionary[] + /** + * Total time, in milliseconds, spent preprocessing ingest documents during the lifetime of this node. + */ time_in_millis?: DurationValue } @@ -160,58 +382,157 @@ export class KeyedProcessor { } export class Processor { + /** + * Number of documents transformed by the processor. + */ count?: long + /** + * Number of documents currently being transformed by the processor. + */ current?: long + /** + * Number of failed operations for the processor. + */ failed?: long + /** + * Time, in milliseconds, spent by the processor transforming documents. + */ time_in_millis?: DurationValue } export class AdaptiveSelection { + /** + * The exponentially weighted moving average queue size of search requests on the keyed node. + */ avg_queue_size?: long + /** + * The exponentially weighted moving average response time of search requests on the keyed node. + */ avg_response_time?: Duration + /** + * The exponentially weighted moving average response time, in nanoseconds, of search requests on the keyed node. + */ avg_response_time_ns?: long + /** + * The exponentially weighted moving average service time of search requests on the keyed node. + */ avg_service_time?: Duration + /** + * The exponentially weighted moving average service time, in nanoseconds, of search requests on the keyed node. + */ avg_service_time_ns?: long + /** + * The number of outstanding search requests from the node these stats are for to the keyed node. + */ outgoing_searches?: long + /** + * The rank of this node; used for shard selection when routing search requests. + */ rank?: string } export class Breaker { + /** + * Estimated memory used for the operation. + */ estimated_size?: string + /** + * Estimated memory used, in bytes, for the operation. + */ estimated_size_in_bytes?: long + /** + * Memory limit for the circuit breaker. + */ limit_size?: string + /** + * Memory limit, in bytes, for the circuit breaker. + */ limit_size_in_bytes?: long + /** + * A constant that all estimates for the circuit breaker are multiplied with to calculate a final estimate. + */ overhead?: float + /** + * Total number of times the circuit breaker has been triggered and prevented an out of memory error. + */ tripped?: float } export class Cgroup { + /** + * Contains statistics about cpuacct control group for the node. + */ cpuacct?: CpuAcct + /** + * Contains statistics about `cpu` control group for the node. + */ cpu?: CgroupCpu + /** + * Contains statistics about the memory control group for the node. + */ memory?: CgroupMemory } export class CpuAcct { + /** + * The `cpuacct` control group to which the Elasticsearch process belongs. + */ control_group?: string + /** + * The total CPU time, in nanoseconds, consumed by all tasks in the same cgroup as the Elasticsearch process. + */ usage_nanos?: DurationValue } export class CgroupCpu { + /** + * The `cpu` control group to which the Elasticsearch process belongs. + */ control_group?: string + /** + * The period of time, in microseconds, for how regularly all tasks in the same cgroup as the Elasticsearch process should have their access to CPU resources reallocated. + */ cfs_period_micros?: integer + /** + * The total amount of time, in microseconds, for which all tasks in the same cgroup as the Elasticsearch process can run during one period `cfs_period_micros`. + */ cfs_quota_micros?: integer + /** + * Contains CPU statistics for the node. + */ stat?: CgroupCpuStat } export class CgroupCpuStat { + /** + * The number of reporting periods (as specified by `cfs_period_micros`) that have elapsed. + */ number_of_elapsed_periods?: long + /** + * The number of times all tasks in the same cgroup as the Elasticsearch process have been throttled. + */ number_of_times_throttled?: long + /** + * The total amount of time, in nanoseconds, for which all tasks in the same cgroup as the Elasticsearch process have been throttled. + */ time_throttled_nanos?: DurationValue } export class CgroupMemory { + /** + * The `memory` control group to which the Elasticsearch process belongs. + */ control_group?: string + /** + * The maximum amount of user memory (including file cache) allowed for all tasks in the same cgroup as the Elasticsearch process. + * This value can be too big to store in a `long`, so is returned as a string so that the value returned can exactly match what the underlying operating system interface returns. + * Any value that is too large to parse into a `long` almost certainly means no limit has been set for the cgroup. + */ limit_in_bytes?: string + /** + * The total current memory usage by processes in the cgroup, in bytes, by all tasks in the same cgroup as the Elasticsearch process. + * This value is stored as a string for consistency with `limit_in_bytes`. + */ usage_in_bytes?: string } @@ -227,7 +548,13 @@ export class Cpu { } export class DataPathStats { + /** + * Total amount of disk space available to this Java virtual machine on this file store. + */ available?: string + /** + * Total number of bytes available to this Java virtual machine on this file store. + */ available_in_bytes?: long disk_queue?: string disk_reads?: long @@ -236,16 +563,41 @@ export class DataPathStats { disk_writes?: long disk_write_size?: string disk_write_size_in_bytes?: long + /** + * Total amount of unallocated disk space in the file store. + */ free?: string + /** + * Total number of unallocated bytes in the file store. + */ free_in_bytes?: long + /** + * Mount point of the file store (ex: /dev/sda2). + */ mount?: string + /** + * Path to the file store. + */ path?: string + /** + * Total size of the file store. + */ total?: string + /** + * Total size of the file store in bytes. + */ total_in_bytes?: long + /** + * Type of the file store (ex: ext4). + */ type?: string } export class MemoryStats { + /** + * If the amount of physical memory has been overridden using the `es`.`total_memory_bytes` system property then this reports the overridden value in bytes. + * Otherwise it reports the same value as `total_in_bytes`. + */ adjusted_total_in_bytes?: long resident?: string resident_in_bytes?: long @@ -253,120 +605,340 @@ export class MemoryStats { share_in_bytes?: long total_virtual?: string total_virtual_in_bytes?: long + /** + * Total amount of physical memory in bytes. + */ total_in_bytes?: long + /** + * Amount of free physical memory in bytes. + */ free_in_bytes?: long + /** + * Amount of used physical memory in bytes. + */ used_in_bytes?: long } export class ExtendedMemoryStats extends MemoryStats { + /** + * Percentage of free memory. + */ free_percent?: integer + /** + * Percentage of used memory. + */ used_percent?: integer } export class Http { + /** + * Current number of open HTTP connections for the node. + */ current_open?: integer + /** + * Total number of HTTP connections opened for the node. + */ total_opened?: long + /** + * Information on current and recently-closed HTTP client connections. + * Clients that have been closed longer than the `http`.`client_stats`.`closed_channels`.`max_age` setting will not be represented here. + */ clients?: Client[] } export class Client { + /** + * Unique ID for the HTTP client. + */ id?: long + /** + * Reported agent for the HTTP client. + * If unavailable, this property is not included in the response. + */ agent?: string + /** + * Local address for the HTTP connection. + */ local_address?: string + /** + * Remote address for the HTTP connection. + */ remote_address?: string + /** + * The URI of the client’s most recent request. + */ last_uri?: string + /** + * Time at which the client opened the connection. + */ opened_time_millis?: long + /** + * Time at which the client closed the connection if the connection is closed. + */ closed_time_millis?: long + /** + * Time of the most recent request from this client. + */ last_request_time_millis?: long + /** + * Number of requests from this client. + */ request_count?: long + /** + * Cumulative size in bytes of all requests from this client. + */ request_size_bytes?: long + /** + * Value from the client’s `x-opaque-id` HTTP header. + * If unavailable, this property is not included in the response. + */ x_opaque_id?: string } export class FileSystem { + /** + * List of all file stores. + */ data?: DataPathStats[] + /** + * Last time the file stores statistics were refreshed. + * Recorded in milliseconds since the Unix Epoch. + */ timestamp?: long + /** + * Contains statistics for all file stores of the node. + */ total?: FileSystemTotal + /** + * Contains I/O statistics for the node. + */ io_stats?: IoStats } export class IoStats { + /** + * Array of disk metrics for each device that is backing an Elasticsearch data path. + * These disk metrics are probed periodically and averages between the last probe and the current probe are computed. + */ devices?: IoStatDevice[] + /** + * The sum of the disk metrics for all devices that back an Elasticsearch data path. + */ total?: IoStatDevice } export class IoStatDevice { + /** + * The Linux device name. + */ device_name?: string + /** + * The total number of read and write operations for the device completed since starting Elasticsearch. + */ operations?: long + /** + * The total number of kilobytes read for the device since starting Elasticsearch. + */ read_kilobytes?: long + /** + * The total number of read operations for the device completed since starting Elasticsearch. + */ read_operations?: long + /** + * The total number of kilobytes written for the device since starting Elasticsearch. + */ write_kilobytes?: long + /** + * The total number of write operations for the device completed since starting Elasticsearch. + */ write_operations?: long } export class FileSystemTotal { + /** + * Total disk space available to this Java virtual machine on all file stores. + * Depending on OS or process level restrictions, this might appear less than `free`. + * This is the actual amount of free disk space the Elasticsearch node can utilise. + */ available?: string + /** + * Total number of bytes available to this Java virtual machine on all file stores. + * Depending on OS or process level restrictions, this might appear less than `free_in_bytes`. + * This is the actual amount of free disk space the Elasticsearch node can utilise. + */ available_in_bytes?: long + /** + * Total unallocated disk space in all file stores. + */ free?: string + /** + * Total number of unallocated bytes in all file stores. + */ free_in_bytes?: long + /** + * Total size of all file stores. + */ total?: string + /** + * Total size of all file stores in bytes. + */ total_in_bytes?: long } export class NodeBufferPool { + /** + * Number of buffer pools. + */ count?: long + /** + * Total capacity of buffer pools. + */ total_capacity?: string + /** + * Total capacity of buffer pools in bytes. + */ total_capacity_in_bytes?: long + /** + * Size of buffer pools. + */ used?: string + /** + * Size of buffer pools in bytes. + */ used_in_bytes?: long } export class Jvm { + /** + * Contains statistics about JVM buffer pools for the node. + */ buffer_pools?: Dictionary + /** + * Contains statistics about classes loaded by JVM for the node. + */ classes?: JvmClasses + /** + * Contains statistics about JVM garbage collectors for the node. + */ gc?: GarbageCollector + /** + * Contains JVM memory usage statistics for the node. + */ mem?: JvmMemoryStats + /** + * Contains statistics about JVM thread usage for the node. + */ threads?: JvmThreads + /** + * Last time JVM statistics were refreshed. + */ timestamp?: long + /** + * Human-readable JVM uptime. + * Only returned if the `human` query parameter is `true`. + */ uptime?: string + /** + * JVM uptime in milliseconds. + */ uptime_in_millis?: long } export class JvmMemoryStats { + /** + * Memory, in bytes, currently in use by the heap. + */ heap_used_in_bytes?: long + /** + * Percentage of memory currently in use by the heap. + */ heap_used_percent?: long + /** + * Amount of memory, in bytes, available for use by the heap. + */ heap_committed_in_bytes?: long + /** + * Maximum amount of memory, in bytes, available for use by the heap. + */ heap_max_in_bytes?: long + /** + * Non-heap memory used, in bytes. + */ non_heap_used_in_bytes?: long + /** + * Amount of non-heap memory available, in bytes. + */ non_heap_committed_in_bytes?: long + /** + * Contains statistics about heap memory usage for the node. + */ pools?: Dictionary } export class Pool { + /** + * Memory, in bytes, used by the heap. + */ used_in_bytes?: long + /** + * Maximum amount of memory, in bytes, available for use by the heap. + */ max_in_bytes?: long + /** + * Largest amount of memory, in bytes, historically used by the heap. + */ peak_used_in_bytes?: long + /** + * Largest amount of memory, in bytes, historically used by the heap. + */ peak_max_in_bytes?: long } export class JvmThreads { + /** + * Number of active threads in use by JVM. + */ count?: long + /** + * Highest number of threads used by JVM. + */ peak_count?: long } export class JvmClasses { + /** + * Number of classes currently loaded by JVM. + */ current_loaded_count?: long + /** + * Total number of classes loaded since the JVM started. + */ total_loaded_count?: long + /** + * Total number of classes unloaded since the JVM started. + */ total_unloaded_count?: long } export class GarbageCollector { + /** + * Contains statistics about JVM garbage collectors for the node. + */ collectors?: Dictionary } export class GarbageCollectorTotal { + /** + * Total number of JVM garbage collectors that collect objects. + */ collection_count?: long + /** + * Total time spent by JVM collecting objects. + */ collection_time?: string + /** + * Total time, in milliseconds, spent by JVM collecting objects. + */ collection_time_in_millis?: long } @@ -379,17 +951,45 @@ export class OperatingSystem { } export class Process { + /** + * Contains CPU statistics for the node. + */ cpu?: Cpu + /** + * Contains virtual memory statistics for the node. + */ mem?: MemoryStats + /** + * Number of opened file descriptors associated with the current or `-1` if not supported. + */ open_file_descriptors?: integer + /** + * Maximum number of file descriptors allowed on the system, or `-1` if not supported. + */ max_file_descriptors?: integer + /** + * Last time the statistics were refreshed. + * Recorded in milliseconds since the Unix Epoch. + */ timestamp?: long } export class Scripting { + /** + * Total number of times the script cache has evicted old data. + */ cache_evictions?: long + /** + * Total number of inline script compilations performed by the node. + */ compilations?: long + /** + * Contains this recent history of script compilations. + */ compilations_history?: Dictionary + /** + * Total number of times the script compilation circuit breaker has limited inline script compilations. + */ compilation_limit_triggered?: long contexts?: Context[] } @@ -402,36 +1002,105 @@ export class Context { } export class ThreadCount { + /** + * Number of active threads in the thread pool. + */ active?: long + /** + * Number of tasks completed by the thread pool executor. + */ completed?: long + /** + * Highest number of active threads in the thread pool. + */ largest?: long + /** + * Number of tasks in queue for the thread pool. + */ queue?: long + /** + * Number of tasks rejected by the thread pool executor. + */ rejected?: long + /** + * Number of threads in the thread pool. + */ threads?: long } export class ScriptCache { + /** + * Total number of times the script cache has evicted old data. + */ cache_evictions?: long + /** + * Total number of times the script compilation circuit breaker has limited inline script compilations. + */ compilation_limit_triggered?: long + /** + * Total number of inline script compilations performed by the node. + */ compilations?: long context?: string } export class Transport { + /** + * The distribution of the time spent handling each inbound message on a transport thread, represented as a histogram. + */ inbound_handling_time_histogram?: TransportHistogram[] + /** + * The distribution of the time spent sending each outbound transport message on a transport thread, represented as a histogram. + */ outbound_handling_time_histogram?: TransportHistogram[] + /** + * Total number of RX (receive) packets received by the node during internal cluster communication. + */ rx_count?: long + /** + * Size of RX packets received by the node during internal cluster communication. + */ rx_size?: string + /** + * Size, in bytes, of RX packets received by the node during internal cluster communication. + */ rx_size_in_bytes?: long + /** + * Current number of inbound TCP connections used for internal communication between nodes. + */ server_open?: integer + /** + * Total number of TX (transmit) packets sent by the node during internal cluster communication. + */ tx_count?: long + /** + * Size of TX packets sent by the node during internal cluster communication. + */ tx_size?: string + /** + * Size, in bytes, of TX packets sent by the node during internal cluster communication. + */ tx_size_in_bytes?: long + /** + * The cumulative number of outbound transport connections that this node has opened since it started. + * Each transport connection may comprise multiple TCP connections but is only counted once in this statistic. + * Transport connections are typically long-lived so this statistic should remain constant in a stable cluster. + */ total_outbound_connections?: long } export class TransportHistogram { + /** + * The number of times a transport thread took a period of time within the bounds of this bucket to handle an inbound message. + */ count?: long + /** + * The exclusive upper bound of the bucket in milliseconds. + * May be omitted on the last bucket if this bucket has no upper bound. + */ lt_millis?: long + /** + * The inclusive lower bound of the bucket in milliseconds. May be omitted on the first bucket if this bucket has no lower bound. + */ ge_millis?: long } diff --git a/specification/nodes/info/NodesInfoRequest.ts b/specification/nodes/info/NodesInfoRequest.ts index f20734327b..bb1f8301d3 100644 --- a/specification/nodes/info/NodesInfoRequest.ts +++ b/specification/nodes/info/NodesInfoRequest.ts @@ -22,6 +22,7 @@ import { Metrics, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** + * Returns cluster nodes information. * @rest_spec_name nodes.info * @availability stack since=1.3.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts index 1a44999d77..4bb5b2864b 100644 --- a/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts +++ b/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts @@ -22,6 +22,7 @@ import { NodeIds, Password } from '@_types/common' import { Duration } from '@_types/Time' /** + * Reloads the keystore on nodes in the cluster. * @rest_spec_name nodes.reload_secure_settings * @availability stack since=6.5.0 stability=stable */ @@ -33,6 +34,11 @@ export interface Request extends RequestBase { node_id?: NodeIds } query_parameters: { + /** + * Period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ timeout?: Duration } body: { diff --git a/specification/nodes/stats/NodesStatsRequest.ts b/specification/nodes/stats/NodesStatsRequest.ts index a0c00bce02..766d3f695c 100644 --- a/specification/nodes/stats/NodesStatsRequest.ts +++ b/specification/nodes/stats/NodesStatsRequest.ts @@ -22,10 +22,12 @@ import { Fields, Level, Metrics, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** + * Returns cluster nodes statistics. * @rest_spec_name nodes.stats * @availability stack since=0.0.0 stability=stable * @availability serverless stability=stable visibility=private * @doc_id cluster-nodes-stats + * @cluster_privileges monitor,manage */ export interface Request extends RequestBase { path_parts: { @@ -64,6 +66,10 @@ export interface Request extends RequestBase { timeout?: Duration /** A comma-separated list of document types for the indexing index metric. */ types?: string[] + /** + * If `true`, the response includes information from segments that are not loaded into memory. + * @server_default false + */ include_unloaded_segments?: boolean } } diff --git a/specification/nodes/usage/NodesUsageRequest.ts b/specification/nodes/usage/NodesUsageRequest.ts index bb4970f502..e9dfdf1a87 100644 --- a/specification/nodes/usage/NodesUsageRequest.ts +++ b/specification/nodes/usage/NodesUsageRequest.ts @@ -22,17 +22,28 @@ import { Metrics, NodeIds } from '@_types/common' import { Duration } from '@_types/Time' /** + * Returns information on the usage of features. * @rest_spec_name nodes.usage * @availability stack since=6.0.0 stability=stable * @availability serverless stability=stable visibility=private * @doc_id cluster-nodes-usage + * @cluster_privileges monitor,manage */ export interface Request extends RequestBase { path_parts: { node_id?: NodeIds + /** + * Limits the information returned to the specific metrics. + * A comma-separated list of the following options: `_all`, `rest_actions`. + */ metric?: Metrics } query_parameters: { + /** + * Period to wait for a response. + * If no response is received before the timeout expires, the request fails and returns an error. + * @server_default 30s + */ timeout?: Duration } } From 9ebd1095138032d2ce0f49bfe31e259c089d478f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:53:27 +0200 Subject: [PATCH 3/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 7c40a66d7b..b5b25fa7ac 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -289,7 +289,7 @@ export class ClusterStateUpdate { */ computation_time_millis?: DurationValue /** - * The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + * The cumulative amount of time spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. * This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. */ publication_time?: Duration From 6aa9f1f5fb65dde57ad0fa3a555d89d72ad74c17 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:53:36 +0200 Subject: [PATCH 4/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index b5b25fa7ac..965d6ba145 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -294,7 +294,7 @@ export class ClusterStateUpdate { */ publication_time?: Duration /** - * The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (i.e. just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. + * The cumulative amount of time, in milliseconds, spent publishing cluster state updates which ultimately succeeded, which includes everything from the start of the publication (just after the computation of the new cluster state) until the publication has finished and the master node is ready to start processing the next state update. * This includes the time measured by `context_construction_time`, `commit_time`, `completion_time` and `master_apply_time`. */ publication_time_millis?: DurationValue From 26b191a09ccd7c5a0485ede6faee91f9f1feefe3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:53:50 +0200 Subject: [PATCH 5/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 965d6ba145..35b8bff6a2 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -422,7 +422,7 @@ export class AdaptiveSelection { */ avg_service_time_ns?: long /** - * The number of outstanding search requests from the node these stats are for to the keyed node. + * The number of outstanding search requests to the keyed node from the node these stats are for. */ outgoing_searches?: long /** From fba34344d0d49cf8a348b5fd0bedba12d10e8da6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:54:37 +0200 Subject: [PATCH 6/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 35b8bff6a2..72a9979a16 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -460,7 +460,7 @@ export class Breaker { export class Cgroup { /** - * Contains statistics about cpuacct control group for the node. + * Contains statistics about `cpuacct` control group for the node. */ cpuacct?: CpuAcct /** From 93c14aa3828048a33054cff7a0a275fa4715d4ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:54:44 +0200 Subject: [PATCH 7/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 72a9979a16..7912f41e74 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -572,7 +572,7 @@ export class DataPathStats { */ free_in_bytes?: long /** - * Mount point of the file store (ex: /dev/sda2). + * Mount point of the file store (for example: `/dev/sda2`). */ mount?: string /** From cd72772e009fab04bfcf3edd9a869977291f8673 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Fri, 25 Aug 2023 14:54:55 +0200 Subject: [PATCH 8/8] Update specification/nodes/_types/Stats.ts Co-authored-by: Abdon Pijpelink --- specification/nodes/_types/Stats.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts index 7912f41e74..fbdd0d649d 100644 --- a/specification/nodes/_types/Stats.ts +++ b/specification/nodes/_types/Stats.ts @@ -641,7 +641,7 @@ export class Http { total_opened?: long /** * Information on current and recently-closed HTTP client connections. - * Clients that have been closed longer than the `http`.`client_stats`.`closed_channels`.`max_age` setting will not be represented here. + * Clients that have been closed longer than the `http.client_stats.closed_channels.max_age` setting will not be represented here. */ clients?: Client[] }