Create or Extend Metric Families

HID_Create_or_Extend_Metric_Families
DX NetOps Performance Management
includes metric families. If an existing metric family is close to meeting your monitoring needs, you can extend it. If you require something different, create a custom metric family.
For an example, see Add Metrics to Existing Metric Families.
Create or extend a metric family using the following process:
Verify the Prerequisites
Before you create custom metric families, verify that you have completed the following prerequisites:
  • You have downloaded and reviewed the related schema XSD files. The schema is required to validate your XML files.
    For more information, see Certification Schema Files and Examples.
  • To prevent possible data loss, you have backed up the certification directory.
Create a Metric Family
Create a custom metric family or extended an existing metric family using the metric family XML as a template. Create the XML template using an existing metric family. For extensions, get the XML for the target metric family.
Create a Metric Family XML Template
Follow these steps:
  1. Set up a REST client with a connection to the data aggregator server.
  2. Retrieve the metric family XML template by entering the following URL:
    You can retrieve the name of the metric family using the user interface (UI). Click the downward arrow on any column, hover over
    Columns
    , and click
    Internal Name
    , and then go to the
    Metric Families
    page.
    • New Metric Family:
      http://
      da_hostname
      :8581/typecatalog/metricfamilies/
      mf_name
    • Extension:
      http://
      da_hostname
      :8581/typecatalog/metricfamilies/
      mf_name
      mf_name
      specifies the name of the metric family template.
  3. Select GET in the
    Method
    tab, and run the method.
The REST client returns the metric family XML.
Edit the Metric Family XML
You edit metric families by editing the metric family XML file.
For more information about the XML structure, see Metric Family XML Structure.
The units label on reports is
Units
if the
Units
attribute is not defined in the XML.
When extending an existing metric family, include only the XML nodes that require changes. When adding metrics to metric families, check the existing collected metrics for those monitoring profiles that are configured to select collected metrics (the profile has assigned metric families), and add the new metrics.
For more information, see Add Metrics to Existing Metric Families.
Import a Metric Family
Select one of the following options to import a metric family:
Import Using a REST Client
Follow these steps:
  1. Specify one of the following URLs:
    • Custom Metric Family:
      http://
      da_hostname
      :8581/typecatalog/metricfamilies/
    • Extend Metric Family:
      http://
      da_hostname
      :8581/typecatalog/metricfamilies/extension/
      mf_name
  2. On the
    Method
    tab, Select
    POST
    for a new custom metric family, or select
    PUT
    to update or extend a metric family.
  3. In the
    Body
    settings, select
    application/xml
    as the Body Content-type.
  4. Copy the metric family XML into the
    Body
    tab.
  5. Run the method.
The custom metric family is imported. If no errors occur, the Status field in the HTTP Response section displays the following result:
HTTP/1.1 200 OK
Import using
NetOps Portal
Follow these steps:
  1. Hover over
    Administration
    , and click the Data Aggregator data source.
  2. Expand
    Monitoring Configuration
    , and then click
    Metric Families
    .
    Locate specific information that is related to a pane using Search. Alternatively, navigate between pages in a pane using the arrows.
  3. Click
    Import
    .
  4. Click
    Browse
    , and then select the metric family file.
    You can import ZIP files. For example, you can import the downloaded ZIP file for a certification from the On-Demand Certification support page.
  5. Click
    Open
    , and then click
    Import
    .
The custom metric family is imported.
Update the Metric Family Properties
To change attributes, such as the display name, update the metric family properties.
Follow these steps:
  1. Specify the following URL:
    • Extend Metric Family:
      http://
      da_hostname
      :8581/typecatalog/metricfamilies/extension/
      mf_name
  2. To update or extend a metric family, on the
    Method
    tab, select
    PUT
    .
  3. In the
    Body
    settings, select
    application/properties
    as the
    Body Content-type
    .
  4. Specify updates with one line per property in the
    Body
    tab as illustrated in the following template and example.
    Template:
    The
    metricfamilyname
    and
    attributename
    variables in the following example are case-sensitive and are lowercase. These variables are a different case from their values in the XML. For example,
    NormalizedPortInfo
    from the XML is
    normalizedportinfo
    here and
    PctDiscardsIn
    in the XML is
    pctdiscardsin
    here.
    im.ca.com.normalizer.
    metricfamilyname
    .displayname=DisplayName
    im.ca.com.normalizer.
    metricfamilyname
    .documentation=Documentation text
    im.ca.com.normalizer.
    metricfamilyname
    .attribute.
    attributename
    .attributedisplayname=AttributeDisplayName
    im.ca.com.normalizer.
    metricfamilyname
    .attribute.
    attributename
    .documentation=Documentation text
    Example:
    im.ca.com.normalizer.normalizedportinfo.displayname=Interface
    im.ca.com.normalizer.normalizedportinfo.documentation=Defines the identification information, configuration information, and polled metrics for interfaces.
    im.ca.com.normalizer.normalizedportinfo.attribute.pctdiscardsin.attributedisplayname=Percent Discards In
    im.ca.com.normalizer.normalizedportinfo.attribute.pctdiscardsin.documentation=The percentage of the frames (packets) received by the interface that were discarded.
  5. Run the method.
The metric family properties are updated.
Trigger Rediscovery
After you extend a metric family, the changes occur during the nightly automatic rediscovery. If the changes do not apply automatically, trigger the update manually.
Prevent severe impacts on performance by triggering rediscoveries
after
normal business hours.
Follow these steps:
  1. In
    NetOps Portal
    , from the list of metric families, select the metric family.
  2. Click
    Update Metric Family
    .
The data aggregator rediscovers components on all devices that support the selected metric family.
Verify the Metric Family Results
To ensure successful operation, verify the results of the import. In
NetOps Portal
, from the list of metric families, verify that the metric family is in the list and that the
Last Modified
time has been updated.