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

[DOC] _nodes/stats coordinator search stats documentation #6103

Merged
merged 15 commits into from
Jan 11, 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
83 changes: 67 additions & 16 deletions _api-reference/nodes-apis/nodes-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,39 @@
"point_in_time_current": 0,
"suggest_total": 0,
"suggest_time_in_millis": 0,
"suggest_current": 0
"suggest_current": 0,
"request" : {
"dfs_pre_query" : {

Check failure on line 191 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: fs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: fs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 191, "column": 15}}}, "severity": "ERROR"}
"time_in_millis" : 0,
"current" : 0,
"total" : 0
},
"query" : {
"time_in_millis" : 200,
"current" : 2,
"total" : 12
},
"fetch" : {
"time_in_millis" : 37,
"current" : 3,
"total" : 4
},
"dfs_query" : {
"time_in_millis" : 0,
"current" : 0,
"total" : 0
},
"expand" : {
"time_in_millis" : 9,
"current" : 1,
"total" : 0
},
"can_match" : {
"time_in_millis" : 0,
"current" : 0,
"total" : 0
}
}
},
"merges" : {
"current" : 0,
Expand Down Expand Up @@ -762,22 +794,41 @@
get.missing_time_in_millis | Integer | The total time for all failed get operations, in milliseconds.
get.current | Integer | The number of get operations that are currently running.
search | Object | Statistics about the search operations for the node.
search.point_in_time_total | Integer | The total number of Point in Time contexts that have been created (completed and active) since the node last restarted.
search.point_in_time_time_in_millis | Integer | The amount of time that Point in Time contexts have been held open since the node last restarted, in milliseconds.
search.point_in_time_current | Integer | The number of Point in Time contexts currently open.
search.open_contexts | Integer | The number of open search contexts.
search.query_total | Integer | The total number of query operations.
search.query_time_in_millis | Integer | The total time for all query operations, in milliseconds.
search.query_current | Integer | The number of query operations that are currently running.
search.fetch_total | Integer | The total number of fetch operations.
search.fetch_time_in_millis | Integer | The total time for all fetch operations, in milliseconds.
search.fetch_current | Integer | The number of fetch operations that are currently running.
search.scroll_total | Integer | The total number of scroll operations.
search.scroll_time_in_millis | Integer | The total time for all scroll operations, in milliseconds.
search.scroll_current | Integer | The number of scroll operations that are currently running.
search.suggest_total | Integer | The total number of suggest operations.
search.suggest_time_in_millis | Integer | The total time for all suggest operations, in milliseconds.
search.suggest_current | Integer | The number of suggest operations that are currently running.
search.query_total | Integer | The total number of shard query operations.
search.query_time_in_millis | Integer | The total time for all shard query operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.query_current | Integer | The number of shard query operations that are currently running.
search.fetch_total | Integer | The total number of shard fetch operations.
search.fetch_time_in_millis | Integer | The total time for all shard fetch operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.fetch_current | Integer | The number of shard fetch operations that are currently running.
search.scroll_total | Integer | The total number of shard scroll operations.
search.scroll_time_in_millis | Integer | The total time for all shard scroll operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.scroll_current | Integer | The number of shard scroll operations that are currently running.
search.point_in_time_total | Integer | The total number of shard Point in Time contexts that have been created (completed and active) since the node last restarted.
search.point_in_time_time_in_millis | Integer | The amount of time that shard Point in Time contexts have been held open since the node last restarted, in milliseconds.
search.point_in_time_current | Integer | The number of shard Point in Time contexts currently open.
search.suggest_total | Integer | The total number of shard suggest operations.
search.suggest_time_in_millis | Integer | The total time for all shard suggest operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.suggest_current | Integer | The number of shard suggest operations that are currently running.
search.request | Object | Statistics about coordinator search operations for the node.
search.request.dfs_pre_query.time_in_millis | Integer | The total time for all coordinator dfs prequery operations, in milliseconds.

Check failure on line 814 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 814, "column": 92}}}, "severity": "ERROR"}

Check failure on line 814 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 814, "column": 96}}}, "severity": "ERROR"}
search.request.dfs_pre_query.current | Integer | The number of coordinator dfs prequery operations that are currently running.

Check failure on line 815 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 815, "column": 76}}}, "severity": "ERROR"}

Check failure on line 815 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 815, "column": 80}}}, "severity": "ERROR"}
search.request.dfs_pre_query.total | Integer | The total number of coordinator dfs prequery operations.

Check failure on line 816 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 816, "column": 80}}}, "severity": "ERROR"}

Check failure on line 816 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 816, "column": 84}}}, "severity": "ERROR"}
search.request.query.time_in_millis | Integer | The total time for all coordinator query operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.request.query.current | Integer | The number of coordinator query operations that are currently running.
search.request.query.total | Integer | The total number of coordinator query operations.
search.request.fetch.time_in_millis | Integer | The total time for all coordinator fetch operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.request.fetch.current | Integer | The number of coordinator fetch operations that are currently running.
search.request.fetch.total | Integer | The total number of coordinator fetch operations.
search.request.dfs_query.time_in_millis | Integer | The total time for all coordinator dfs prequery operations, in milliseconds.

Check failure on line 823 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: dfs. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 823, "column": 88}}}, "severity": "ERROR"}

Check failure on line 823 in _api-reference/nodes-apis/nodes-stats.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: prequery. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_api-reference/nodes-apis/nodes-stats.md", "range": {"start": {"line": 823, "column": 92}}}, "severity": "ERROR"}
search.request.dfs_query.current | Integer | The number of coordinator dfs prequery operations that are currently running.
search.request.dfs_query.total | Integer | The total number of coordinator dfs prequery operations.
search.request.expand.time_in_millis | Integer | The total time for all coordinator expand operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.request.expand.current | Integer | The number of coordinator expand operations that are currently running.
search.request.expand.total | Integer | The total number of coordinator expand operations.
search.request.can_match.time_in_millis | Integer | The total time for all coordinator match operations, in milliseconds.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
search.request.can_match.current | Integer | The number of coordinator match operations that are currently running.
search.request.can_match.total | Integer | The total number of coordinator match operations.
merges | Object | Statistics about merge operations for the node.
merges.current | Integer | The number of merge operations that are currently running.
merges.current_docs | Integer | The number of document merges that are currently running.
Expand Down
Loading