epadmin-metric
epadmin metric target — Displays, reads, and resets performance metrics captured by running nodes.
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 [
in syntax examples is a reminder that this command requires either the global parameter sn
|ad
]‑‑servicename
or the ‑‑adminport
and ‑‑hostname
combination to identify the node or cluster of interest.
epadmin display metric
epadmin[
display metric epadminsn
|ad
][
display metric --name=sn
|ad
]metricname
epadmin[
display metric --type=meter epadminsn
|ad
][
display metric --name=builtin.cpu.user.utilization.percentage --type=histogramsn
|ad
]
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
epadmin[
read metric --name=sn
|ad
]metricname
epadmin[
read metric --name=builtin.cpu.user.utilization.percentagesn
|ad
]
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[
read metric --name=sn
|ad
]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[
read metric --name=sn
|ad
]liveview_inbound_tuples_per_second
[--properties=table_name=ItemsSales, table_group=user
]