Improved cat help description #14771

landon-lengyel · 2024-07-16T15:26:24Z

Description

The _cat API's help returns (in part) the following:
Header | Description
memory.total | total used memory
pri.memory.total | total user memory

The word 'user' is almost certainly a typo. However, I also strongly suspect that this is total used memory for primary shards and that should be explained more clearly.

Related Issues

Check List

Functionality includes testing.
API changes companion pull request created, if applicable.
Public documentation issue/PR created, if applicable.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Landon Lengyel [email protected]

github-actions · 2024-07-16T15:44:45Z

❌ Gradle check result for b66562a: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

landon-lengyel · 2024-07-16T18:24:59Z

The Gradle failure doesn't appear to be related to my change.
Let me know if I've submitted this in the wrong way or something.

kotwanikunal · 2024-07-17T17:04:10Z

Thanks for your contribution @landon-lengyel! Let me take care of the workflows.

kotwanikunal · 2024-07-17T17:05:20Z

server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java

@@ -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");


@reta Does this seem accurate to you?

@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*

kotwanikunal · 2024-07-17T17:06:25Z

@landon-lengyel You missed signing off on your commit. Can you please follow the process here to correct it?
https://github.com/opensearch-project/OpenSearch/actions/runs/9959735699/job/27575301784?pr=14771

Signed-off-by: Landon Lengyel <[email protected]>

landon-lengyel · 2024-07-17T17:29:33Z

@landon-lengyel You missed signing off on your commit. Can you please follow the process here to correct it? https://github.com/opensearch-project/OpenSearch/actions/runs/9959735699/job/27575301784?pr=14771

Okay I think I amended that correctly.
Apologies, git can be a little confusing when you don't regularly use it.

server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java

github-actions · 2024-07-17T17:42:09Z

❌ Gradle check result for 782755c: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2024-07-17T17:43:47Z

❌ Gradle check result for 124c3fb: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

opensearch-trigger-bot · 2024-08-17T15:20:33Z

This PR is stalled because it has been open for 30 days with no activity.

opensearch-trigger-bot · 2024-10-27T15:21:55Z

This PR is stalled because it has been open for 30 days with no activity.

dblock · 2024-10-30T13:58:59Z

@landon-lengyel @sandeshkr419 @reta let's finish this?

sandeshkr419 · 2024-11-26T19:21:15Z

@landon-lengyel Did you get a chance to check out the comments?

…sAction.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Landon Lengyel <[email protected]>

landon-lengyel · 2024-12-02T21:25:29Z

@sandeshkr419 LGTM. I approved the changes on this PR from @reta - thank you for adding those.

Is there anything else I can do for this PR?

reta · 2024-12-02T21:39:51Z

@sandeshkr419 LGTM. I approved the changes on this PR from @reta - thank you for adding those.

Thanks @landon-lengyel , so if you look on any other column out there, most of them have pri.* / total splits, for example:

       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("warmer.total", "sibling:pri;alias:wto,warmerTotal;default:false;text-align:right;desc:total warmer ops");
table.addCell("pri.warmer.total", "default:false;text-align:right;desc:total warmer ops");

(and many others). So if we want to accurately reflect the primary / primary + replicas, we should update all column descriptions, not only memory column. Does it make sense?

Thank you

reta · 2024-12-02T21:40:38Z

DCO check needs fixing sadly

sandeshkr419 · 2024-12-02T22:13:09Z

@landon-lengyel Re-iterating on what I mentioned in my comment and what @reta also seconded in his comment, it only makes sense to fix the typo user/used and not add total/primary details to keep it consistent with other descriptions already in place.

If required, a small line clarifying this on top of the help section might be a value addition instead of making this change at each row to keep the individual rows' description concise, and not at all for a single row (which brings up inconsistency).

github-actions · 2024-12-02T23:28:14Z

❌ Gradle check result for 149eb3d:

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

Improved cat help description

