Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-12730

Meta-data tag enhancements to Time Series Storage API

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 27.0.0
    • Component/s: None
    • Security Level: Default (Default Security Scheme)
    • Labels:
    • Sprint:
      Horizon 2020 - May 27

      Description

      Background

      The Time Series Storage (TSS) API uses meta-data tags to help index metrics and relate them to collection resources. These tags are sufficient for querying the metrics via the Measurements APIs.

      The tags however fall short when trying to use the metrics from other systems. For example, here we have mapped to tags to labels in Prometheus and are attempting to render the series in Grafana:

      These do not include enough context, and are not relatable to the user.

      In order to improve the usability of the metrics in other systems, we should be able to add more tags to the metrics. Additional tags come at the cost of highers series cardinality, so we should also provide controls to configure which tags are set.

      Proposal

      Add the ability to set the following meta-data tags for metrics exposed via the TSS API:

      • nodeLabel
      • location
      • sysObjectID
      • foreignSource
      • foreignId
      • nodeCriteria
      • ipAddress
        • for response time resources
      • service
        • for response time resources
      • ifDescr
        • for interface resources
      • ifAlias
        • for interface resources
      • resourceLabel
      • categories
        • we a have a list of values, so we need to find a way to map these to key-value pairs
        • assume we have node categories Production,Router,DC1, we could map these to {catProduction: true, catRouter:true, catDC1:true}
      • asset fields
        • map arbitrary asset fields to tags
      • node meta-data
        • use Meta-Data DSL expressions to build tags

      We should have the ability to turn each of these on/off individually in order to control the cardinality.

        Attachments

          Activity

            People

            Assignee:
            patrick.schweizer Patrick Schweizer
            Reporter:
            j-white Jesse White
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: