This documentation and the Cisco Observability Platform functionalities it describes are subject to change. Data saved on the platform may disappear and APIs may change without notice.

fmm:metric

Description

fmm:metric maps the fields in an OTLP packet's metric payload to values in an Cisco Observability Platform metric. You must define this mapping because the incoming OTLP metrics are not exactly the same as the Cisco Observability Platform metrics. To declare this knowledge object, first get this information:

  • The type of OTLP metric your solution expects to be ingested into the platform.

  • The mapping of the OTLP metric to the Cisco Observability Platform metric. See mapping information in Metrics Model.

  • The characteristics of each individual metric.

Syntax

{
  "namespace": "<object>",
  "kind": "metric",
  "name": "<metric-name>",
  "displayName": "<metric-name-for-UI>",
  "category": "<Cisco Observability Platform-platform-metric-category>",
  "aggregationTemporality": "<value>",
  "isMonotonic": "<boolean>",
  "contentType": "<Cisco Observability Platform-platform-metric-type>",
  "type": "<primitive-data-type>",
  "unit": "<UCM-unit-code>",
  "ingestGranularities": [
    "<number>","<number>","...","<number>"
  ]
}

Attributes

Attribute Description
namespace Required. The name of the domain (fmm:namespace object) that this metric belongs to.
kind Required. A valid fmm type. Set this to metric.
name Required. Metric name. Must be unique within a solution. Can contain only alphanumeric characters, underscores, or hyphens.
displayName Required. Metric name as displayed in the user interface.
category Required. Cisco Observability Platform metric category.
Valid values: average, current, current_per_instrumented_entity, rate, rate_per_sec, sum, sum_per_instrumented_entity.
See Metrics Model.
aggregationTemporality Required. Aggregation temporality of this metric. Valid values:
• If contentType is sum or distribution, set this to delta.
• If contentType is gauge, leave this blank.
isMonotonic Required. Indicates whether the metric is monotonic or nonmonotonic. Valid values:
• true for monotonic.
• false for nonmonotonic.
Usually, you can set this to false except when category is monotonic_legacy, in which case set this to true.
contentType Required. The Cisco Observability Platform metric type.
Valid values: sum, distribution, gauge.
See Metrics Model.
type Required. The primitive type of the metric. Valid values: long, double.
unit Required. The Unified Code for Units of Measure (UCUM) compliant unit code for the metric.
ingestGranularities An array of numbers representing the granularities at which the metric can be ingested.

Example

{
  "namespace": {
    "name": "stores",
    "version": 1
  },
  "kind": "metric",
  "name": "fee",
  "displayName": "Fee",
  "category": "sum",
  "aggregationTemporality": "delta",
  "isMonotonic": false,
  "contentType": "distribution",
  "type": "double",
  "unit": "usd",
  "ingestGranularities": [
    60
  ]
}