You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rs/references/cli-utilities/rladmin/status.md
+30-20Lines changed: 30 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -50,6 +50,8 @@ If `issues_only` is specified, it only shows instances that do not have an `OK`
50
50
51
51
In the `CLUSTER NODES` section, `*node` indicates which node you are connected to.
52
52
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
+
53
55
### Example
54
56
55
57
```sh
@@ -112,27 +114,29 @@ rladmin status databases
112
114
| extra state_machine | Shows execution of state machine information |
113
115
| extra watchdog | Shows watchdog status |
114
116
115
-
### Returns
117
+
### Returns {#returns-dbs}
116
118
117
119
Returns a table of the status of all databases on the cluster.
118
120
119
121
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
120
122
121
123
If `issues_only` is specified, it only shows databases that do not have an `OK` status.
122
124
125
+
The following table describes the fields returned by `rladmin status databases extra all`:
126
+
123
127
| Field | Description |
124
128
|-------|-------------|
125
129
| DB:ID| Database ID |
126
130
| 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 |
129
133
| 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|
131
135
| REPLICATION | Is replication enabled for the database |
132
136
| PERSISTENCE | Is persistence enabled for the database |
133
137
| 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|
136
140
| BACKUP_PROGRESS | The database’s backup progress |
137
141
| MISSING_BACKUP_TIME | How long ago a backup was done |
138
142
| REDIS_VERSION | The database’s Redis version |
@@ -183,23 +187,25 @@ rladmin status endpoints
183
187
| extra state_machine | Shows execution of state machine information |
184
188
| extra watchdog | Shows watchdog status |
185
189
186
-
### Returns
190
+
### Returns {#returns-endpoints}
187
191
188
192
Returns a table of the status of all endpoints on the cluster.
189
193
190
194
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
191
195
192
196
If `issues_only` is specified, it only shows endpoints that do not have an `OK` status.
193
197
198
+
The following table describes the fields returned by `rladmin status endpoints extra all`:
199
+
194
200
| Field | Description |
195
201
|-------|-------------|
196
202
| DB:ID | Database ID |
197
203
| NAME | Database name |
198
204
| ID | Endpoint ID |
199
205
| 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 |
201
207
| 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 |
203
209
204
210
### Example
205
211
@@ -291,7 +297,7 @@ rladmin status nodes
291
297
| extra state_machine | Shows execution of state machine information |
292
298
| extra watchdog | Shows watchdog status |
293
299
294
-
### Returns
300
+
### Returns {#returns-nodes}
295
301
296
302
Returns a table of the status of all nodes on the cluster.
297
303
@@ -301,10 +307,12 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
301
307
302
308
`*node` indicates which node you are connected to.
303
309
310
+
The following table describes the fields returned by `rladmin status nodes extra all`:
311
+
304
312
| Field | Description |
305
313
|-------|-------------|
306
314
| 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 |
308
316
| ADDRESS | The node’s internal IP address |
309
317
| EXTERNAL ADDRESS | The node’s external IP address |
310
318
| HOSTNAME | Node name |
@@ -314,12 +322,12 @@ If `issues_only` is specified, it only shows nodes that do not have an `OK` stat
314
322
| SHARDS | The number of shards on the node |
315
323
| CORES | The number of cores on the node |
316
324
| 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 forthe 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, isin 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 forthe 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, isin 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`|
320
328
| VERSION | The cluster version installed on the node |
321
329
| SHA | The node’s SHA hash|
322
-
| RACK-ID | The node’s rack-id|
330
+
| RACK-ID | The node’s rack ID|
323
331
| STATUS | The node’s status |
324
332
325
333
### Example
@@ -369,26 +377,28 @@ rladmin status shards
369
377
| extra state_machine | Shows execution of state machine information |
370
378
| extra watchdog | Shows watchdog status |
371
379
372
-
### Returns
380
+
### Returns {#returns-shards}
373
381
374
382
Returns a table of the status of all shards on the cluster.
375
383
376
384
If `sort <column_titles>` is specified, the result is sorted by the specified table columns.
377
385
378
386
If `issues_only` is specified, it only shows shards that do not have an `OK` status.
379
387
388
+
The following table describes the fields returned by `rladmin status shards extra all`:
389
+
380
390
| Field | Description |
381
391
|-------|-------------|
382
392
| DB:ID | Database ID |
383
393
| NAME | Database name |
384
394
| ID | Shard ID |
385
395
| 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`) |
387
397
| SLOTS | Redis keys slot range of the shard |
388
398
| 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 |
392
402
| WATCHDOG_STATUS | The shard is being monitored by the node watchdog and the shard is healthy |
0 commit comments