Previous Topic: About Custom Metric FamiliesNext Topic: Understanding the Metric Family XML Structure


Create a Metric Family XML Template

Use your preferred REST client to create an example XML file that you can use as a template for creating your custom metric family.

Start by retrieving a list of existing metric families. You can then verify whether the metric family that you require is already supported.

Follow these steps:

  1. Set up a REST client with a connection to the Data Aggregator server.
  2. Enter the following URL for the Data Aggregator web services API in the REST client:
    http://da_hostname:8581/typecatalog/metricfamilies
    

    A list of all available metric families displays.

  3. Verify whether the metric family that you require is already supported.

If the metric family that you require is not already supported, view and export a metric family that is similar to the custom metric family that you want to create.

Follow these steps:

  1. To retrieve a specific metric family that is similar to the metric family that you require, enter the following URL:
    http://da_hostname:8581/typecatalog/metricfamilies/name
    
    name

    Is the name of a specific, existing metric family, such as NormalizedCPUInfo.

  2. Select GET in the Method tab.
  3. Run the method.

    The XML that is returned includes the metric family information.

    You can use this XML as a template to create custom metric families.

  4. Copy the metric family XML into a text file and then modify it, as needed. For an example of the XML structure, see Understanding the Metric Family XML.