14.3.11 storeusage (checks the usage status of ranges and caches)
- Organization of this subsection
(1) Description
This subcommand displays the number of keys stored in and the amount of memory usage for each range. The subcommand also displays the upper limits of the total data restrictions that have been set for the ranges and caches.
(2) Rules
-
This subcommand can be executed only when the status of the cluster is one of the following:
-
Cluster available (AVAILABLE)
-
Cluster partially available (PARTIALLY_AVAILABLE)
-
-
The target of this subcommand is the EADS servers whose cluster participation status is online. This subcommand cannot be executed if the cluster contains any EADS server whose cluster participation status is standby. You can determine the cluster participation status with the eztool status command.
-
This subcommand can be executed when the target EADS servers are in the following status:
-
Initializing
-
Initialized
-
Running
-
Closing
-
Closed
-
(3) Format
eztool storeusage [--replica|--cache cache-name] [--format format-name] [--columns column-name[,column-name]...] [--filter filter-condition] [--match matching-condition]
(4) Options and arguments
(a) --replica
Specify this option to also include the number of keys copied for data redundancy purposes.
If this option is omitted, the number of keys copied for data redundancy purposes is not included.
(b) --cache cache-name
Specify this option if you want to display the number of keys and memory usage amount for each range in a specific cache. For a disk cache or two-way cache, the disk usage amount and its upper limit value are displayed.
The following characters are permitted for a cache name:
-
If cache property files were not used to create caches
A maximum of 32 single-byte characters in ASCII codes 0x20 to 0x7E
-
If cache property files were used to create caches
A maximum of 32 single-byte alphanumeric characters (0 to 9, A to Z, and a to z)
If this option is omitted, the sum of the numbers of keys in all caches that are obtained for each range is displayed as the total number of keys.
(c) --format format-name
For details about this option, see 14.4.2 How to specify the display format.
(d) --columns column-name[,column-name]...
For details about this option, see 14.4.3 How to specify column filters.
(e) --filter filter-condition
For details about this option, see 14.4.4 How to specify row filters.
(f) --match matching-condition
For details about this option, see 14.4.5 How to specify a condition match.
(5) Output example
The following shows output examples of the eztool storeusage command's execution results.
For details about the components of the displayed information, see 14.4.1 Components of the displayed information.
When the --replica option and the --cache option are both omitted
When the --replica option is specified
When the --cache option is specified
The following table lists and describes the content information that is displayed.
No. |
Column name |
Description |
Whether displayed |
||
---|---|---|---|---|---|
Specification of --replica and --cache options |
|||||
Both omitted |
--replica option specified |
---cache option specified |
|||
1 |
RangeID |
Range ID |
Y |
Y |
Y |
2 |
StartPosition |
Start position (hash value) of each range#1 The positions (hash values) are displayed in descending order. |
Y |
Y |
Y |
3 |
EndPosition |
End position (hash value) of each range#1 |
Y |
Y |
Y |
4 |
Server |
IP address of the data storage EADS server in each range and the EADS server's port number used to communicate with the EADS clients.#2 This information is displayed in the following format: IP address:port number |
Y |
Y |
Y |
5 |
StoredExternalHeapSize |
Amount of total memory usage in memory caches and two-way caches#3 (megabytes)
|
Y |
Y |
Y |
6 |
ExternalHeapSizeLimit |
Maximum memory usage amount#3,#4 (megabytes) For a disk cache, 0 is displayed. |
Y |
N |
N |
7 |
StoredDiskSize |
Disk usage amount of disk caches or two-way caches#3,#5 (megabytes) The digits after the decimal point are truncated. |
N |
N |
Y |
8 |
DiskSizeLimit |
Maximum disk usage amount of disk caches or two-way caches#3,#4,#5 (megabytes) |
N |
N |
Y |
9 |
RangeKeyCount |
Total number of keys in each range#3 This value does not include the number of keys copied for data redundancy purposes. |
Y |
N |
Y |
10 |
KeyCountLimit |
Upper limit of the total number of keys in each range#3,#4 This does not include the number of keys copied for data redundancy purposes. |
Y |
N |
N |
11 |
KeyCount(ServerID:x Position:y)#6 |
Total number of keys in each range for each EADS server#3
|
N |
Y |
N |
- Legend:
-
Y: Displayed
N: Not displayed
- #1
-
Each range is as follows:
-
If the StartPosition value is less than the EndPosition value
Range from the StartPosition value to the EndPosition value
-
If the StartPosition value is greater than the EndPosition value
Range that combines the following ranges:
From the StartPosition value to 2,147,483,647
from -2,147,483,648 to the EndPosition value
-
- #2
-
A hyphen (-) is displayed if the EADS server on which the original data in the corresponding range is stored and the EADS servers to which the data in the corresponding range is to be copied are all isolated or in process down status.
- #3
-
A hyphen (-) is displayed if information for the corresponding range cannot be acquired.
- #4
-
A hyphen (-) is displayed if the total data restriction function is disabled.
- #5
-
A hyphen (-) is displayed for a memory cache.
- #6
-
For x, the EADS server's server ID is displayed. For y, the EADS server's location (hash value) is displayed.
(6) Return code
The following table lists the return codes that this subcommand returns.
No. |
Return code |
Description |
|
---|---|---|---|
eads.command.compat parameter omitted in the command properties |
0300 specified in the eads.command.compat parameter in the command properties |
||
1 |
0 |
0 |
Command execution was successful. |
2 |
101 |
101 |
Initialization of the command failed. |
3 |
110 |
Connection establishment failed. |
|
4 |
111 |
The command failed due to a communication timeout. |
|
5 |
120 |
The command failed due to a syntax error. |
|
6 |
130 |
The command failed because it could not be executed. |
|
7 |
150 |
The command failed during execution. |
|
8 |
200 |
The command failed due to a timeout. |
- When the --match option is specified:
-
If the condition was satisfied, the subcommand returns 0; otherwise, the subcommand returns 1. If the command's execution failed, the return code is the same as when the --match option is not specified.
(7) Notes
-
If the command times out during output processing, the output results might not be complete. The command might time out even if output processing is complete. If this happens, increase the command's timeout value, and then re-execute the command.
-
This subcommand might fail during scale-out processing because the cluster configuration is changed.