epadmin-metric

epadmin metric target — Displays, reads, and resets 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, and reset performance metrics captured by running nodes.

The metric target has three 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 reset metric

Resets a specified metric to its initial value. 

epadmin [sn|ad] reset metric --name=metricname
Command Parameter Description Required
name Name of metric to reset. Yes.

SEE ALSO

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