epadmin-metric

epadmin metric target — Displays, reads, resets, enables, and disables performance metrics captured by running nodes.

SYNOPSIS

epadmin [globalparameters] command metric [commandparameters]

DESCRIPTION

When a node is installed and started, it automatically starts capturing performance metrics. Use the metric target to display, read, reset,enable, and disable performance metrics captured by running nodes.

The metric target has five 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.

epadmin display metric

Displays registered metrics. 

epadmin [sn|ad] display metric
epadmin [sn|ad] display metric --name=metricname
epadmin [sn|ad] display metric --type=meter
epadmin [sn|ad] display metric --name=builtin.cpu.user.utilization.percentage --type=histogram
Command Parameter Description Required
name Metric name or names to display. (Obtain names of metrics from the display metric command without arguments.) No. The default is to display all registered metrics.
type Metric type to display, one of: meter, counter, histogram, timer, or gauge. No. The default is to display all metric types.

epadmin read metric

Reads a metric value. 

epadmin [sn|ad] read metric --name=metricname
epadmin [sn|ad] read metric --name=builtin.cpu.user.utilization.percentage
Command Parameter Description Required
name Name of metric to read as reported by the display metric command. Yes.

epadmin help read metric

Reads a metric value and filters results by metric properties. 

epadmin [sn|ad] read metric --name=metricname [--properties=metricproperties]
Command Parameter Description Required
name Name of metric to read as reported by the display metric command. Yes.
properties Properties of metric to read. No. The default is to get all properties.

Multiple properties can be specified with comma separation. For example: 

epadmin [sn|ad] read metric --name=liveview_inbound_tuples_per_second [--properties=table_name=ItemsSales,
table_group=user]

epadmin reset metric

Resets a specified metric to its initial value. 

epadmin [sn|ad] reset metric
epadmin [sn|ad] reset metric --name=metricname
Command Parameter Description Required
name Name of metric to reset. No. The default is to reset all registered metrics.

epadmin enable metric

Enables a registered metric. 

epadmin [sn|ad] enable metric
epadmin [sn|ad] enable metric --name=metricname
Command Parameter Description Required
name Name of metric to enable. No. The default is to enable all registered metrics.

epadmin disable metric

Disables a registered metric. 

epadmin [sn|ad] disable metric
epadmin [sn|ad] disable metric --name=metricname
Command Parameter Description Required
name Name of metric to disable. No. The default is to disable all registered metrics.

SEE ALSO

Help System for epadmin
epadmin(1)
epadmin-globals(1)