CLI Guide

Arguments
Required arguments
[-n|--name] monitor-
name
* Name of the monitor. The name is appended to the director on which the monitor is
configured.
[-s|--stats]
stat[,stat,...]
* One or more statistics to monitor, separated by commas.
Use the monitor stat-list command to display the available statistics.
Optional arguments
[-p|--period] collection-
period
Frequency at which this monitor collects statistics. Valid arguments are an integer followed by:
ms - milliseconds (period is truncated to the nearest second)
s - seconds (Default)
min - minutes
h - hours
0 - Disables automatic polling.
The default period is 30 seconds.
[-d|--director]
context-path, context-
path...
* List of one or more comma-separated directors for which to display statistics.
[-t|--targets]
context-path, context-
path...
List of one or more comma-separated targets for which to display statistics. Applicable only to
statistics that require a target.
[-f|--force]
Forces the creation of the monitor, even if existing monitors are delayed in their polling.
* - argument is positional.
Description
Performance monitoring collects and displays statistics to determine how a port or volume is being used, how much I/O is being
processed, CPU usage, and so on.
Metro node collects and displays performance statistics using two user-defined objects:
● monitors - Gather the specified statistics.
● monitor sinks - Direct the output to the desired destination. Monitor sinks include the console, a file, or a combination of the
two.
The monitor defines the automatic polling period, the statistics to be collected, and the output of the format. The monitor sinks
define the output destination.
Polling occurs when:
● The timer defined by the monitor’s period attribute has expired.
● The monitor has at least one sink with the enabled attribute set to true.
Polling is suspended when:
● The monitor’s period is set to 0, and/or
● All the monitor’s sinks are either removed or their enabled attribute is set to false
Create short-term monitors to diagnose an immediate problem.
Create longer-term monitors for ongoing system management.
254
Commands