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

Description

fmm:event defines how to map OTLP events into entity attributes.

Syntax

{
  "namespace": "<object>",
  "kind": "event",
  "name": "<event-name>",
  "displayName": "<event-name-for-UI>",
  "description": "<event-description>",
  "attributeDefinitions": {
    "attributes": {
      "reason": {
        "type": "string"
      },
      "severity": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "subtype": {
        "description": "<subtype-description>",
        "type": "string",
        "enum": [
          "native",
          "custom"
        ]
      }
    }
  }
}

Attributes

Attribute	Description
`namespace`	Required. The name of the domain (`fmm:namespace` object) that this event belongs to.
`kind`	Required. A valid `fmm` type. Set this to `event`.
`name`	Required. Event name. Must be unique within a solution. Must contain only alphanumeric characters, underscores, or hyphens.
`displayName`	Required. Event name as displayed in the user interface.
`description`	Description of event.
`attributeDefinitions`	Required. Must specify `attributes`: • `reason` - Event reason • `severity` - Event severity • `description` - Event description • `subtype` - Event subtype

Example

{
  "kind": "event",
  "namespace": {
    "name": "stores",
    "version": 1
  },
  "name": "card_in",
  "displayName": "Card IN",
  "description": "A card is in the ATM",
  "attributeDefinitions": {
    "attributes": {
      "reason": {
        "type": "string"
      },
      "severity": {
        "type": "string"
      },
      "description": {
        "type": "string"
      },
      "subtype": {
        "description": "atm event collection and generation method",
        "type": "string",
        "enum": [
          "native",
          "custom"
        ]
      }
    }
  }
}