Show MetricKeys

This is a NuoDB Manager command. See NuoDB Manager.

Description

Lists the names of metrics tracked by the broker. You can use these names, also referred to as keys, in NuoDB REST API queries and then plug broker metrics into a third-party monitoring system.

All parameters are optional.

For information about database metrics, see Metrics Published by Database Processes.

Syntax

show metricKeys 
    [ schema boolean ]
    [ csv boolean ]
    [ keyRegex reg_expr ]

Interactive Example

The following command specifies a regular expression that limits the result list to OS metrics. See also: About Operating System Metrics.

nuodb [domain] > show metricKeys keyRegex OS-.*
OS-cpuSystemTimePercent:Counter
OS-cpuTotalTimePercent:Counter
OS-fsVarDirUsePercent:Counter
OS-memUsedPercent:Counter
OS-netAllInbound:Counter
OS-netAllOutbound:Counter

The following command generates output that omits the gauge/counter indication, is a CSV list, and that shows only the OS-cpu.* metric names.

nuodb [domain] > show metricKeys schema false csv true keyRegex OS-cpu.*
OS-cpuSystemTimePercent,OS-cpuTotalTimePercent

Scripting Example

The same show metricKeys command can be executed with --command as follows:

nuodbmgr --broker host --password password --command "show metricKeys"