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:entityPriority

Description

Note: This configuration is deprecated and will be replaced by a CNCF Serverless Workflow configuration.
Note: You must get this definition reviewed and approved by Cisco AppDynamics before including it in your solution.

The fmm:entityPriority object defines what association rule takes precedence when there are multiple rules that apply to an entity.

Syntax

{
  "namespace": "<object>",
  "kind": "entity",
  "name": "<rule-name>",
  "displayName": "<rule-name-for-UI>",
  "description": "<description-of-configuration>",
  "scopeFilter": {
    "description": "<filter-expression>"
  },
  "entityPriorityOrder": {
    "type": "object",
    "description": "<description-of-order-object",
    "properties": {
      "type": "object",
      "description": "<deprecated-description>",
      "additionalProperties": {
        "type": "string"
      },
      "examples": [
        {
          "k8s:container": "2",
          "k8s:pod": "1",
          "apm:service_instance": "-3"
        }
      ]
    }
  },
  "entityPriorities": {
    "type": "object",
    "description": "A map of entityType to priority",
    "properties": {
      "type": "object",
      "description": "A map of string:int. LHS represents the entityType. RHS represents priority of the entityType",
      "additionalProperties": {
        "type": "integer"
      },
      "examples": [
        {
          "k8s:container": 2,
          "k8s:pod": 1,
          "apm:service_instance": -3
        }
      ]
    }
  },
  "required": [
    "scopeFilter"
  ]
}

Attributes

Attribute Description
namespace The name of the domain ( fmm:namespace object) that this configuration belongs to.
kind The data type of this configuration. Set this to entityPriority.
name The name of this configuration within the context of the namespace. Must be unique within a solution. Can contain only alphanumeric characters, underscores, or hyphens.
displayName The name of this configuration as it will appear in the user interface.
description Description of this configuration.
scopeFilter Required. A filter expression which is matched against an input OpenTelemetry packet.
Predefined variables: source (source of the data), meltType (MELT type of the data), resourceAttributes (refers to the OTLP packet's resource attributes).
Predefined functions:
• boolean containsAll(resourceAttributes, String[] names)
• boolean matchAny(resourceAttributes, String[] names)
• KeyValue getAttributes(resourceAttributes, String name)
getValue(resourceAttributes, attributeName)
entityPriorityOrder A map of entityType to priority. Lower numbers have higher priority. Priority can be negative. Include either entityPriorities or entityPriorityOrder, but not both.
entityPriorities A map of entityType to priority. Lower numbers have higher priority. Priority can be negative. Include either entityPriorities or entityPriorityOrder, but not both.

Example

{
  "namespace": {
    "name": "k8s",
    "version": 1
  },
  "kind": "entityPriority",
  "name": "k8s_entity_priorities",
  "displayName": "Kubernetes Entity Priorities",
  "description": "Kubernetes Entity Priorities",
  "scopeFilter": "'infra'.equals(source)",
  "entityPriorities": {
    "k8s:container": 1,
    "k8s:pod": 2
  }
}