Cisco Observability Platform

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.

MELT Processing Rules

All solutions must define the rules for processing incoming MELT data. Space Fleet defines the following rules:

  • Resource mapping
  • Entity priority
  • Metric mappings

Resource Mapping

The first step in data ingestion is resource mapping --in other words, autocreating entities based on the resource map of the incoming OTLP signal, also called the OTLP Resource.

In the OpenTelemetry world, all telemetry is generated by an OTLP Resource:

An OTLP Resource is an immutable representation of the entity producing telemetry as attributes. For example, a process producing telemetry that is running in a container on Kubernetes has a pod name, it is in a namespace, and possibly is part of a deployment, which also has a name. All three of these attributes can be included in the OTLP Resource.

You specify the mapping criteria between the attributes in OTLP Resources and entities in fmm:resourceMapping configurations.

Space Fleet defines all of its resource mappping configurations in the file spacefleet/objects/fmm/topology/resource-mappings.json. This file contains an array of fmm:resourceMapping configurations:

json
Copy[
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_spacecraft_entity_mapping",
    "displayName": "Space Fleet Spacecraft Entity Mapping",
    "description": "Space Fleet spacecraft Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name'])  && 'spacefleet:spacecraft'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:spacecraft",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_sick_bay_entity_mapping",
    "displayName": "Space Fleet Sick Bay Entity Mapping",
    "description": "Space Fleet Sick Bay Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name', 'spacefleet.room.name']) && 'spacefleet:sick_bay'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:sick_bay",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_bridge_entity_mapping",
    "displayName": "Space Fleet Bridge  Entity Mapping",
    "description": "Space Fleet Bridge Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name', 'spacefleet.room.name']) && 'spacefleet:bridge'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:bridge",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_mess_hall_entity_mapping",
    "displayName": "Space Fleet Mess Hall Entity Mapping",
    "description": "Space Fleet Mess Hall Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name', 'spacefleet.room.name']) && 'spacefleet:mess_hall'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:mess_hall",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_intercom_entity_mapping",
    "displayName": "Space Fleet Intercom Entity Mapping",
    "description": "Space Fleet Intercom Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name', 'spacefleet.room.name']) && 'spacefleet:intercom'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:intercom",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_shield_entity_mapping",
    "displayName": "Space Fleet Shield Entity Mapping",
    "description": "Space Fleet Shield Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name', 'spacefleet.shield.id']) && 'spacefleet:shield'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:shield",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_warp_drive_entity_mapping",
    "displayName": "Space Fleet Warp Drive Entity Mapping",
    "description": "Space Fleet Warp Drive Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.spacecraft.name']) && 'spacefleet:warp_drive'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:warp_drive",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_torpedo_tube_entity_mapping",
    "displayName": "Space Fleet Torpedo Tube Entity Mapping",
    "description": "Space Fleet Torpedo Tube Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.torpedo_tube.id', 'spacefleet.spacecraft.name'])  && 'spacefleet:torpedo_tube'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:torpedo_tube",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  },
  {
    "namespace": {
      "name": "spacefleet",
      "version": 1
    },
    "kind": "resourceMapping",
    "name": "spacefleet_torpedo_entity_mapping",
    "displayName": "Space Fleet Torpedo Entity Mapping",
    "description": "Space Fleet Torpedo Entity Mapping",
    "scopeFilter": "containsAll(resourceAttributes, ['spacefleet.torpedo_tube.id', 'spacefleet.spacecraft.name', 'spacefleet.torpedo.id']) && 'spacefleet:torpedo'.equals(getValue(resourceAttributes, 'spacefleet.type'))",
    "entityType": "spacefleet:torpedo",
    "mappings": [
      {
        "to": "attributes",
        "from": "resourceAttributes.stream()"
      }
    ]
  }
]

Space Fleet includes the fmm:resourceMapping object in its manifest, spacefleet/manifest.json, in the dependencies and objects arrays:

  1. In the dependencies array, line 3 pulls in the fmm component, which is what the fmm:resourceMapping object depends on:

    json
    Copy"dependencies": [
    "dashui",
    "fmm",
    "k8s",
    "zodiac",
    "codex",
    "healthrule",
    "iam"
]

  2. In the objects array, these lines pull in the definition of Space Fleet's fmm:resourceMapping object:

    json
    Copy"objects": [
    {
        "type": "fmm:resourceMapping",
        "objectsFile": "objects/fmm/topology/resource-mappings.json"
    }
]

Entity Priority

Space Fleet defines entity priority in a knowledge object of type fmm:entityPriority in the file spacefleet/objects/fmm/topology/entity-priority.json with the following contents:

json
Copy[
    {
        "namespace": {
            "name": "spacefleet",
            "version": 1
        },
        "kind": "entityPriority",
        "name": "spacefleet_entity_priorities",
        "displayName": "Priorities of specefleet entity types",
        "description": "Priorities of specefleet entity types",
        "scopeFilter": "true",
        "entityPriorityOrder": {
            "spacefleet:spacecraft": "10",
            "spacefleet:bridge": "11",
            "spacefleet:sick_bay": "12",
            "spacefleet:mess_hall": "13",
            "spacefleet:intercom": "14",
            "spacefleet:shield": "15",
            "spacefleet:torpedo_tube": "16",
            "spacefleet:torpedo": "17",
            "spacefleet:warp_drive": "18"
        }
    }
]

Space Fleet includes the fmm:entityPriority object in its manifest, spacefleet/manifest.json, in the dependencies and objects arrays:

  1. In the dependencies array, line 3 pulls in the fmm component, which is what the fmm:entityPriority object depends on:

    json
    Copy"dependencies": [
    "dashui",
    "fmm",
    "k8s",
    "zodiac",
    "codex",
    "healthrule",
    "iam"
]

  2. In the objects array, these lines pull in the definition of Space Fleet's fmm:entityPriority object:

    json
    Copy"objects": [
    {
        "type": "fmm:entityPriority",
        "objectsFile": "objects/fmm/topology/entity-priority.json"
    }
]

Metric Mapping

Every metric represented in an OTLP Metric payload has a unique name. When ingesting this OTLP Metric payload, the Cisco Observability Platform uses the OTLP Metric name and type as an identifier to find an equivalent Cisco Observability Platform Metric across all solutions subscribed by a given Tenant. If a match is found, the data point is automatically associated with the respective Cisco Observability Platform Metric. There will be situations where the simple name/type combination is not enough to identify the Cisco Observability Platform Metric that you want to associate the data point to. In this case, you can specify a fmm:metricMapping configuration to define the mapping rules between OTLP packet and all the Cisco Observability Platform metrics defined within a solution’s domain. The number of fmm:metricMapping configurations in your solution really depends on the number of different criteria (defined in the scopeFilter attribute) required to cover the different Cisco Observability Platform Metrics that can’t be simply mapped by the name/type identifier.

Space Fleet does not define an fmm:metricMapping configuration.

Learn More

Next