epadmin-statistics

epadmin statistics target — Manages the collection and display of runtime performance statistics.

SYNOPSIS

epadmin [globalparameters] command statistics [commandparameters]

DESCRIPTION

Use the statistics target to xxx

Manages the collection and display of runtime performance statistics. Details on the statistics data gathered, and their meaning, can be found in the Performance Tuning Guide. Supported statistics are defined in the Supported Statistics table.

The statistics target has seven commands:

The designation [sn|ad] in syntax examples is a reminder that this command requires either the global parameter ‑‑servicename or the ‑‑adminport and ‑‑hostname combination to identify the node or cluster of interest.

Supported Statistics Table

The columns in this table have the following meanings:

  • Statistic—Statistic name

  • Description—Brief description.

  • Enable / Disable—Yes indicates that the statistic must be explicitly enabled to start collection and disabled to stop collection.

  • Clear—Yes indicates that the statistic value can be cleared.

  • Detailed—Yes indicates that detailed output is available for the statistic.

  • Filter—Indicates whether filtering is supported for the statistic. For statistics that support filtering, the valid filter values are java or none. A value of java indicates that statistics are only reported for Java managed objects. A value of none reports statistics for all managed objects.

Statistic Description Enable / Disable Clear Detailed Filter
activetransactions Active Transactions No No No No
allocationsummary Allocator Allocation Summary No No No No
allocatorbuckets Allocator Buckets No No Yes No
allocatorsummary Allocator Summary No No No No
blockedtransactions Blocked Transactions No No No No
cachedengine Cached Engines No Yes No No
classtransform Class Transformation No Yes Yes No
classtypedescriptor Class Type Descriptors Yes Yes No No
cpu CPU Utilization Yes No No No
deadlock Deadlock No Yes Yes No
disk Disk Yes No No No
distributionchannel Distribution Network Yes Yes Yes No
distributionnode Distribution No Yes No No
engine Node Processes No No No No
eventbus Shared Memory IPC No Yes Yes No
eventlog Shared Memory IPC Detailed Yes Yes No No
files Files No No No No
hash Shared Memory Hashing No No Yes No
host Kernel Information No No No No
javacache JNI Cache No Yes No No
javastack Java Stack No No No No
javatransaction Transaction Yes Yes Yes No
jni Runtime JNI Calls Yes Yes No No
lifecycle Node and Engine Start and Stop Timing Events No Yes Yes No
localmutex Local Mutex Yes Yes Yes No
memoryusage Memory Usage No Yes* No No
mutex Shared Memory Mutex Yes Yes Yes No
namedcache Named Caches No Yes No No
native Native Runtime Calls No Yes No No
navigation Query No Yes No java or none. The default is java.
network Network Yes No No No
object Objects No Yes No java or none. The default is java.
objectmemory Per Object Type Shared Memory Utilization No No No java or none. The default is java.
partition Partition No Yes No No
sar System Activity Reporter Yes No No No
systeminfo System Information No No No No
threads System Threads No No No No
timer Timers No No No No
transaction Transaction Locking Yes Yes Yes java or none. The default is java.
transactioncontention Transaction Contention Yes Yes No java or none. The default is java.
transactionpromotion Transaction Promotion Yes Yes No java or none. The default is java.
vmstat Virtual Memory Yes No No No

*Clearing memoryusage only clears the memory throttle statistics.

epadmin clear statistics

Clears current statistic values. Clearing a statistic that lacks support clear has no effect. See the Supported Statistics table for a list of statistics that support clearing.

epadmin [sn|ad] clear statistics --statistics="transaction,mutex"
Command Parameter Description Required
statistics Comma-separated list of statistics in quotes. See the Supported Statistics table for the list of valid statistics. Yes.

epadmin disable statistics

Disables collection of statistics. Disabling a statistic that lacks support disable has no effect. See the Supported Statistics table for a list of statistics that support disabling.

epadmin [sn|ad] disable statistics --statistics="transaction,mutex"
Command Parameter Description Required
statistics Comma-separated list of statistics in quotes. See the Supported Statistics table for the list of valid statistics. Yes.

epadmin display statistics

Displays statistic values.

Displaying a statistic that has no data available generates empty output.

epadmin [sn|ad] display statistics --statistics="transaction,mutex"
epadmin [sn|ad] display statistics --statistics="transaction,mutex" --detailed
epadmin [sn|ad] display statistics --statistics="object,transaction" --filter=none
epadmin [sn|ad] display statistics --statistics="transaction,mutex" --label="Transaction & Mutex Report"
Command Parameter Description Required
statistics Comma-separated list of statistics. See the Supported Statistics table for the list of valid statistics. Yes.
detailed A boolean indicating whether detailed values should be displayed. See the Supported Statistics table for statistics that support detailed output. No. The default value is false.
filter Filter statistics output. See the Supported Statistics table for statistics that support filtering and if so, their valid filter values. Only a single filter value may be specified for a list of statistics. No. The default value is statistics-specific.
label A string to append to the header in non-delimited output. No. No default.

epadmin enable statistics

Enables collection of statistics. Enabling a statistic that does not support enable is ineffective. See the Supported Statistics table for a list of statistics that support enabling.

epadmin [sn|ad] enable statistics --statistics="transaction,mutex"
Command Parameter Description Required
statistics Comma-separated list of statistics. See the Supported Statistics table for the list of valid statistics. Yes.

epadmin snapshot statistics

Displays a timed snapshot of statistic values. Internally, the snapshot command performs the following steps in order—warm up sleep disable, clear, enable, time sleep, disable, display. The warm up sleep duration is controlled by the warmupseconds parameter. The time sleep duration is controlled by the time parameter.

epadmin [sn|ad] snapshot statistics --statistics="transaction,mutex" --seconds=10
epadmin [sn|ad] snapshot statistics --statistics="transaction,mutex" --seconds=10 
    --warmupseconds=10 --detailed
epadmin [sn|ad] snapshot statistics --statistics="object,transaction" --seconds=10 
    --filter=none
epadmin [sn|ad] snapshot statistics --statistics="transaction,mutex" --seconds=10 
    --warmupseconds=10 --serialize
Command Parameter Description Required
statistics Comma-separated list of statistics. See the Supported Statistics table for the list of valid statistics. Yes.
seconds The number of seconds to collect data. Yes.
warmupseconds The number of seconds to wait before starting the snapshot collection cycle. No . The default value is 0.
detailed Value passed to the display command in the snapshot collection cycle. No. No default value.
filter Value passed to the display command in the snapshot collection cycle. No. No default value.
serialize Serialize collection of statistics if true. A separate collection cycle is ran for each statistic being collected, starting with the warm up sleep. No. The default value is false.

epadmin status statistics

Displays current collection status of statistics that can be enabled and disabled. This command has no parameters.

epadmin [sn|ad] status statistics

epadmin supported statistics

Displays the current list of supported statistics for the specified node or cluster. This command has no parameters.

epadmin [sn|ad] supported statistics