b66562a

landon-lengyel requested review from anasalkouz, andrross, ashking94, Bukhtawar, CEHENKLE, dblock, dbwiddis, gbbafna, kotwanikunal, mch2, msfroh, nknize, owaiskazi19, reta, Rishikesh1159, sachinpkale, saratvemulapalli, shwetathareja, sohami and VachaShah as code owners July 16, 2024 15:26

kotwanikunal reviewed Jul 17, 2024

View reviewed changes

kotwanikunal added the skip-changelog label Jul 17, 2024

Landon Lengyel and others added 3 commits July 17, 2024 11:25

Improved cat help description

32f2dab

Signed-off-by: Landon Lengyel <[email protected]>

Merge branch 'main' of https://github.com/landon-lengyel/OpenSearch

124c3fb

Merge branch 'opensearch-project:main' into main

782755c

reta reviewed Jul 17, 2024

View reviewed changes

server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java Outdated Show resolved Hide resolved

reta reviewed Jul 17, 2024

View reviewed changes

server/src/main/java/org/opensearch/rest/action/cat/RestIndicesAction.java Outdated Show resolved Hide resolved

opensearch-trigger-bot bot added the stalled Issues that have stalled label Aug 17, 2024

opensearch-trigger-bot bot removed the stalled Issues that have stalled label Sep 19, 2024

opensearch-trigger-bot bot added the stalled Issues that have stalled label Oct 27, 2024

opensearch-trigger-bot bot removed the stalled Issues that have stalled label Oct 31, 2024

landon-lengyel and others added 2 commits December 2, 2024 14:23

Update server/src/main/java/org/opensearch/rest/action/cat/RestIndice…

0ce54be

…sAction.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Landon Lengyel <[email protected]>

Update server/src/main/java/org/opensearch/rest/action/cat/RestIndice…

149eb3d

…sAction.java Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Landon Lengyel <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved cat help description #14771

Improved cat help description #14771

landon-lengyel commented Jul 16, 2024

github-actions bot commented Jul 16, 2024

landon-lengyel commented Jul 16, 2024

kotwanikunal commented Jul 17, 2024

kotwanikunal Jul 17, 2024

reta Jul 17, 2024 •

edited

Loading

kotwanikunal commented Jul 17, 2024

landon-lengyel commented Jul 17, 2024

github-actions bot commented Jul 17, 2024

github-actions bot commented Jul 17, 2024

opensearch-trigger-bot bot commented Aug 17, 2024

opensearch-trigger-bot bot commented Oct 27, 2024

dblock commented Oct 30, 2024

sandeshkr419 commented Nov 26, 2024

landon-lengyel commented Dec 2, 2024

reta commented Dec 2, 2024

reta commented Dec 2, 2024

sandeshkr419 commented Dec 2, 2024

github-actions bot commented Dec 2, 2024

Improved cat help description #14771

Are you sure you want to change the base?

Improved cat help description #14771

Conversation

landon-lengyel commented Jul 16, 2024

Description

Related Issues

Check List

github-actions bot commented Jul 16, 2024

landon-lengyel commented Jul 16, 2024

kotwanikunal commented Jul 17, 2024

kotwanikunal Jul 17, 2024

Choose a reason for hiding this comment

reta Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

kotwanikunal commented Jul 17, 2024

landon-lengyel commented Jul 17, 2024

github-actions bot commented Jul 17, 2024

github-actions bot commented Jul 17, 2024

opensearch-trigger-bot bot commented Aug 17, 2024

opensearch-trigger-bot bot commented Oct 27, 2024

dblock commented Oct 30, 2024

sandeshkr419 commented Nov 26, 2024

landon-lengyel commented Dec 2, 2024

reta commented Dec 2, 2024

reta commented Dec 2, 2024

sandeshkr419 commented Dec 2, 2024

github-actions bot commented Dec 2, 2024

reta Jul 17, 2024 •

edited

Loading