The <metric> tag describes a metric in detail.
Syntax: Metric
>>-<metric id=“token”>------------------------------------------> >--<description>--token--</description>--<format>--NMTOKEN--</format>--> >--+-------------------------------------------+----------------> '-<numcols>--nonNegativeInteger--</numcols>-' >--+--------------------------------+---------------------------> '-<listtype>--token--</listtype>-' >--+-------------------------------------------------------------------------+--> | .--------------------. | | V | | '-<workscopes-supported>----| Workscope-Type |-+--</workscopes-supported>-' >--+----------------------------------+-------------------------> '-<workscope>--token--</workscope>-' >--+----------------------------+--+------------------------+---> '-<filter>--token--</filter>-' '-<unit>--token--</unit>-' >--+------------------------------+-----------------------------> '-<helpurl>--token--</helpurl>-' >--+----------------------------+--</metric>------------------->< '-<helpid>--token--</helpid>-' Workscope-Type |--<workscope-type>--NMTOKEN--</workscope-type>-----------------|
| Tag/Fragment | Description | Type |
|---|---|---|
| id | unique metric ID | token |
| description | description of a metric | token |
| format | type of counter used for this metric; value is in {single, list, report} | NMTOKEN |
| numcols | number of columns in report, if metric is a report | nonNegative |
| listtype | list type of the resource | token |
workscopes- |
valid workscopes for this metric | n/a |
| workscope-type | valid workscope for this metric; value in {G,W,S,P,R,J} | NMTOKEN |
| workscope | description of the workscope (see also The workscope parameter) | token |
| filter | filter argument | token |
| unit | unit of the values returned by this metric; valid values in {count, index, megabytes, micro-, milliseconds , percent, rate per hour, rate per second, seconds, undefined} | token |
| helpurl | URL of help document | token |
| helpid | ID of corresponding paragraph in help document | token |
Example XML code:
<metric id="8D2060">
<description>% processor utilization</description>
<format>single</format>
<listtype> </listtype>
<workscopes-supported>
<workscope-type>G</workscope-type>
</workscopes-supported>
<unit>percent</unit>
<helpurl>/gpm/include/metrics.html</helpurl>
<helpid>5050</helpid>
</metric>