Skip to content

Commit af5835f

Browse files
hrithikshuklaHrithik Shukla
hrithikshukla
and
Hrithik Shukla
authored
Fix how bytes are displayed on _cat/recovery (opensearch-project#17598)
* Fix how bytes are displayed on _cat/recovery Signed-off-by: Hrithik Shukla <[email protected]> * Fix tests Signed-off-by: Hrithik Shukla <[email protected]> * Update changelog Signed-off-by: Hrithik Shukla <[email protected]> --------- Signed-off-by: Hrithik Shukla <[email protected]> Co-authored-by: Hrithik Shukla <[email protected]>
1 parent 73669fe commit af5835f

File tree

4 files changed

+22
-16
lines changed

4 files changed

+22
-16
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
2121
### Removed
2222

2323
### Fixed
24+
- Fix bytes parameter on `_cat/recovery` ([#17598](https://github.com/opensearch-project/OpenSearch/pull/17598))
2425

2526
### Security
2627

‎rest-api-spec/src/main/resources/rest-api-spec/test/cat.recovery/10_basic.yml

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
---
22
"Test cat recovery output":
3+
- skip:
4+
version: " - 2.99.99"
5+
reason: Output format changed in 3.0
36

47
- do:
58
cat.recovery: {}
@@ -35,10 +38,10 @@
3538
\d+ \s+ # files_recovered
3639
\d+\.\d+% \s+ # files_percent
3740
\d+ \s+ # files_total
38-
\d+ \s+ # bytes
39-
\d+ \s+ # bytes_recovered
41+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes
42+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes_recovered
4043
\d+\.\d+% \s+ # bytes_percent
41-
\d+ \s+ # bytes_total
44+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes_total
4245
-?\d+ \s+ # translog_ops
4346
\d+ \s+ # translog_ops_recovered
4447
-?\d+\.\d+% # translog_ops_percent
@@ -56,7 +59,7 @@
5659
(
5760
\d \s+ # shard
5861
((\S+\s?){1,10})\s+ # source_node
59-
\d+ # bytes
62+
(\d+|\d+[.]\d+)(kb|b) # bytes
6063
\n
6164
)+
6265
$/
@@ -71,16 +74,16 @@
7174
(
7275
\d \s+ # shard
7376
((\S+\s?){1,10})\s+ # target_node
74-
\d+ # bytes
77+
(\d+|\d+[.]\d+)(kb|b) # bytes
7578
\n
7679
)+
7780
$/
7881
7982
---
8083
"Test cat recovery output for closed index":
8184
- skip:
82-
version: " - 7.1.99"
83-
reason: closed indices are replicated starting version 7.2.0
85+
version: " - 2.99.99"
86+
reason: Output format changed in 3.0
8487

8588
- do:
8689
indices.create:
@@ -122,10 +125,10 @@
122125
\d+ \s+ # files_recovered
123126
\d+\.\d+% \s+ # files_percent
124127
\d+ \s+ # files_total
125-
\d+ \s+ # bytes
126-
\d+ \s+ # bytes_recovered
128+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes
129+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes_recovered
127130
\d+\.\d+% \s+ # bytes_percent
128-
\d+ \s+ # bytes_total
131+
(\d+|\d+[.]\d+)(kb|b) \s+ # bytes_total
129132
0 \s+ # translog_ops (always 0 for closed indices)
130133
0 \s+ # translog_ops_recovered (always 0 for closed indices)
131134
100\.0% # translog_ops_percent (always 100.0% for closed indices)

‎server/src/main/java/org/opensearch/rest/action/cat/RestCatRecoveryAction.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import org.opensearch.common.unit.TimeValue;
4343
import org.opensearch.common.xcontent.XContentOpenSearchExtension;
4444
import org.opensearch.core.common.Strings;
45+
import org.opensearch.core.common.unit.ByteSizeValue;
4546
import org.opensearch.indices.recovery.RecoveryState;
4647
import org.opensearch.rest.RestRequest;
4748
import org.opensearch.rest.RestResponse;
@@ -196,10 +197,10 @@ public int compare(RecoveryState o1, RecoveryState o2) {
196197
t.addCell(state.getIndex().recoveredFileCount());
197198
t.addCell(String.format(Locale.ROOT, "%1.1f%%", state.getIndex().recoveredFilesPercent()));
198199
t.addCell(state.getIndex().totalFileCount());
199-
t.addCell(state.getIndex().totalRecoverBytes());
200-
t.addCell(state.getIndex().recoveredBytes());
200+
t.addCell(new ByteSizeValue(state.getIndex().totalRecoverBytes()));
201+
t.addCell(new ByteSizeValue(state.getIndex().recoveredBytes()));
201202
t.addCell(String.format(Locale.ROOT, "%1.1f%%", state.getIndex().recoveredBytesPercent()));
202-
t.addCell(state.getIndex().totalBytes());
203+
t.addCell(new ByteSizeValue(state.getIndex().totalBytes()));
203204
t.addCell(state.getTranslog().totalOperations());
204205
t.addCell(state.getTranslog().recoveredOperations());
205206
t.addCell(String.format(Locale.ROOT, "%1.1f%%", state.getTranslog().recoveredPercent()));

‎server/src/test/java/org/opensearch/rest/action/cat/RestRecoveryActionTests.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import org.opensearch.common.unit.TimeValue;
4343
import org.opensearch.common.xcontent.XContentOpenSearchExtension;
4444
import org.opensearch.core.action.support.DefaultShardOperationFailedException;
45+
import org.opensearch.core.common.unit.ByteSizeValue;
4546
import org.opensearch.core.index.Index;
4647
import org.opensearch.core.index.shard.ShardId;
4748
import org.opensearch.indices.recovery.RecoveryState;
@@ -186,10 +187,10 @@ public void testRestRecoveryAction() {
186187
state.getIndex().recoveredFileCount(),
187188
percent(state.getIndex().recoveredFilesPercent()),
188189
state.getIndex().totalFileCount(),
189-
state.getIndex().totalRecoverBytes(),
190-
state.getIndex().recoveredBytes(),
190+
new ByteSizeValue(state.getIndex().totalRecoverBytes()),
191+
new ByteSizeValue(state.getIndex().recoveredBytes()),
191192
percent(state.getIndex().recoveredBytesPercent()),
192-
state.getIndex().totalBytes(),
193+
new ByteSizeValue(state.getIndex().totalBytes()),
193194
state.getTranslog().totalOperations(),
194195
state.getTranslog().recoveredOperations(),
195196
percent(state.getTranslog().recoveredPercent())

0 commit comments

Comments
 (0)