Add Index Stats API #4892
Merged
Add Index Stats API #4892
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
requested review from
cwillum,
hdhalter,
Naarcha-AWS,
vagimeli,
ananzh,
seanneumann,
AMoo-Miki and
natebower
as code owners
kolchfa-aws
added
backport 1.3
|
@kolchfa-aws - Is there an issue associated with this or is this the one that is tied to a 2.10 feature? |
|
It's one of the missing APIs. |
4 tasks
Signed-off-by: Fanit Kolchina <[email protected]>
jed326
approved these changes
Aug 25, 2023
Naarcha-AWS
approved these changes
Aug 28, 2023
natebower
reviewed
Aug 28, 2023
There was a problem hiding this comment.
@kolchfa-aws Please see my comments and changes and let me know if you have any questions. Thanks!
| nav_order: 72 | ||
| --- | ||
|
|
||
| # Index stats |
There was a problem hiding this comment.
Should "Stats" be capitalized here?
There was a problem hiding this comment.
We don't capitalize API names in other pages. I'll keep as is for consistency and I'll put in an issue to change capitalization on all APIs.
_api-reference/index-apis/stats.md
Outdated
| :--- |:---- | ||
| `_all` | Return all statistics. | ||
| `completion` | Completion suggester statistics. | ||
| `docs` | Returns the number of documents and the number of deleted docs that have not yet been merged. Index refresh operations can affect this statistic. |
There was a problem hiding this comment.
"Returns the total number of documents and the number of deleted documents..."?
_api-reference/index-apis/stats.md
Outdated
| `refresh` | Refresh statistics. | ||
| `request_cache` | Shard request cache statistics. | ||
| `search` | Search statistics, including suggest operation statistics. Search operations can be associated with one or more groups. You can include statistics for custom groups by providing a `groups` parameter, which accepts a comma-separated list of group names. To return statistics for all groups, use `_all`. | ||
| `segments` | Statistics about memory use of all open segments. If the `include_segment_file_sizes parameter` is `true`, this metric includes the aggregated disk usage of each Lucene index file. |
There was a problem hiding this comment.
Is "parameter" supposed to be inside the code font?
_api-reference/index-apis/stats.md
Outdated
| `fielddata_fields` | String | A comma-separated list or wildcard expression specifying fields to include in field-level `fielddata` statistics. | ||
| `forbid_closed_indices` | Boolean | Specifies not to collect statistics for closed indexes. Default is `true`. | ||
| `groups` | String | A comma-separated list of search groups to include in the `search` statistics. | ||
| `level` | String | Specifies the level to aggregate statistics. Valid values are: <br> - `cluster`: Cluster-level statistics, `indices`: Index-level statistics <br> - `shards`: Shard-level statistics. <br> Default is `indices`. |
There was a problem hiding this comment.
"the level used to aggregate"? Also, should indices be its own bullet point? And they should all end with a period.
_api-reference/index-apis/stats.md
Outdated
|
|
||
| Parameter | Data type | Description | ||
| :--- | :--- | :--- | ||
| `expand_wildcards` | String | Specifies the type of indexes to which wildcard expressions can expand. Supports comma-separated values. Valid values are: <br> - `all`: Expand to all open and closed indexes, including hidden indexes <br> `open`: Expand to open indexes <br> - `closed`: Expand to closed indexes <br> - `hidden`: Include hidden indexes when expanding. Must be combined with `open`, `closed`, or both <br> - `none`: Do not accept wildcard expressions <br> Default is `open`. |
There was a problem hiding this comment.
Let's put periods at the end of each L2 bullet.
|
|
||
| By default, the returned statistics are aggregated in the `primaries` and `total` aggregations. The `primaries` aggregation contains statistics for the primary shards. The `total` aggregation contains statistics for both primary and replica shards. | ||
|
|
||
| <details closed markdown="block"> |
There was a problem hiding this comment.
Should this be introduced by a brief sentence ending in a colon?
There was a problem hiding this comment.
In our template, we don't have an introductory sentence. I'll add one here though because it has more info.
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
kolchfa-aws
commented
Aug 28, 2023
Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 871f8ab) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit 871f8ab) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
kolchfa-aws
pushed a commit
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API * Reword for clarity * Apply suggestions from code review * Update _api-reference/index-apis/stats.md * Implemented editorial comments * Implement editorial comments --------- (cherry picked from commit 871f8ab) Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Nathan Bower <[email protected]>
kolchfa-aws
pushed a commit
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API * Reword for clarity * Apply suggestions from code review * Update _api-reference/index-apis/stats.md * Implemented editorial comments * Implement editorial comments --------- (cherry picked from commit 871f8ab) Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Nathan Bower <[email protected]>
sheltie-fusafusa
pushed a commit
to sheltie-fusafusa/documentation-website
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: sheltie <[email protected]>
sheltie-fusafusa
pushed a commit
to sheltie-fusafusa/documentation-website
that referenced
this pull request
Aug 28, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: sheltie <[email protected]>
harshavamsi
pushed a commit
to harshavamsi/documentation-website
that referenced
this pull request
Oct 31, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
vagimeli
pushed a commit
that referenced
this pull request
Dec 21, 2023
* Add Index Stats API Signed-off-by: Fanit Kolchina <[email protected]> * Reword for clarity Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Update _api-reference/index-apis/stats.md Signed-off-by: kolchfa-aws <[email protected]> * Implemented editorial comments Signed-off-by: Fanit Kolchina <[email protected]> * Implement editorial comments Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Index Stats API
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.