path: root/dpo/data-formats/VES-4.27.2-dataformat.json

{
  "self": {
    "name": "VES_specification",
    "version": "4.27.2",
    "description": "VES spec from v4.1 and 27.2 spec"
  },
  "dataformatversion": "1.0.0",
  "jsonschema": {
    "$schema": "http://json-schema.org/draft-04/schema#",
    "definitions": {
      "schemaLicenseAndCopyrightNotice": {
        "description": "Copyright (c) 2017, AT&T Intellectual Property.  All rights reserved",
        "type": "object",
        "properties": {
          "apacheLicense2.0": {
            "description": "Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at:",
            "type": "string"
          },
          "licenseUrl": {
            "description": "http://www.apache.org/licenses/LICENSE-2.0",
            "type": "string"
          },
          "asIsClause": {
            "description": "Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.",
            "type": "string"
          },
          "permissionsAndLimitations": {
            "description": "See the License for the specific language governing permissions and limitations under the License.",
            "type": "string"
          }
        }
      },
      "codecsInUse": {
        "description": "number of times an identified codec was used over the measurementInterval",
        "type": "object",
        "properties": {
          "codecIdentifier": {
            "type": "string"
          },
          "numberInUse": {
            "type": "number"
          }
        },
        "required": [
          "codecIdentifier",
          "numberInUse"
        ]
      },
      "command": {
        "description": "command from an event collector toward an event source",
        "type": "object",
        "properties": {
          "commandType": {
            "type": "string",
            "enum": [
              "heartbeatIntervalChange",
              "measurementIntervalChange",
              "provideThrottlingState",
              "throttlingSpecification"
            ]
          },
          "eventDomainThrottleSpecification": {
            "$ref": "#/definitions/eventDomainThrottleSpecification"
          },
          "measurementInterval": {
            "type": "number"
          }
        },
        "required": [
          "commandType"
        ]
      },
      "commandList": {
        "description": "array of commands from an event collector toward an event source",
        "type": "array",
        "items": {
          "$ref": "#/definitions/commandListEntry"
        },
        "minItems": 0
      },
      "commandListEntry": {
        "description": "reference to a command object",
        "type": "object",
        "properties": {
          "command": {
            "$ref": "#/definitions/command"
          }
        },
        "required": [
          "command"
        ]
      },
      "commonEventHeader": {
        "description": "fields common to all events",
        "type": "object",
        "properties": {
          "domain": {
            "description": "the eventing domain associated with the event",
            "type": "string",
            "enum": [
              "fault",
              "heartbeat",
              "measurementsForVfScaling",
              "mobileFlow",
              "other",
              "stateChange",
              "syslog",
              "thresholdCrossingAlert"
            ]
          },
          "eventId": {
            "description": "event key that is unique to the event source",
            "type": "string"
          },
          "eventType": {
            "description": "unique event topic name",
            "type": "string"
          },
          "functionalRole": {
            "description": "function of the event source e.g., eNodeB, MME, PCRF",
            "type": "string"
          },
          "internalHeaderFields": {
            "$ref": "#/definitions/internalHeaderFields"
          },
          "lastEpochMicrosec": {
            "description": "the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
            "type": "number"
          },
          "priority": {
            "description": "processing priority",
            "type": "string",
            "enum": [
              "High",
              "Medium",
              "Normal",
              "Low"
            ]
          },
          "reportingEntityId": {
            "description": "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process",
            "type": "string"
          },
          "reportingEntityName": {
            "description": "name of the entity reporting the event, for example, an OAM VM",
            "type": "string"
          },
          "sequence": {
            "description": "ordering of events communicated by an event source instance or 0 if not needed",
            "type": "integer"
          },
          "sourceId": {
            "description": "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process",
            "type": "string"
          },
          "sourceName": {
            "description": "name of the entity experiencing the event issue",
            "type": "string"
          },
          "startEpochMicrosec": {
            "description": "the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
            "type": "number"
          },
          "version": {
            "description": "version of the event header",
            "type": "number"
          }
        },
        "required": [
          "domain",
          "eventId",
          "functionalRole",
          "lastEpochMicrosec",
          "priority",
          "reportingEntityName",
          "sequence",
          "sourceName",
          "startEpochMicrosec"
        ]
      },
      "counter": {
        "description": "performance counter",
        "type": "object",
        "properties": {
          "criticality": {
            "type": "string",
            "enum": [
              "CRIT",
              "MAJ"
            ]
          },
          "name": {
            "type": "string"
          },
          "thresholdCrossed": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "criticality",
          "name",
          "thresholdCrossed",
          "value"
        ]
      },
      "cpuUsage": {
        "description": "percent usage of an identified CPU",
        "type": "object",
        "properties": {
          "cpuIdentifier": {
            "type": "string"
          },
          "percentUsage": {
            "type": "number"
          }
        },
        "required": [
          "cpuIdentifier",
          "percentUsage"
        ]
      },
      "errors": {
        "description": "receive and transmit errors for the measurements domain",
        "type": "object",
        "properties": {
          "receiveDiscards": {
            "type": "number"
          },
          "receiveErrors": {
            "type": "number"
          },
          "transmitDiscards": {
            "type": "number"
          },
          "transmitErrors": {
            "type": "number"
          }
        },
        "required": [
          "receiveDiscards",
          "receiveErrors",
          "transmitDiscards",
          "transmitErrors"
        ]
      },
      "event": {
        "description": "the root level of the common event format",
        "type": "object",
        "properties": {
          "commonEventHeader": {
            "$ref": "#/definitions/commonEventHeader"
          },
          "faultFields": {
            "$ref": "#/definitions/faultFields"
          },
          "measurementsForVfScalingFields": {
            "$ref": "#/definitions/measurementsForVfScalingFields"
          },
          "mobileFlowFields": {
            "$ref": "#/definitions/mobileFlowFields"
          },
          "otherFields": {
            "$ref": "#/definitions/otherFields"
          },
          "stateChangeFields": {
            "$ref": "#/definitions/stateChangeFields"
          },
          "syslogFields": {
            "$ref": "#/definitions/syslogFields"
          },
          "thresholdCrossingAlertFields": {
            "$ref": "#/definitions/thresholdCrossingAlertFields"
          }
        },
        "required": [
          "commonEventHeader"
        ]
      },
      "eventDomainThrottleSpecification": {
        "description": "specification of what information to suppress within an event domain",
        "type": "object",
        "properties": {
          "eventDomain": {
            "description": "Event domain enum from the commonEventHeader domain field",
            "type": "string"
          },
          "suppressedFieldNames": {
            "description": "List of optional field names in the event block that should not be sent to the Event Listener",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "suppressedNvPairsList": {
            "description": "Optional list of specific NvPairsNames to suppress within a given Name-Value Field",
            "type": "array",
            "items": {
              "$ref": "#/definitions/suppressedNvPairs"
            }
          }
        },
        "required": [
          "eventDomain"
        ]
      },
      "eventDomainThrottleSpecificationList": {
        "description": "array of eventDomainThrottleSpecifications",
        "type": "array",
        "items": {
          "$ref": "#/definitions/eventDomainThrottleSpecification"
        },
        "minItems": 0
      },
      "eventList": {
        "description": "array of events",
        "type": "array",
        "items": {
          "$ref": "#/definitions/event"
        }
      },
      "eventThrottlingState": {
        "description": "reports the throttling in force at the event source",
        "type": "object",
        "properties": {
          "eventThrottlingMode": {
            "description": "Mode the event manager is in",
            "type": "string",
            "enum": [
              "normal",
              "throttled"
            ]
          },
          "eventDomainThrottleSpecificationList": {
            "$ref": "#/definitions/eventDomainThrottleSpecificationList"
          }
        },
        "required": [
          "eventThrottlingMode"
        ]
      },
      "faultFields": {
        "description": "fields specific to fault events",
        "type": "object",
        "properties": {
          "alarmAdditionalInformation": {
            "description": "additional alarm information",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "alarmCondition": {
            "description": "alarm condition reported by the device",
            "type": "string"
          },
          "alarmInterfaceA": {
            "description": "card, port, channel or interface name of the device generating the alarm",
            "type": "string"
          },
          "eventSeverity": {
            "description": "event severity or priority",
            "type": "string",
            "enum": [
              "CRITICAL",
              "MAJOR",
              "MINOR",
              "WARNING",
              "NORMAL"
            ]
          },
          "eventSourceType": {
            "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction",
            "type": "string"
          },
          "faultFieldsVersion": {
            "description": "version of the faultFields block",
            "type": "number"
          },
          "specificProblem": {
            "description": "short description of the alarm or problem",
            "type": "string"
          },
          "vfStatus": {
            "description": "virtual function status enumeration",
            "type": "string",
            "enum": [
              "Active",
              "Idle",
              "Preparing to terminate",
              "Ready to terminate",
              "Requesting termination"
            ]
          }
        },
        "required": [
          "alarmCondition",
          "eventSeverity",
          "eventSourceType",
          "specificProblem",
          "vfStatus"
        ]
      },
      "featuresInUse": {
        "description": "number of times an identified feature was used over the measurementInterval",
        "type": "object",
        "properties": {
          "featureIdentifier": {
            "type": "string"
          },
          "featureUtilization": {
            "type": "number"
          }
        },
        "required": [
          "featureIdentifier",
          "featureUtilization"
        ]
      },
      "field": {
        "description": "name value pair",
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ]
      },
      "filesystemUsage": {
        "description": "disk usage of an identified virtual machine in gigabytes and/or gigabytes per second",
        "type": "object",
        "properties": {
          "blockConfigured": {
            "type": "number"
          },
          "blockIops": {
            "type": "number"
          },
          "blockUsed": {
            "type": "number"
          },
          "ephemeralConfigured": {
            "type": "number"
          },
          "ephemeralIops": {
            "type": "number"
          },
          "ephemeralUsed": {
            "type": "number"
          },
          "filesystemName": {
            "type": "string"
          }
        },
        "required": [
          "blockConfigured",
          "blockIops",
          "blockUsed",
          "ephemeralConfigured",
          "ephemeralIops",
          "ephemeralUsed",
          "filesystemName"
        ]
      },
      "gtpPerFlowMetrics": {
        "description": "Mobility GTP Protocol per flow metrics",
        "type": "object",
        "properties": {
          "avgBitErrorRate": {
            "description": "average bit error rate",
            "type": "number"
          },
          "avgPacketDelayVariation": {
            "description": "Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets",
            "type": "number"
          },
          "avgPacketLatency": {
            "description": "average delivery latency",
            "type": "number"
          },
          "avgReceiveThroughput": {
            "description": "average receive throughput",
            "type": "number"
          },
          "avgTransmitThroughput": {
            "description": "average transmit throughput",
            "type": "number"
          },
          "durConnectionFailedStatus": {
            "description": "duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval",
            "type": "number"
          },
          "durTunnelFailedStatus": {
            "description": "Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval",
            "type": "number"
          },
          "flowActivatedBy": {
            "description": "Endpoint activating the flow",
            "type": "string"
          },
          "flowActivationEpoch": {
            "description": "Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available",
            "type": "number"
          },
          "flowActivationMicrosec": {
            "description": "Integer microseconds for the start of the flow connection",
            "type": "number"
          },
          "flowActivationTime": {
            "description": "time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
            "type": "string"
          },
          "flowDeactivatedBy": {
            "description": "Endpoint deactivating the flow",
            "type": "string"
          },
          "flowDeactivationEpoch": {
            "description": "Time for the start of the flow connection, in integer UTC epoch time aka UNIX time",
            "type": "number"
          },
          "flowDeactivationMicrosec": {
            "description": "Integer microseconds for the start of the flow connection",
            "type": "number"
          },
          "flowDeactivationTime": {
            "description": "Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
            "type": "string"
          },
          "flowStatus": {
            "description": "connection status at reporting time as a working / inactive / failed indicator value",
            "type": "string"
          },
          "gtpConnectionStatus": {
            "description": "Current connection state at reporting time",
            "type": "string"
          },
          "gtpTunnelStatus": {
            "description": "Current tunnel state  at reporting time",
            "type": "string"
          },
          "ipTosCountList": {
            "description": "array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow",
            "type": "array",
            "items": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                }
              ]
            }
          },
          "ipTosList": {
            "description": "Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255'",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "largePacketRtt": {
            "description": "large packet round trip time",
            "type": "number"
          },
          "largePacketThreshold": {
            "description": "large packet threshold being applied",
            "type": "number"
          },
          "maxPacketDelayVariation": {
            "description": "Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets",
            "type": "number"
          },
          "maxReceiveBitRate": {
            "description": "maximum receive bit rate",
            "type": "number"
          },
          "maxTransmitBitRate": {
            "description": "maximum transmit bit rate",
            "type": "number"
          },
          "mobileQciCosCountList": {
            "description": "array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow",
            "type": "array",
            "items": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                }
              ]
            }
          },
          "mobileQciCosList": {
            "description": "Array of unique LTE QCI or UMTS class-of-service values observed in the flow",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "numActivationFailures": {
            "description": "Number of failed activation requests, as observed by the reporting node",
            "type": "number"
          },
          "numBitErrors": {
            "description": "number of errored bits",
            "type": "number"
          },
          "numBytesReceived": {
            "description": "number of bytes received, including retransmissions",
            "type": "number"
          },
          "numBytesTransmitted": {
            "description": "number of bytes transmitted, including retransmissions",
            "type": "number"
          },
          "numDroppedPackets": {
            "description": "number of received packets dropped due to errors per virtual interface",
            "type": "number"
          },
          "numGtpEchoFailures": {
            "description": "Number of Echo request path failures where failed paths are defined in 3GPP TS 29.281 sec 7.2.1 and 3GPP TS 29.060 sec. 11.2",
            "type": "number"
          },
          "numGtpTunnelErrors": {
            "description": "Number of tunnel error indications where errors are defined in 3GPP TS 29.281 sec 7.3.1 and 3GPP TS 29.060 sec. 11.1",
            "type": "number"
          },
          "numHttpErrors": {
            "description": "Http error count",
            "type": "number"
          },
          "numL7BytesReceived": {
            "description": "number of tunneled layer 7 bytes received, including retransmissions",
            "type": "number"
          },
          "numL7BytesTransmitted": {
            "description": "number of tunneled layer 7 bytes transmitted, excluding retransmissions",
            "type": "number"
          },
          "numLostPackets": {
            "description": "number of lost packets",
            "type": "number"
          },
          "numOutOfOrderPackets": {
            "description": "number of out-of-order packets",
            "type": "number"
          },
          "numPacketErrors": {
            "description": "number of errored packets",
            "type": "number"
          },
          "numPacketsReceivedExclRetrans": {
            "description": "number of packets received, excluding retransmission",
            "type": "number"
          },
          "numPacketsReceivedInclRetrans": {
            "description": "number of packets received, including retransmission",
            "type": "number"
          },
          "numPacketsTransmittedInclRetrans": {
            "description": "number of packets transmitted, including retransmissions",
            "type": "number"
          },
          "numRetries": {
            "description": "number of packet retries",
            "type": "number"
          },
          "numTimeouts": {
            "description": "number of packet timeouts",
            "type": "number"
          },
          "numTunneledL7BytesReceived": {
            "description": "number of tunneled layer 7 bytes received, excluding retransmissions",
            "type": "number"
          },
          "roundTripTime": {
            "description": "round trip time",
            "type": "number"
          },
          "tcpFlagCountList": {
            "description": "array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow",
            "type": "array",
            "items": {
              "type": "array",
              "items": [
                {
                  "type": "string"
                },
                {
                  "type": "number"
                }
              ]
            }
          },
          "tcpFlagList": {
            "description": "Array of unique TCP Flags observed in the flow",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "timeToFirstByte": {
            "description": "Time in milliseconds between the connection activation and first byte received",
            "type": "number"
          }
        },
        "required": [
          "avgBitErrorRate",
          "avgPacketDelayVariation",
          "avgPacketLatency",
          "avgReceiveThroughput",
          "avgTransmitThroughput",
          "flowActivationEpoch",
          "flowActivationMicrosec",
          "flowDeactivationEpoch",
          "flowDeactivationMicrosec",
          "flowDeactivationTime",
          "flowStatus",
          "maxPacketDelayVariation",
          "numActivationFailures",
          "numBitErrors",
          "numBytesReceived",
          "numBytesTransmitted",
          "numDroppedPackets",
          "numL7BytesReceived",
          "numL7BytesTransmitted",
          "numLostPackets",
          "numOutOfOrderPackets",
          "numPacketErrors",
          "numPacketsReceivedExclRetrans",
          "numPacketsReceivedInclRetrans",
          "numPacketsTransmittedInclRetrans",
          "numRetries",
          "numTimeouts",
          "numTunneledL7BytesReceived",
          "roundTripTime",
          "timeToFirstByte"
        ]
      },
      "internalHeaderFields": {
        "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
        "type": "object"
      },
      "latencyBucketMeasure": {
        "description": "number of counts falling within a defined latency bucket",
        "type": "object",
        "properties": {
          "countsInTheBucket": {
            "type": "number"
          },
          "highEndOfLatencyBucket": {
            "type": "number"
          },
          "lowEndOfLatencyBucket": {
            "type": "number"
          }
        },
        "required": [
          "countsInTheBucket"
        ]
      },
      "measurementGroup": {
        "description": "measurement group",
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "measurements": {
            "description": "array of name value pair measurements",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          }
        },
        "required": [
          "name",
          "measurements"
        ]
      },
      "measurementsForVfScalingFields": {
        "description": "measurementsForVfScaling fields",
        "type": "object",
        "properties": {
          "additionalMeasurements": {
            "description": "additional measurement fields",
            "type": "array",
            "items": {
              "$ref": "#/definitions/measurementGroup"
            }
          },
          "aggregateCpuUsage": {
            "description": "aggregate CPU usage of the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "codecUsageArray": {
            "description": "array of codecs in use",
            "type": "array",
            "items": {
              "$ref": "#/definitions/codecsInUse"
            }
          },
          "concurrentSessions": {
            "description": "peak concurrent sessions for the VM or VNF over the measurementInterval",
            "type": "number"
          },
          "configuredEntities": {
            "description": "over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF",
            "type": "number"
          },
          "cpuUsageArray": {
            "description": "usage of an array of CPUs",
            "type": "array",
            "items": {
              "$ref": "#/definitions/cpuUsage"
            }
          },
          "errors": {
            "$ref": "#/definitions/errors"
          },
          "featureUsageArray": {
            "description": "array of features in use",
            "type": "array",
            "items": {
              "$ref": "#/definitions/featuresInUse"
            }
          },
          "filesystemUsageArray": {
            "description": "filesystem usage of the VM on which the VNFC reporting the event is running",
            "type": "array",
            "items": {
              "$ref": "#/definitions/filesystemUsage"
            }
          },
          "latencyDistribution": {
            "description": "array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges",
            "type": "array",
            "items": {
              "$ref": "#/definitions/latencyBucketMeasure"
            }
          },
          "meanRequestLatency": {
            "description": "mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "measurementInterval": {
            "description": "interval over which measurements are being reported in seconds",
            "type": "number"
          },
          "measurementsForVfScalingVersion": {
            "description": "version of the measurementsForVfScaling block",
            "type": "number"
          },
          "memoryConfigured": {
            "description": "memory in MB configured in the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "memoryUsed": {
            "description": "memory usage in MB of the VM on which the VNFC reporting the event is running",
            "type": "number"
          },
          "numberOfMediaPortsInUse": {
            "description": "number of media ports in use",
            "type": "number"
          },
          "requestRate": {
            "description": "peak rate of service requests per second to the VNF over the measurementInterval",
            "type": "number"
          },
          "vnfcScalingMetric": {
            "description": "represents busy-ness of the VNF from 0 to 100 as reported by the VNFC",
            "type": "number"
          },
          "vNicUsageArray": {
            "description": "usage of an array of virtual network interface cards",
            "type": "array",
            "items": {
              "$ref": "#/definitions/vNicUsage"
            }
          }
        },
        "required": [
          "measurementInterval"
        ]
      },
      "mobileFlowFields": {
        "description": "mobileFlow fields",
        "type": "object",
        "properties": {
          "additionalFields": {
            "description": "additional mobileFlow fields if needed",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "applicationType": {
            "description": "Application type inferred",
            "type": "string"
          },
          "appProtocolType": {
            "description": "application protocol",
            "type": "string"
          },
          "appProtocolVersion": {
            "description": "application protocol version",
            "type": "string"
          },
          "cid": {
            "description": "cell id",
            "type": "string"
          },
          "connectionType": {
            "description": "Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc",
            "type": "string"
          },
          "ecgi": {
            "description": "Evolved Cell Global Id",
            "type": "string"
          },
          "flowDirection": {
            "description": "Flow direction, indicating if the reporting node is the source of the flow or destination for the flow",
            "type": "string"
          },
          "gtpPerFlowMetrics": {
            "$ref": "#/definitions/gtpPerFlowMetrics"
          },
          "gtpProtocolType": {
            "description": "GTP protocol",
            "type": "string"
          },
          "gtpVersion": {
            "description": "GTP protocol version",
            "type": "string"
          },
          "httpHeader": {
            "description": "HTTP request header, if the flow connects to a node referenced by HTTP",
            "type": "string"
          },
          "imei": {
            "description": "IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device",
            "type": "string"
          },
          "imsi": {
            "description": "IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device",
            "type": "string"
          },
          "ipProtocolType": {
            "description": "IP protocol type e.g., TCP, UDP, RTP...",
            "type": "string"
          },
          "ipVersion": {
            "description": "IP protocol version e.g., IPv4, IPv6",
            "type": "string"
          },
          "lac": {
            "description": "location area code",
            "type": "string"
          },
          "mcc": {
            "description": "mobile country code",
            "type": "string"
          },
          "mnc": {
            "description": "mobile network code",
            "type": "string"
          },
          "mobileFlowFieldsVersion": {
            "description": "version of the mobileFlowFields block",
            "type": "number"
          },
          "msisdn": {
            "description": "MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device",
            "type": "string"
          },
          "otherEndpointIpAddress": {
            "description": "IP address for the other endpoint, as used for the flow being reported on",
            "type": "string"
          },
          "otherEndpointPort": {
            "description": "IP Port for the reporting entity, as used for the flow being reported on",
            "type": "number"
          },
          "otherFunctionalRole": {
            "description": "Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...",
            "type": "string"
          },
          "rac": {
            "description": "routing area code",
            "type": "string"
          },
          "radioAccessTechnology": {
            "description": "Radio Access Technology e.g., 2G, 3G, LTE",
            "type": "string"
          },
          "reportingEndpointIpAddr": {
            "description": "IP address for the reporting entity, as used for the flow being reported on",
            "type": "string"
          },
          "reportingEndpointPort": {
            "description": "IP port for the reporting entity, as used for the flow being reported on",
            "type": "number"
          },
          "sac": {
            "description": "service area code",
            "type": "string"
          },
          "samplingAlgorithm": {
            "description": "Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied",
            "type": "number"
          },
          "tac": {
            "description": "transport area code",
            "type": "string"
          },
          "tunnelId": {
            "description": "tunnel identifier",
            "type": "string"
          },
          "vlanId": {
            "description": "VLAN identifier used by this flow",
            "type": "string"
          }
        },
        "required": [
          "flowDirection",
          "gtpPerFlowMetrics",
          "ipProtocolType",
          "ipVersion",
          "otherEndpointIpAddress",
          "otherEndpointPort",
          "reportingEndpointIpAddr",
          "reportingEndpointPort"
        ]
      },
      "otherFields": {
        "description": "additional fields not reported elsewhere",
        "type": "array",
        "items": {
          "$ref": "#/definitions/field"
        }
      },
      "requestError": {
        "description": "standard request error data structure",
        "type": "object",
        "properties": {
          "messageId": {
            "description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception",
            "type": "string"
          },
          "text": {
            "description": "Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1",
            "type": "string"
          },
          "url": {
            "description": "Hyperlink to a detailed error resource e.g., an HTML page for browser user agents",
            "type": "string"
          },
          "variables": {
            "description": "List of zero or more strings that represent the contents of the variables used by the message text",
            "type": "string"
          }
        },
        "required": [
          "messageId",
          "text"
        ]
      },
      "stateChangeFields": {
        "description": "stateChange fields",
        "type": "object",
        "properties": {
          "additionalFields": {
            "description": "additional stateChange fields if needed",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "newState": {
            "description": "new state of the entity",
            "type": "string",
            "enum": [
              "inService",
              "maintenance",
              "outOfService"
            ]
          },
          "oldState": {
            "description": "previous state of the entity",
            "type": "string",
            "enum": [
              "inService",
              "maintenance",
              "outOfService"
            ]
          },
          "stateChangeFieldsVersion": {
            "description": "version of the stateChangeFields block",
            "type": "number"
          },
          "stateInterface": {
            "description": "card or port name of the entity that changed state",
            "type": "string"
          }
        },
        "required": [
          "newState",
          "oldState",
          "stateInterface"
        ]
      },
      "suppressedNvPairs": {
        "description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling",
        "type": "object",
        "properties": {
          "nvPairFieldName": {
            "description": "Name of the field within which are the nvpair names to suppress",
            "type": "string"
          },
          "suppressedNvPairNames": {
            "description": "Array of nvpair names to suppress within the nvpairFieldName",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "nvPairFieldName",
          "suppressedNvPairNames"
        ]
      },
      "syslogFields": {
        "description": "sysLog fields",
        "type": "object",
        "properties": {
          "additionalFields": {
            "description": "additional syslog fields if needed",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "eventSourceHost": {
            "description": "hostname of the device",
            "type": "string"
          },
          "eventSourceType": {
            "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction",
            "type": "string"
          },
          "syslogFacility": {
            "description": "numeric code from 0 to 23 for facility--see table in documentation",
            "type": "number"
          },
          "syslogFieldsVersion": {
            "description": "version of the syslogFields block",
            "type": "number"
          },
          "syslogMsg": {
            "description": "syslog message",
            "type": "string"
          },
          "syslogPri": {
            "description": "0-192 combined severity and facility",
            "type": "number"
          },
          "syslogProc": {
            "description": "identifies the application that originated the message",
            "type": "string"
          },
          "syslogProcId": {
            "description": "a change in the value of this field indicates a discontinuity in syslog reporting",
            "type": "number"
          },
          "syslogSData": {
            "description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs",
            "type": "string"
          },
          "syslogSdId": {
            "description": "0-32 char in format name@number for example ourSDID@32473",
            "type": "string"
          },
          "syslogSev": {
            "description": "numerical Code for  severity derived from syslogPri as remaider of syslogPri / 8",
            "type": "string"
          },
          "syslogTag": {
            "description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided",
            "type": "string"
          },
          "syslogVer": {
            "description": "IANA assigned version of the syslog protocol specification - typically 1",
            "type": "number"
          }
        },
        "required": [
          "eventSourceType",
          "syslogMsg",
          "syslogTag"
        ]
      },
      "thresholdCrossingAlertFields": {
        "description": "fields specific to threshold crossing alert events",
        "type": "object",
        "properties": {
          "additionalFields": {
            "description": "additional threshold crossing alert fields if needed",
            "type": "array",
            "items": {
              "$ref": "#/definitions/field"
            }
          },
          "additionalParameters": {
            "description": "performance counters",
            "type": "array",
            "items": {
              "$ref": "#/definitions/counter"
            }
          },
          "alertAction": {
            "description": "Event action",
            "type": "string",
            "enum": [
              "CLEAR",
              "CONT",
              "SET"
            ]
          },
          "alertDescription": {
            "description": "Unique short alert description such as IF-SHUB-ERRDROP",
            "type": "string"
          },
          "alertType": {
            "description": "Event type",
            "type": "string",
            "enum": [
              "CARD-ANOMALY",
              "ELEMENT-ANOMALY",
              "INTERFACE-ANOMALY",
              "SERVICE-ANOMALY"
            ]
          },
          "alertValue": {
            "description": "Calculated API value (if applicable)",
            "type": "string"
          },
          "associatedAlertIdList": {
            "description": "List of eventIds associated with the event being reported",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "collectionTimestamp": {
            "description": "Time when the performance collector picked up the data; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
            "type": "string"
          },
          "dataCollector": {
            "description": "Specific performance collector instance used",
            "type": "string"
          },
          "elementType": {
            "description": "type of network element - internal ATT field",
            "type": "string"
          },
          "eventSeverity": {
            "description": "event severity or priority",
            "type": "string",
            "enum": [
              "CRITICAL",
              "MAJOR",
              "MINOR",
              "WARNING",
              "NORMAL"
            ]
          },
          "eventStartTimestamp": {
            "description": "Time closest to when the measurement was made; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800",
            "type": "string"
          },
          "interfaceName": {
            "description": "Physical or logical port or card (if applicable)",
            "type": "string"
          },
          "networkService": {
            "description": "network name - internal ATT field",
            "type": "string"
          },
          "possibleRootCause": {
            "description": "Reserved for future use",
            "type": "string"
          },
          "thresholdCrossingFieldsVersion": {
            "description": "version of the thresholdCrossingAlertFields block",
            "type": "number"
          }
        },
        "required": [
          "additionalParameters",
          "alertAction",
          "alertDescription",
          "alertType",
          "collectionTimestamp",
          "eventSeverity",
          "eventStartTimestamp"
        ]
      },
      "vNicUsage": {
        "description": "usage of identified virtual network interface card",
        "type": "object",
        "properties": {
          "broadcastPacketsIn": {
            "type": "number"
          },
          "broadcastPacketsOut": {
            "type": "number"
          },
          "bytesIn": {
            "type": "number"
          },
          "bytesOut": {
            "type": "number"
          },
          "multicastPacketsIn": {
            "type": "number"
          },
          "multicastPacketsOut": {
            "type": "number"
          },
          "packetsIn": {
            "type": "number"
          },
          "packetsOut": {
            "type": "number"
          },
          "unicastPacketsIn": {
            "type": "number"
          },
          "unicastPacketsOut": {
            "type": "number"
          },
          "vNicIdentifier": {
            "type": "string"
          }
        },
        "required": [
          "bytesIn",
          "bytesOut",
          "packetsIn",
          "packetsOut",
          "vNicIdentifier"
        ]
      }
    },
    "title": "Event Listener",
    "type": "object",
    "properties": {
      "event": {
        "$ref": "#/definitions/event"
      }
    },
    "eventList": {
      "$ref": "#/definitions/eventList"
    }
  }
}