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.

Sign up for GitHub

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

Improved cat help description #14771

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+2 −2
Open

Improved cat help description #14771

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b66562a
Improved cat help description
Jul 16, 2024
32f2dab
Improved cat help description
Jul 16, 2024
124c3fb
Merge branch 'main' of https://github.com/landon-lengyel/OpenSearch
Jul 17, 2024
782755c
Merge branch 'opensearch-project:main' into main
landon-lengyel Jul 17, 2024
0ce54be
Update server/src/main/java/org/opensearch/rest/action/cat/RestIndice…
landon-lengyel Dec 2, 2024
149eb3d
Update server/src/main/java/org/opensearch/rest/action/cat/RestIndice…
landon-lengyel Dec 2, 2024
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
4 changes: 2 additions & 2 deletions server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,8 +694,8 @@ protected Table getTableWithHeader(final RestRequest request) {
table.addCell("suggest.total", "sibling:pri;alias:suto,suggestTotal;default:false;text-align:right;desc:number of suggest ops");
table.addCell("pri.suggest.total", "default:false;text-align:right;desc:number of suggest ops");

table.addCell("memory.total", "sibling:pri;alias:tm,memoryTotal;default:false;text-align:right;desc:total used memory");
table.addCell("pri.memory.total", "default:false;text-align:right;desc:total user memory");
table.addCell("memory.total", "sibling:pri;alias:tm,memoryTotal;default:false;text-align:right;desc:total used memory of primaries & replicas");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reta Does this seem accurate to you?

Copy link
Collaborator

@reta reta Jul 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kotwanikunal I think the pri.* prefix generally reflects primary, so it looks accurate but not complete, we have many other columns which probably have to be documented in a similar fashion, not only *memory*

landon-lengyel marked this conversation as resolved.
Show resolved Hide resolved
table.addCell("pri.memory.total", "default:false;text-align:right;desc:total used memory of primary");
landon-lengyel marked this conversation as resolved.
Show resolved Hide resolved

table.addCell("search.throttled", "alias:sth;default:false;desc:indicates if the index is search throttled");

Expand Down
Loading