Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Specify a name-value pair for the metrics.
    Each metric has a name-value pair that is converted to a java 'long' value. A typical metric entry in the script file has the following structure:

    No Format
    name=<metric name>,value=<long value>,aggregator=<aggregator type>, time-rollup=<time-rollup strategy>, cluster-rollup=<cluster-rollup strategy>

    Use the following format:



    Standard Form

    Hardware Resources| Instrument Name=Instrument Value

    Fully Qualified Form

    Hardware Resources| <metric name>,value=<long value>

  2. Define the category of the metric, for example:
    1. Infrastructure (for the default hardware metrics, see Standalone Machine Agent)
    2. JVM
    3. Custom Metrics
    Custom metrics must have the path prefixes:
    1. Custom Metrics
    2. Server|Component:<tier-name-or-tier-id>

    Metrics with the Custom Metrics prefix are common across all tiers in your application. Metrics with the Server|Component:<tier-name-or-tier-id> prefix appear only under the specified tier. 


    Custom Metrics that use the tier-id metrics prefix are supported in dashboards. However, Custom Metrics with the tier-name prefix are currently not supported in dashboards.

    To find the component ID of a tier, open the dashboard for the tier and inspect the URL. The ID appears as the component value in the URL, as shown:


    Custom Metrics are currently not supported in dashboards.


    The Machine Agent has to be associated with the target/destination for the metrics. If you try to publish metrics to a Tier that is not associated with the Machine Agent, the metrics can not be reported.

    The "|" character separates the branches in the metric hierarchy, telling the Controller where the metric should appear in the metric tree:

    No Format
    Custom Metrics|Hardware Resources|Disks|Total Disk Usage %
    Custom Metrics|Hardware Resources|Disks|Disk 1|Current Disk Usage %

    You can insert a custom metric alongside an existing type of metric. For example, the following declaration causes the custom metric named pool usage to appear alongside the JMX metrics:

    • Server|Component:18|JMX|Pool|First|pool usage

    The metric can then be used in health rules as would other types of JMX metrics.