Skip to content

Commit 53be1fe

Browse files
committed
Cat: Add descs for rest of actions.
1 parent aec2b95 commit 53be1fe

File tree

7 files changed

+45
-45
lines changed

7 files changed

+45
-45
lines changed

src/main/java/org/elasticsearch/rest/action/cat/RestAllocationAction.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,12 @@ public void onFailure(Throwable e) {
112112
Table getTableWithHeader(final RestRequest request) {
113113
final Table table = new Table();
114114
table.startHeaders();
115-
table.addCell("shards", "text-align:right;");
116-
table.addCell("diskUsed", "text-align:right;");
117-
table.addCell("diskAvail", "text-align:right;");
118-
table.addCell("diskRatio", "text-align:right;");
119-
table.addCell("ip");
120-
table.addCell("node");
115+
table.addCell("shards", "text-align:right;desc:number of shards on node");
116+
table.addCell("diskUsed", "text-align:right;desc:disk used (total, not just ES)");
117+
table.addCell("diskAvail", "text-align:right;desc:disk available");
118+
table.addCell("diskRatio", "text-align:right;desc:percent disk used");
119+
table.addCell("ip", "desc:ip of node");
120+
table.addCell("node", "desc:name of node");
121121
table.endHeaders();
122122
return table;
123123
}

src/main/java/org/elasticsearch/rest/action/cat/RestHealthAction.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@ Table getTableWithHeader(final RestRequest request) {
8383
t = new Table();
8484
}
8585
t.startHeaders();
86-
t.addCell("cluster");
87-
t.addCell("status");
88-
t.addCell("nodeTotal", "text-align:right;");
89-
t.addCell("nodeData", "text-align:right;");
90-
t.addCell("shards", "text-align:right;");
91-
t.addCell("pri", "text-align:right;");
92-
t.addCell("relo", "text-align:right;");
93-
t.addCell("init", "text-align:right;");
94-
t.addCell("unassign", "text-align:right;");
86+
t.addCell("cluster", "desc:cluster name");
87+
t.addCell("status", "desc:health status");
88+
t.addCell("nodeTotal", "text-align:right;desc:total number of nodes");
89+
t.addCell("nodeData", "text-align:right;desc:number of nodes that can store data");
90+
t.addCell("shards", "text-align:right;desc:total number of shards");
91+
t.addCell("pri", "text-align:right;desc:number of primary shards");
92+
t.addCell("relo", "text-align:right;desc:number of relocating nodes");
93+
t.addCell("init", "text-align:right;desc:number of initializing nodes");
94+
t.addCell("unassign", "text-align:right;desc:number of unassigned shards");
9595
t.endHeaders();
9696

9797
return t;

src/main/java/org/elasticsearch/rest/action/cat/RestIndicesAction.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -125,14 +125,14 @@ public void onFailure(Throwable e) {
125125
Table getTableWithHeader(final RestRequest request) {
126126
Table table = new Table();
127127
table.startHeaders();
128-
table.addCell("health");
129-
table.addCell("index");
130-
table.addCell("pri", "text-align:right;");
131-
table.addCell("rep", "text-align:right;");
132-
table.addCell("docs", "text-align:right;");
133-
table.addCell("docs/del", "text-align:right;");
134-
table.addCell("size/pri", "text-align:right;");
135-
table.addCell("size/total", "text-align:right;");
128+
table.addCell("health", "desc:current health status");
129+
table.addCell("index", "desc:index name");
130+
table.addCell("pri", "text-align:right;desc:number of primary shards");
131+
table.addCell("rep", "text-align:right;desc:number of replica shards");
132+
table.addCell("docs", "text-align:right;desc:available docs");
133+
table.addCell("docs/del", "text-align:right;desc:deleted docs");
134+
table.addCell("size/pri", "text-align:right;desc:store size of primaries");
135+
table.addCell("size/total", "text-align:right;desc:store size of primaries & replicas");
136136
table.endHeaders();
137137
return table;
138138
}

src/main/java/org/elasticsearch/rest/action/cat/RestMasterAction.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@ public void onFailure(Throwable e) {
7979
Table getTableWithHeader(final RestRequest request) {
8080
Table table = new Table();
8181
table.startHeaders()
82-
.addCell("id")
83-
.addCell("ip")
84-
.addCell("node")
82+
.addCell("id", "desc:node id")
83+
.addCell("ip", "desc:node transport ip address ")
84+
.addCell("node", "desc:node name")
8585
.endHeaders();
8686
return table;
8787
}

src/main/java/org/elasticsearch/rest/action/cat/RestPendingClusterTasksAction.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ public void onFailure(Throwable e) {
7575
Table getTableWithHeader(final RestRequest request) {
7676
Table t = new Table();
7777
t.startHeaders();
78-
t.addCell("insertOrder", "text-align:right;desc:Task insertion order");
79-
t.addCell("timeInQueue", "text-align:right;desc:How long task has been in queue");
80-
t.addCell("priority", "desc:Task priority");
81-
t.addCell("source", "desc:Task source");
78+
t.addCell("insertOrder", "text-align:right;desc:task insertion order");
79+
t.addCell("timeInQueue", "text-align:right;desc:how long task has been in queue");
80+
t.addCell("priority", "desc:task priority");
81+
t.addCell("source", "desc:task source");
8282
t.endHeaders();
8383
return t;
8484
}

src/main/java/org/elasticsearch/rest/action/cat/RestRecoveryAction.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,13 +132,13 @@ public void onFailure(Throwable e) {
132132
@Override
133133
Table getTableWithHeader(RestRequest request) {
134134
Table t = new Table();
135-
t.startHeaders().addCell("index")
136-
.addCell("shard")
137-
.addCell("target", "text-align:right;")
138-
.addCell("recovered", "text-align:right;")
139-
.addCell("%", "text-align:right;")
140-
.addCell("ip")
141-
.addCell("node")
135+
t.startHeaders().addCell("index", "desc:index name")
136+
.addCell("shard", "desc:shard name")
137+
.addCell("target", "text-align:right;desc:bytes of source shard")
138+
.addCell("recovered", "text-align:right;desc:bytes recovered so far")
139+
.addCell("%", "text-align:right;desc:percent recovered so far")
140+
.addCell("ip", "desc:node ip where source shard lives")
141+
.addCell("node", "desc:node name where source shard lives")
142142
.endHeaders();
143143
return t;
144144
}

src/main/java/org/elasticsearch/rest/action/cat/RestShardsAction.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,14 @@ public void onFailure(Throwable e) {
105105
Table getTableWithHeader(final RestRequest request) {
106106
Table table = new Table();
107107
table.startHeaders()
108-
.addCell("index", "default:true;")
109-
.addCell("shard", "default:true;")
110-
.addCell("p/r", "default:true;")
111-
.addCell("state", "default:true;")
112-
.addCell("docs", "text-align:right;")
113-
.addCell("store", "text-align:right;")
114-
.addCell("ip", "default:true;")
115-
.addCell("node", "default:true;")
108+
.addCell("index", "default:true;desc:index name")
109+
.addCell("shard", "default:true;desc:shard name")
110+
.addCell("p/r", "default:true;desc:primary or replica")
111+
.addCell("state", "default:true;desc:shard state")
112+
.addCell("docs", "text-align:right;desc:number of docs in shard")
113+
.addCell("store", "text-align:right;desc:store size of shard (how much disk it uses)")
114+
.addCell("ip", "default:true;desc:ip of node where it lives")
115+
.addCell("node", "default:true;desc:name of node where it lives")
116116
.endHeaders();
117117
return table;
118118
}

0 commit comments

Comments
 (0)