Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for IO Based AdmissionController Stats #6755

Merged
merged 6 commits into from
Mar 26, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 19 additions & 4 deletions _api-reference/nodes-apis/nodes-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -731,7 +731,10 @@ Select the arrow to view the example response.
"nxLWtMdXQmWA-ZBVWU8nwA": {
"timestamp": 1698401391000,
"cpu_utilization_percent": "0.1",
"memory_utilization_percent": "3.9"
"memory_utilization_percent": "3.9",
"io_usage_stats": {
"max_io_utilization_percent": "99.6"
}
}
},
"admission_control": {
Expand All @@ -742,6 +745,14 @@ Select the arrow to view the example response.
"indexing": 1
}
}
},
"global_io_usage": {
"transport": {
"rejection_count": {
"search": 3,
"indexing": 1
}
}
}
}
}
Expand Down Expand Up @@ -1254,14 +1265,18 @@ Field | Field type | Description
timestamp | Integer | The last refresh time for the resource usage statistics, in milliseconds since the epoch.
cpu_utilization_percent | Float | Statistics for the average CPU usage of OpenSearch process within the time period configured in the `node.resource.tracker.global_cpu_usage.window_duration` setting.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
memory_utilization_percent | Float | The node JVM memory usage statistics within the time period configured in the `node.resource.tracker.global_jvmmp.window_duration` setting.
max_io_utilization_percent | Float | Statistics for the average IO usage of OpenSearch process within the time period configured in the `node.resource.tracker.global_io_usage.window_duration` setting(Linux only).
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

### `admission_control`

The `admission_control` object contains the rejection count of search and indexing requests based on resource consumption and has the following properties.

Field | Field type | Description
:--- | :--- | :---
admission_control.global_cpu_usage.transport.rejection_count.search | Integer | The total number of search rejections in the transport layer when the node CPU usage limit was breached. In this case, additional search requests are rejected until the system recovers.
admission_control.global_cpu_usage.transport.rejection_count.indexing | Integer | The total number of indexing rejections in the transport layer when the node CPU usage limit was breached. In this case, additional indexing requests are rejected until the system recovers.
:--- | :---------- | :---
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
admission_control.global_cpu_usage.transport.rejection_count.search | Integer | The total number of search rejections in the transport layer when the node CPU usage limit was breached. In this case, additional search requests are rejected until the system recovers. The threshold limit is configured in the `admission_control.search.cpu_usage.limit` setting.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
admission_control.global_cpu_usage.transport.rejection_count.indexing | Integer | The total number of indexing rejections in the transport layer when the node CPU usage limit was breached. In this case, additional indexing requests are rejected until the system recovers. The threshold limit is configured in the `admission_control.indexing.cpu_usage.limit` setting.
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
admission_control.global_io_usage.transport.rejection_count.search | Integer | The total number of search rejections in the transport layer when the node IO usage limit was breached. In this case, additional search requests are rejected until the system recovers. The threshold limit is configured in the `admission_control.search.io_usage.limit` setting (Linux only).
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved
admission_control.global_io_usage.transport.rejection_count.indexing | Integer | The total number of indexing rejections in the transport layer when the node IO usage limit was breached. In this case, additional indexing requests are rejected until the system recovers. The threshold limit is configured in the `admission_control.indexing.io_usage.limit` setting (Linux only).
Naarcha-AWS marked this conversation as resolved.
Show resolved Hide resolved

## Required permissions

Expand Down
Loading