Skip to content

Commit 10da5cf

Browse files
committed
DOC-4357 Added table intro text & some copy edits
1 parent 1fe4976 commit 10da5cf

File tree

1 file changed

+30
-20
lines changed
  • content/operate/rs/references/cli-utilities/rladmin

1 file changed

+30
-20
lines changed

content/operate/rs/references/cli-utilities/rladmin/status.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ If `issues_only` is specified, it only shows instances that do not have an `OK`
5050

5151
In the `CLUSTER NODES` section, `*node` indicates which node you are connected to.
5252

53+
For descriptions of the fields returned by `rladmin status extra all`, see the output tables for [nodes](#returns-nodes), [databases](#returns-dbs), [endpoints](#returns-endpoints), and [shards](#returns-shards).
54+
5355
### Example
5456

5557
``` sh
@@ -112,27 +114,29 @@ rladmin status databases
112114
| extra state_machine | Shows execution of state machine information |
113115
| extra watchdog | Shows watchdog status |
114116

115-
### Returns
117+
### Returns {#returns-dbs}
116118

117119
Returns a table of the status of all databases on the cluster.
118120

119121
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
120122

121123
If `issues_only` is specified, it only shows databases that do not have an `OK` status.
122124

125+
The following table describes the fields returned by `rladmin status databases extra all`:
126+
123127
| Field | Description |
124128
|-------|-------------|
125129
| DB:ID | Database ID |
126130
| NAME | Database name |
127-
| TYPE | Databases type: Redis or Memcached |
128-
| STATUS | Databases status |
131+
| TYPE | Database type: Redis or Memcached |
132+
| STATUS | Database status |
129133
| SHARDS | The number of primary shards in the database |
130-
| PLACEMENT | The database's shad placement: dense or sparse. It means how the shards will be spread between the nodes in the cluster. |
134+
| PLACEMENT | How the shards are spread across nodes in the cluster, densely or sparsely |
131135
| REPLICATION | Is replication enabled for the database |
132136
| PERSISTENCE | Is persistence enabled for the database |
133137
| ENDPOINT | Database endpoint |
134-
| EXEC_STATE | The state of the state machine - the operation in which it is |
135-
| EXEC_STATE_MACHINE | The name of state machine being run |
138+
| EXEC_STATE | The current state of the state machine |
139+
| EXEC_STATE_MACHINE | The name of the running state machine |
136140
| BACKUP_PROGRESS | The database’s backup progress |
137141
| MISSING_BACKUP_TIME | How long ago a backup was done |
138142
| REDIS_VERSION | The database’s Redis version |
@@ -183,23 +187,25 @@ rladmin status endpoints
183187
| extra state_machine | Shows execution of state machine information |
184188
| extra watchdog | Shows watchdog status |
185189
186-
### Returns
190+
### Returns {#returns-endpoints}
187191
188192
Returns a table of the status of all endpoints on the cluster.
189193
190194
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
191195
192196
If `issues_only` is specified, it only shows endpoints that do not have an `OK` status.
193197
198+
The following table describes the fields returned by `rladmin status endpoints extra all`:
199+
194200
| Field | Description |
195201
|-------|-------------|
196202
| DB:ID | Database ID |
197203
| NAME | Database name |
198204
| ID | Endpoint ID |
199205
| NODE | The node that hosts the endpoint |
200-
| ROLE | The proxy policy of the database: single, all-master-shards, all-nodes |
206+
| ROLE | The proxy policy of the database: single, all-master-shards, or all-nodes |
201207
| SSL | Is SSL enabled |
202-
| WATCHDOG_STATUS | The shards related to that endpoint are monitored and are healthy |
208+
| WATCHDOG_STATUS | The shards related to the endpoint are monitored and healthy |
203209
204210
### Example
205211
@@ -291,7 +297,7 @@ rladmin status nodes
291297
| extra state_machine | Shows execution of state machine information |
292298
| extra watchdog | Shows watchdog status |
293299
294-
### Returns
300+
### Returns {#returns-nodes}
295301
296302
Returns a table of the status of all nodes on the cluster.
297303
@@ -301,10 +307,12 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
301307
302308
`*node` indicates which node you are connected to.
303309
310+
The following table describes the fields returned by `rladmin status nodes extra all`:
311+
304312
| Field | Description |
305313
|-------|-------------|
306314
| NODE:ID | Node ID |
307-
| ROLE | Is the node a primary (`master`) or secondary (`slave`) node? Most management requests are handled by the primary node. |
315+
| ROLE | Is the node a primary (`master`) or secondary (`slave`) node |
308316
| ADDRESS | The node’s internal IP address |
309317
| EXTERNAL ADDRESS | The node’s external IP address |
310318
| HOSTNAME | Node name |
@@ -314,12 +322,12 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
314322
| SHARDS | The number of shards on the node |
315323
| CORES | The number of cores on the node |
316324
| FREE_RAM | free_memory/total_memory<br />**free_memory**: the amount of free memory reported by the OS.<br />**total_memory**: the total physical memory available on the node. |
317-
| PROVISIONAL_RAM | Memory available to create new shards, displayed as available_provisional_memory/total_provisional_memory.<br />**available_provisional_memory**: memory currently available for the creation of new shards.<br />**total_provisional_memory**: memory that would be available to create new shards if the used memory on the node was 0.<br />If the available provisional memory is 0, the node cannot create new shards because the node has reached its shards limit, is in maintenance mode, or is a quorum-only node. |
318-
| FLASH | Very similar to FREE_RAM |
319-
| AVAILABLE_FLASH | Very similar PROVISIONAL_RAM |
325+
| PROVISIONAL_RAM | Memory available to create new shards, displayed as available_provisional_memory/total_provisional_memory.<br />**available_provisional_memory**: memory currently available for the creation of new shards.<br />**total_provisional_memory**: memory that would be available to create new shards if the used memory on the node was 0.<br />If the available provisional memory is 0, the node cannot create new shards because the node has reached its shard limit, is in maintenance mode, or is a quorum-only node. |
326+
| FLASH | The amount of flash memory available on the node, similar to `FREE_RAM` |
327+
| AVAILABLE_FLASH | Flash memory available to create new shards, similar to `PROVISIONAL_RAM` |
320328
| VERSION | The cluster version installed on the node |
321329
| SHA | The node’s SHA hash |
322-
| RACK-ID | The node’s rack-id |
330+
| RACK-ID | The node’s rack ID |
323331
| STATUS | The node’s status |
324332
325333
### Example
@@ -369,26 +377,28 @@ rladmin status shards
369377
| extra state_machine | Shows execution of state machine information |
370378
| extra watchdog | Shows watchdog status |
371379
372-
### Returns
380+
### Returns {#returns-shards}
373381
374382
Returns a table of the status of all shards on the cluster.
375383
376384
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
377385
378386
If `issues_only` is specified, it only shows shards that do not have an `OK` status.
379387
388+
The following table describes the fields returned by `rladmin status shards extra all`:
389+
380390
| Field | Description |
381391
|-------|-------------|
382392
| DB:ID | Database ID |
383393
| NAME | Database name |
384394
| ID | Shard ID |
385395
| NODE | The node on which the shard resides |
386-
| ROLE | The shard’s role: primary (`master`) or replica (`slave`). |
396+
| ROLE | The shard’s role: primary (`master`) or replica (`slave`) |
387397
| SLOTS | Redis keys slot range of the shard |
388398
| USED_MEMORY | Memory used by the shard |
389-
| BACKUP_PROGRESS | Shard’s backup progress. |
390-
| RAM_FRAG | Shard’s RAM fragmentation caused by deleted data or expired keys. A large value can indicate inefficient memory allocation. |
391-
| FLASH_FRAG | For Auto Tiering databases, the shard’s FLASH fragmentation |
399+
| BACKUP_PROGRESS | The shard’s backup progress |
400+
| RAM_FRAG | The shard’s RAM fragmentation caused by deleted data or expired keys. A large value can indicate inefficient memory allocation. |
401+
| FLASH_FRAG | For Auto Tiering databases, the shard’s flash fragmentation |
392402
| WATCHDOG_STATUS | The shard is being monitored by the node watchdog and the shard is healthy |
393403
| STATUS | The shard’s status |
394404

0 commit comments

Comments
 (0)