diff options
| author |   Lovett, Trevor <trevor.lovett@att.com> | 2019-05-24 08:25:35 -0500 |
|---|---|---|
| committer | Lovett, Trevor <trevor.lovett@att.com> | 2019-05-24 08:25:35 -0500 |
| commit | f6518999bced8876bc914b1cede63fce45e0a85f (patch) | |
| tree | 66a8d9d62cb7181ff261466b7db29045a7890eaf /docs | |
| parent | bc72d112aa72968b21f8e7270e02510ff52d99a3 (diff) | |
Removing VES specs from VNFSDK docs
Issue-ID: VNFSDK-409
Signed-off-by: Lovett, Trevor <trevor.lovett@att.com>
Change-Id: I420b6a9845bb8c65167fff81e7b6631578e51b4e
Diffstat (limited to 'docs')
22 files changed, 0 insertions, 42028 deletions
diff --git a/docs/files/CommonEventFormat_29.json b/docs/files/CommonEventFormat_29.json deleted file mode 100644 index d7419e8..0000000 --- a/docs/files/CommonEventFormat_29.json +++ /dev/null @@ -1,2310 +0,0 @@ -{
- "$schema": "http://json-schema.org/draft-04/schema#",
- "title": "VES Event Listener Common Event Format",
- "type": "object",
- "properties": {
- "event": {"$ref": "#/definitions/event"},
- "eventList": {"$ref": "#/definitions/eventList"}
- },
-
- "definitions": {
- "schemaHeaderBlock": {
- "description": "schema date, version, author and associated API",
- "type": "object",
- "properties": {
- "associatedApi": {
- "description": "VES Event Listener",
- "type": "string"
- },
- "lastUpdatedBy": {
- "description": "re2947",
- "type": "string"
- },
- "schemaDate": {
- "description": "June 28, 2018",
- "type": "string"
- },
- "schemaVersion": {
- "description": "29.0",
- "type": "number"
- }
- }
- },
- "schemaLicenseAndCopyrightNotice": {
- "description": "Copyright (c) 2018, 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"
- }
- }
- },
- "arrayOfJsonObject": {
- "description": "array of json objects described by name, schema and other meta-information",
- "type": "array",
- "items": {
- "$ref": "#/definitions/jsonObject"
- }
- },
- "arrayOfNamedHashMap": {
- "description": "array of named hashMaps",
- "type": "array",
- "items": {
- "$ref": "#/definitions/namedHashMap"
- }
- },
- "codecsInUse": {
- "description": "number of times an identified codec was used over the measurementInterval",
- "type": "object",
- "properties": {
- "codecIdentifier": { "type": "string" },
- "numberInUse": { "type": "integer" }
- },
- "required": [ "codecIdentifier", "numberInUse" ]
- },
- "commonEventHeader": {
- "description": "fields common to all events",
- "type": "object",
- "properties": {
- "domain": {
- "description": "the eventing domain associated with the event",
- "type": "string",
- "enum": [
- "fault",
- "heartbeat",
- "measurement",
- "mobileFlow",
- "notification",
- "other",
- "pnfRegistration",
- "sipSignaling",
- "stateChange",
- "syslog",
- "thresholdCrossingAlert",
- "voiceQuality"
- ]
- },
- "eventId": {
- "description": "event key that is unique to the event source",
- "type": "string"
- },
- "eventName": {
- "description": "unique event name",
- "type": "string"
- },
- "eventType": {
- "description": "for example - applicationNf, guestOS, hostOS, platform",
- "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"
- },
- "nfcNamingCode": {
- "description": "3 character network function component type, aligned with vfc naming standards",
- "type": "string"
- },
- "nfNamingCode": {
- "description": "4 character network function type, aligned with nf naming standards",
- "type": "string"
- },
- "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 EMS name; may be the same as sourceName",
- "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"
- },
- "timeZoneOffset": {
- "description": "offset to GMT to indicate local time zone for the device",
- "type": "number"
- },
- "version": {
- "description": "version of the event header",
- "type": "number"
- }
- },
- "required": [ "domain", "eventId", "eventName", "lastEpochMicrosec",
- "priority", "reportingEntityName", "sequence", "sourceName",
- "startEpochMicrosec", "version" ]
- },
- "counter": {
- "description": "performance counter",
- "type": "object",
- "properties": {
- "criticality": { "type": "string", "enum": [ "CRIT", "MAJ" ] },
- "hashMap": { "$ref": "#/definitions/hashMap" },
- "thresholdCrossed": { "type": "string" }
- },
- "required": [ "criticality", "hashMap", "thresholdCrossed" ]
- },
- "cpuUsage": {
- "description": "usage of an identified CPU",
- "type": "object",
- "properties": {
- "cpuCapacityContention": {
- "description": "the amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuDemandAvg": {
- "description": "the total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuDemandMhz": {
- "description": "CPU demand in megahertz",
- "type": "number"
- },
- "cpuDemandPct": {
- "description": "CPU demand as a percentage of the provisioned capacity",
- "type": "number"
- },
- "cpuIdentifier": {
- "description": "cpu identifer",
- "type": "string"
- },
- "cpuIdle": {
- "description": "percentage of CPU time spent in the idle task",
- "type": "number"
- },
- "cpuLatencyAvg": {
- "description": "percentage of time the VM is unable to run because it is contending for access to the physical CPUs",
- "type": "number"
- },
- "cpuOverheadAvg": {
- "description": "the overhead demand above available allocations and reservations, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuSwapWaitTime": {
- "description": "swap wait time. in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuUsageInterrupt": {
- "description": "percentage of time spent servicing interrupts",
- "type": "number"
- },
- "cpuUsageNice": {
- "description": "percentage of time spent running user space processes that have been niced",
- "type": "number"
- },
- "cpuUsageSoftIrq": {
- "description": "percentage of time spent handling soft irq interrupts",
- "type": "number"
- },
- "cpuUsageSteal": {
- "description": "percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing",
- "type": "number"
- },
- "cpuUsageSystem": {
- "description": "percentage of time spent on system tasks running the kernel",
- "type": "number"
- },
- "cpuUsageUser": {
- "description": "percentage of time spent running un-niced user space processes",
- "type": "number"
- },
- "cpuWait": {
- "description": "percentage of CPU time spent waiting for I/O operations to complete",
- "type": "number"
- },
- "percentUsage": {
- "description": "aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running",
- "type": "number"
- }
- },
- "required": [ "cpuIdentifier", "percentUsage" ]
- },
- "diskUsage": {
- "description": "usage of an identified disk",
- "type": "object",
- "properties": {
- "diskBusResets": {
- "description": "number of bus resets over the measurementInterval",
- "type": "number"
- },
- "diskCommandsAborted": {
- "description": "number of disk commands aborted over the measurementInterval",
- "type": "number"
- },
- "diskCommandsAvg": {
- "description": "average number of commands per second over the measurementInterval",
- "type": "number"
- },
- "diskFlushRequests": {
- "description": "total flush requests of the disk cache over the measurementInterval",
- "type": "number"
- },
- "diskFlushTime": {
- "description": "milliseconds spent on disk cache flushing over the measurementInterval",
- "type": "number"
- },
- "diskIdentifier": {
- "description": "disk identifier",
- "type": "string"
- },
- "diskIoTimeAvg": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval",
- "type": "number"
- },
- "diskIoTimeLast": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskIoTimeMax": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskIoTimeMin": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadAvg": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadLast": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadMax": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadMin": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteAvg": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteLast": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteMax": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteMin": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadAvg": {
- "description": "number of octets per second read from a disk or partition; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadLast": {
- "description": "number of octets per second read from a disk or partition; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadMax": {
- "description": "number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadMin": {
- "description": "number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteAvg": {
- "description": "number of octets per second written to a disk or partition; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteLast": {
- "description": "number of octets per second written to a disk or partition; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteMax": {
- "description": "number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteMin": {
- "description": "number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadAvg": {
- "description": "number of read operations per second issued to the disk; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadLast": {
- "description": "number of read operations per second issued to the disk; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadMax": {
- "description": "number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadMin": {
- "description": "number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteAvg": {
- "description": "number of write operations per second issued to the disk; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteLast": {
- "description": "number of write operations per second issued to the disk; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteMax": {
- "description": "number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteMin": {
- "description": "number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsAvg": {
- "description": "queue size of pending I/O operations per second; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsLast": {
- "description": "queue size of pending I/O operations per second; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsMax": {
- "description": "queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsMin": {
- "description": "queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskReadCommandsAvg": {
- "description": "average number of read commands issued per second to the disk over the measurementInterval",
- "type": "number"
- },
- "diskTime": {
- "description": "nanoseconds spent on disk cache reads/writes within the measurement interval",
- "type": "number"
- },
- "diskTimeReadAvg": {
- "description": "milliseconds a read operation took to complete; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadLast": {
- "description": "milliseconds a read operation took to complete; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadMax": {
- "description": "milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadMin": {
- "description": "milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteAvg": {
- "description": "milliseconds a write operation took to complete; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteLast": {
- "description": "milliseconds a write operation took to complete; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteMax": {
- "description": "milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteMin": {
- "description": "milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskTotalReadLatencyAvg": {
- "description": "average read time from the perspective of a Guest OS: sum of the Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval",
- "type": "number"
- },
- "diskTotalWriteLatencyAvg": {
- "description": "average write time from the perspective of a Guest OS: sum of the Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval",
- "type": "number"
- },
- "diskWriteCommandsAvg": {
- "description": "average number of write commands issued per second to the disk over the measurementInterval",
- "type": "number"
- }
- },
- "required": [ "diskIdentifier" ]
- },
- "endOfCallVqmSummaries": {
- "description": "provides end of call voice quality metrics",
- "type": "object",
- "properties": {
- "adjacencyName": {
- "description": " adjacency name",
- "type": "string"
- },
- "endpointAverageJitter": {
- "description": "endpoint average jitter",
- "type": "number"
- },
- "endpointDescription": {
- "description": "either Caller or Callee",
- "type": "string",
- "enum": ["Caller", "Callee"]
- },
- "endpointMaxJitter": {
- "description": "endpoint maximum jitter",
- "type": "number"
- },
- "endpointRtpOctetsDiscarded": {
- "description": "",
- "type": "number"
- },
- "endpointRtpOctetsLost": {
- "description": "endpoint RTP octets lost",
- "type": "number"
- },
- "endpointRtpOctetsReceived": {
- "description": "",
- "type": "number"
- },
- "endpointRtpOctetsSent": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsDiscarded": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsLost": {
- "description": "endpoint RTP packets lost",
- "type": "number"
- },
- "endpointRtpPacketsReceived": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsSent": {
- "description": "",
- "type": "number"
- },
- "localAverageJitter": {
- "description": "Local average jitter",
- "type": "number"
- },
- "localAverageJitterBufferDelay": {
- "description": "Local average jitter delay",
- "type": "number"
- },
- "localMaxJitter": {
- "description": "Local maximum jitter",
- "type": "number"
- },
- "localMaxJitterBufferDelay": {
- "description": "Local maximum jitter delay",
- "type": "number"
- },
- "localRtpOctetsDiscarded": {
- "description": "",
- "type": "number"
- },
- "localRtpOctetsLost": {
- "description": "Local RTP octets lost",
- "type": "number"
- },
- "localRtpOctetsReceived": {
- "description": "",
- "type": "number"
- },
- "localRtpOctetsSent": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsDiscarded": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsLost": {
- "description": "Local RTP packets lost",
- "type": "number"
- },
- "localRtpPacketsReceived": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsSent": {
- "description": "",
- "type": "number"
- },
- "mosCqe": {
- "description": "1-5 1dp",
- "type": "number"
- },
- "oneWayDelay": {
- "description": "one-way path delay in milliseconds",
- "type": "number"
- },
- "packetLossPercent": {
- "description" : "Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)",
- "type": "number"
- },
- "rFactor": {
- "description": "0-100",
- "type": "number"
- },
- "roundTripDelay": {
- "description": "millisecs",
- "type": "number"
- }
- },
- "required": [ "adjacencyName", "endpointDescription" ]
- },
- "event": {
- "description": "the root level of the common event format",
- "type": "object",
- "properties": {
- "commonEventHeader": { "$ref": "#/definitions/commonEventHeader" },
- "faultFields": { "$ref": "#/definitions/faultFields" },
- "heartbeatFields": { "$ref": "#/definitions/heartbeatFields" },
- "measurementFields": { "$ref": "#/definitions/measurementFields" },
- "mobileFlowFields": { "$ref": "#/definitions/mobileFlowFields" },
- "notificationFields": { "$ref": "#/definitions/notificationFields" },
- "otherFields": { "$ref": "#/definitions/otherFields" },
- "pnfRegistrationFields": { "$ref": "#/definitions/pnfRegistrationFields" },
- "sipSignalingFields": { "$ref": "#/definitions/sipSignalingFields" },
- "stateChangeFields": { "$ref": "#/definitions/stateChangeFields" },
- "syslogFields": { "$ref": "#/definitions/syslogFields" },
- "thresholdCrossingAlertFields": { "$ref": "#/definitions/thresholdCrossingAlertFields" },
- "voiceQualityFields": { "$ref": "#/definitions/voiceQualityFields" }
- },
- "required": [ "commonEventHeader" ]
- },
- "eventList": {
- "description": "array of events",
- "type": "array",
- "items": {
- "$ref": "#/definitions/event"
- }
- },
- "faultFields": {
- "description": "fields specific to fault events",
- "type": "object",
- "properties": {
- "alarmAdditionalInformation": { "$ref": "#/definitions/hashMap" },
- "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"
- },
- "eventCategory": {
- "description": "Event category, for example: license, link, routing, security, signaling",
- "type": "string"
- },
- "eventSeverity": {
- "description": "event severity",
- "type": "string",
- "enum": [
- "CRITICAL",
- "MAJOR",
- "MINOR",
- "WARNING",
- "NORMAL"
- ]
- },
- "eventSourceType": {
- "description": "type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, 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",
- "faultFieldsVersion", "specificProblem", "vfStatus" ]
- },
- "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": { "$ref": "#/definitions/hashMap" },
- "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": { "$ref": "#/definitions/hashMap" },
- "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": { "$ref": "#/definitions/hashMap" },
- "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"
- ]
- },
- "hashMap": {
- "description": "an associative array which is an array of key:value pairs",
- "type": "object",
- "additionalProperties": { "type": "string" },
- "default": {}
- },
- "heartbeatFields": {
- "description": "optional field block for fields specific to heartbeat events",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "heartbeatFieldsVersion": {
- "description": "version of the heartbeatFields block",
- "type": "number"
- },
- "heartbeatInterval": {
- "description": "current heartbeat interval in seconds",
- "type": "integer"
- }
- },
- "required": [ "heartbeatFieldsVersion", "heartbeatInterval" ]
- },
- "hugePages": {
- "description": "metrics on system hugepages",
- "type": "object",
- "properties": {
- "bytesFree": {
- "description": "number of free hugepages in bytes",
- "type": "number"
- },
- "bytesUsed": {
- "description": "number of used hugepages in bytes",
- "type": "number"
- },
- "hugePagesIdentifier": {
- "description": "hugePages identifier",
- "type": "number"
- },
- "percentFree": {
- "description": "number of free hugepages in percent",
- "type": "number"
- },
- "percentUsed": {
- "description": "number of free hugepages in percent",
- "type": "number"
- },
- "vmPageNumberFree": {
- "description": "number of free vmPages in numbers",
- "type": "number"
- },
- "vmPageNumberUsed": {
- "description": "number of used vmPages in numbers",
- "type": "number"
- }
- },
- "required": [ "hugePagesIdentifier" ]
- },
- "internalHeaderFields": {
- "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
- "type": "object"
- },
- "ipmi": {
- "description": "intelligent platform management interface metrics",
- "type": "object",
- "properties": {
- "exitAirTemperature": {
- "description": "system fan exit air flow temperature in celsius",
- "type": "number"
- },
- "frontPanelTemperature": {
- "description": "front panel temperature in celsius",
- "type": "number"
- },
- "ioModuleTemperature": {
- "description": "io module temperature in celsius",
- "type": "number"
- },
- "ipmiBaseboardTemperatureArray": {
- "description": "array of ipmiBaseboardTemperature objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBaseboardTemperature"
- }
- },
- "ipmiBaseboardVoltageRegulatorArray": {
- "description": "array of ipmiBaseboardVoltageRegulator objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBaseboardVoltageRegulator"
- }
- },
- "ipmiBatteryArray": {
- "description": "array of ipmiBattery objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBattery"
- }
- },
- "ipmiFanArray": {
- "description": "array of ipmiFan objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiFan"
- }
- },
- "ipmiHsbpArray": {
- "description": "array of ipmiHsbp objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiHsbp"
- }
- },
- "ipmiGlobalAggregateTemperatureMarginArray": {
- "description": "array of ipmiGlobalAggregateTemperatureMargin objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiGlobalAggregateTemperatureMargin"
- }
- },
- "ipmiNicArray": {
- "description": "array of ipmiNic objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiNic"
- }
- },
- "ipmiPowerSupplyArray": {
- "description": "array of ipmiPowerSupply objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiPowerSupply"
- }
- },
- "ipmiProcessorArray": {
- "description": "array of ipmiProcessor objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiProcessor"
- }
- },
- "systemAirflow": {
- "description": "airfflow in cubic feet per minute (cfm)",
- "type": "number"
- }
- }
- },
- "ipmiBaseboardTemperature": {
- "description": "intelligent platform management interface (ipmi) baseboard temperature metrics",
- "type": "object",
- "properties": {
- "baseboardTemperatureIdentifier": {
- "description": "identifier for the location where the temperature is taken",
- "type": "string"
- },
- "baseboardTemperature": {
- "description": "baseboard temperature in celsius",
- "type": "number"
- }
- },
- "required": [ "baseboardTemperatureIdentifier" ]
- },
- "ipmiBaseboardVoltageRegulator": {
- "description": "intelligent platform management interface (ipmi) baseboard voltage regulator metrics",
- "type": "object",
- "properties": {
- "baseboardVoltageRegulatorIdentifier": {
- "description": "identifier for the baseboard voltage regulator",
- "type": "string"
- },
- "voltageRegulatorTemperature": {
- "description": "voltage regulator temperature in celsius",
- "type": "number"
- }
- },
- "required": [ "baseboardVoltageRegulatorIdentifier" ]
- },
- "ipmiBattery": {
- "description": "intelligent platform management interface (ipmi) battery metrics",
- "type": "object",
- "properties": {
- "batteryIdentifier": {
- "description": "identifier for the battery",
- "type": "string"
- },
- "batteryType": {
- "description": "type of battery",
- "type": "string"
- },
- "batteryVoltageLevel": {
- "description": "battery voltage level",
- "type": "number"
- }
- },
- "required": [ "batteryIdentifier" ]
- },
- "ipmiFan": {
- "description": "intelligent platform management interface (ipmi) fan metrics",
- "type": "object",
- "properties": {
- "fanIdentifier": {
- "description": "identifier for the fan",
- "type": "string"
- },
- "fanSpeed": {
- "description": "fan speed in revolutions per minute (rpm)",
- "type": "number"
- }
- },
- "required": [ "fanIdentifier" ]
- },
- "ipmiGlobalAggregateTemperatureMargin": {
- "description": "intelligent platform management interface (ipmi) global aggregate temperature margin",
- "type": "object",
- "properties": {
- "ipmiGlobalAggregateTemperatureMarginIdentifier": {
- "description": "identifier for the ipmi global aggregate temperature margin metrics",
- "type": "string"
- },
- "globalAggregateTemperatureMargin": {
- "description": "the difference between the current global aggregate temperature, in celsius, and the global aggregate throttling thermal trip point",
- "type": "number"
- }
- },
- "required": [ "ipmiGlobalAggregateTemperatureMarginIdentifier", "globalAggregateTemperatureMargin" ]
- },
- "ipmiHsbp": {
- "description": "intelligent platform management interface (ipmi) hot swap backplane power metrics",
- "type": "object",
- "properties": {
- "hsbpIdentifier": {
- "description": "identifier for the hot swap backplane power unit",
- "type": "string"
- },
- "hsbpTemperature": {
- "description": "hot swap backplane power temperature in celsius",
- "type": "number"
- }
- },
- "required": [ "hsbpIdentifier" ]
- },
- "ipmiNic": {
- "description": "intelligent platform management interface (ipmi) network interface control card (nic) metrics",
- "type": "object",
- "properties": {
- "nicIdentifier": {
- "description": "identifier for the network interface control card",
- "type": "string"
- },
- "nicTemperature": {
- "description": "nic temperature in celsius",
- "type": "number"
- }
- },
- "required": [ "nicIdentifier" ]
- },
- "ipmiPowerSupply": {
- "description": "intelligent platform management interface (ipmi) power supply metrics",
- "type": "object",
- "properties": {
- "powerSupplyIdentifier": {
- "description": "identifier for the power supply",
- "type": "string"
- },
- "powerSupplyInputPower": {
- "description": "input power in watts",
- "type": "number"
- },
- "powerSupplyCurrentOutputPercent": {
- "description": "current output voltage as a percentage of the design specified level",
- "type": "number"
- },
- "powerSupplyTemperature": {
- "description": "power supply temperature in celsius",
- "type": "number"
- }
- },
- "required": [ "powerSupplyIdentifier" ]
- },
- "ipmiProcessor": {
- "description": "intelligent platform management interface processor metrics",
- "type": "object",
- "properties": {
- "processorIdentifier": {
- "description": "identifier for an ipmi processor",
- "type": "string"
- },
- "processorThermalControlPercent": {
- "description": "io module temperature in celsius",
- "type": "number"
- },
- "processorDtsThermalMargin": {
- "description": "front panel temperature in celsius",
- "type": "number"
- },
- "processorDimmAggregateThermalMarginArray": {
- "description": "array of processorDimmAggregateThermalMargin objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/processorDimmAggregateThermalMargin"
- }
- }
- },
- "required": [ "processorIdentifier" ]
- },
- "jsonObject": {
- "description": "json object schema, name and other meta-information along with one or more object instances",
- "type": "object",
- "properties": {
- "objectInstances": {
- "description": "one or more instances of the jsonObject",
- "type": "array",
- "items": {
- "$ref": "#/definitions/jsonObjectInstance"
- }
- },
- "objectName": {
- "description": "name of the JSON Object",
- "type": "string"
- },
- "objectSchema": {
- "description": "json schema for the object",
- "type": "string"
- },
- "objectSchemaUrl": {
- "description": "Url to the json schema for the object",
- "type": "string"
- },
- "nfSubscribedObjectName": {
- "description": "name of the object associated with the nfSubscriptonId",
- "type": "string"
- },
- "nfSubscriptionId": {
- "description": "identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject",
- "type": "string"
- }
- },
- "required": [ "objectInstances", "objectName" ]
- },
- "jsonObjectInstance": {
- "description": "meta-information about an instance of a jsonObject along with the actual object instance",
- "type": "object",
- "properties": {
- "objectInstance": {
- "description": "an instance conforming to the jsonObject schema",
- "type": "object"
- },
- "objectInstanceEpochMicrosec": {
- "description": "the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
- "type": "number"
- },
- "objectKeys": {
- "description": "an ordered set of keys that identifies this particular instance of jsonObject",
- "type": "array",
- "items": {
- "$ref": "#/definitions/key"
- }
- }
- },
- "required": [ "objectInstance" ]
- },
- "key": {
- "description": "tuple which provides the name of a key along with its value and relative order",
- "type": "object",
- "properties": {
- "keyName": {
- "description": "name of the key",
- "type": "string"
- },
- "keyOrder": {
- "description": "relative sequence or order of the key with respect to other keys",
- "type": "integer"
- },
- "keyValue": {
- "description": "value of the key",
- "type": "string"
- }
- },
- "required": [ "keyName" ]
- },
- "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" ]
- },
- "load": {
- "description": "/proc/loadavg cpu utilization and io utilization metrics",
- "type": "object",
- "properties": {
- "longTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg",
- "type": "number"
- },
- "midTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg",
- "type": "number"
- },
- "shortTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg",
- "type": "number"
- }
- }
- },
- "machineCheckException": {
- "description": "metrics on vm machine check exceptions",
- "type": "object",
- "properties": {
- "correctedMemoryErrors": {
- "description": "total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval",
- "type": "number"
- },
- "correctedMemoryErrorsIn1Hr": {
- "description": "total hardware errors that were corrected by the hardware over the last one hour",
- "type": "number"
- },
- "uncorrectedMemoryErrors": {
- "description": "total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval",
- "type": "number"
- },
- "uncorrectedMemoryErrorsIn1Hr": {
- "description": "total uncorrected hardware errors that were detected by the hardware over the last one hour",
- "type": "number"
- },
- "vmIdentifier": {
- "description": "virtual machine identifier associated with the machine check exception",
- "type": "string"
- }
- },
- "required": [ "vmIdentifier" ]
- },
- "measurementFields": {
- "description": "measurement fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "additionalMeasurements": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "additionalObjects": {"$ref": "#/definitions/arrayOfJsonObject"},
- "codecUsageArray": {
- "description": "array of codecs in use",
- "type": "array",
- "items": {
- "$ref": "#/definitions/codecsInUse"
- }
- },
- "concurrentSessions": {
- "description": "peak concurrent sessions for the VM or xNF over the measurementInterval",
- "type": "integer"
- },
- "configuredEntities": {
- "description": "over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the xNF",
- "type": "integer"
- },
- "cpuUsageArray": {
- "description": "usage of an array of CPUs",
- "type": "array",
- "items": {
- "$ref": "#/definitions/cpuUsage"
- }
- },
- "diskUsageArray": {
- "description": "usage of an array of disks",
- "type": "array",
- "items": {
- "$ref": "#/definitions/diskUsage"
- }
- },
- "featureUsageArray": { "$ref": "#/definitions/hashMap" },
- "filesystemUsageArray": {
- "description": "filesystem usage of the VM on which the xNFC reporting the event is running",
- "type": "array",
- "items": {
- "$ref": "#/definitions/filesystemUsage"
- }
- },
- "hugePagesArray": {
- "description": "array of metrics on hugepPages",
- "type": "array",
- "items": {
- "$ref": "#/definitions/hugePages"
- }
- },
- "ipmi": { "$ref": "#/definitions/ipmi" },
- "latencyDistribution": {
- "description": "array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges",
- "type": "array",
- "items": {
- "$ref": "#/definitions/latencyBucketMeasure"
- }
- },
- "loadArray": {
- "description": "array of system load metrics",
- "type": "array",
- "items": {
- "$ref": "#/definitions/load"
- }
- },
- "machineCheckExceptionArray": {
- "description": "array of machine check exceptions",
- "type": "array",
- "items": {
- "$ref": "#/definitions/machineCheckException"
- }
- },
- "meanRequestLatency": {
- "description": "mean seconds required to respond to each request for the VM on which the xNFC reporting the event is running",
- "type": "number"
- },
- "measurementInterval": {
- "description": "interval over which measurements are being reported in seconds",
- "type": "number"
- },
- "measurementFieldsVersion": {
- "description": "version of the measurementFields block",
- "type": "number"
- },
- "memoryUsageArray": {
- "description": "memory usage of an array of VMs",
- "type": "array",
- "items": {
- "$ref": "#/definitions/memoryUsage"
- }
- },
- "numberOfMediaPortsInUse": {
- "description": "number of media ports in use",
- "type": "integer"
- },
- "requestRate": {
- "description": "peak rate of service requests per second to the xNF over the measurementInterval",
- "type": "number"
- },
- "nfcScalingMetric": {
- "description": "represents busy-ness of the network function from 0 to 100 as reported by the xNFC",
- "type": "integer"
- },
- "nicPerformanceArray": {
- "description": "usage of an array of network interface cards",
- "type": "array",
- "items": {
- "$ref": "#/definitions/nicPerformance"
- }
- },
- "processStatsArray": {
- "description": "array of metrics on system processes",
- "type": "array",
- "items": {
- "$ref": "#/definitions/processStats"
- }
- }
- },
- "required": [ "measurementInterval", "measurementFieldsVersion" ]
- },
- "memoryUsage": {
- "description": "memory usage of an identified virtual machine",
- "type": "object",
- "properties": {
- "memoryBuffered": {
- "description": "kibibytes of temporary storage for raw disk blocks",
- "type": "number"
- },
- "memoryCached": {
- "description": "kibibytes of memory used for cache",
- "type": "number"
- },
- "memoryConfigured": {
- "description": "kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running",
- "type": "number"
- },
- "memoryDemand": {
- "description": "host demand in kibibytes",
- "type": "number"
- },
- "memoryFree": {
- "description": "kibibytes of physical RAM left unused by the system",
- "type": "number"
- },
- "memoryLatencyAvg": {
- "description": "Percentage of time the VM is waiting to access swapped or compressed memory",
- "type": "number"
- },
- "memorySharedAvg": {
- "description": "shared memory in kilobytes",
- "type": "number"
- },
- "memorySlabRecl": {
- "description": "the part of the slab that can be reclaimed such as caches measured in kibibytes",
- "type": "number"
- },
- "memorySlabUnrecl": {
- "description": "the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes",
- "type": "number"
- },
- "memorySwapInAvg": {
- "description": "Amount of memory swapped-in from host cache in kibibytes",
- "type": "number"
- },
- "memorySwapInRateAvg": {
- "description": "rate at which memory is swapped from disk into active memory during the interval in kilobytes per second",
- "type": "number"
- },
- "memorySwapOutAvg": {
- "description": "Amount of memory swapped-out to host cache in kibibytes",
- "type": "number"
- },
- "memorySwapOutRateAvg": {
- "description": "rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second",
- "type": "number"
- },
- "memorySwapUsedAvg": {
- "description": "space used for caching swapped pages in the host cache in kibibytes",
- "type": "number"
- },
- "memoryUsed": {
- "description": "total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes",
- "type": "number"
- },
- "vmIdentifier": {
- "description": "virtual machine identifier associated with the memory metrics",
- "type": "string"
- }
- },
- "required": [ "memoryFree", "memoryUsed", "vmIdentifier" ]
- },
- "mobileFlowFields": {
- "description": "mobileFlow fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "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": "integer"
- },
- "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": "integer"
- },
- "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": "integer"
- },
- "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",
- "mobileFlowFieldsVersion", "otherEndpointIpAddress", "otherEndpointPort",
- "reportingEndpointIpAddr", "reportingEndpointPort" ]
- },
- "namedHashMap": {
- "description": "a hashMap which is associated with and described by a name",
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "hashMap": { "$ref": "#/definitions/hashMap" }
- },
- "required": [ "name", "hashMap" ]
- },
- "nicPerformance": {
- "description": "describes the performance and errors of an identified network interface card",
- "type": "object",
- "properties": {
- "nicIdentifier": {
- "description": "nic identification",
- "type": "string"
- },
- "receivedBroadcastPacketsAccumulated": {
- "description": "Cumulative count of broadcast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedBroadcastPacketsDelta": {
- "description": "Count of broadcast packets received within the measurement interval",
- "type": "number"
- },
- "receivedDiscardedPacketsAccumulated": {
- "description": "Cumulative count of discarded packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedDiscardedPacketsDelta": {
- "description": "Count of discarded packets received within the measurement interval",
- "type": "number"
- },
- "receivedErrorPacketsAccumulated": {
- "description": "Cumulative count of error packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedErrorPacketsDelta": {
- "description": "Count of error packets received within the measurement interval",
- "type": "number"
- },
- "receivedMulticastPacketsAccumulated": {
- "description": "Cumulative count of multicast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedMulticastPacketsDelta": {
- "description": "Count of multicast packets received within the measurement interval",
- "type": "number"
- },
- "receivedOctetsAccumulated": {
- "description": "Cumulative count of octets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedOctetsDelta": {
- "description": "Count of octets received within the measurement interval",
- "type": "number"
- },
- "receivedTotalPacketsAccumulated": {
- "description": "Cumulative count of all packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedTotalPacketsDelta": {
- "description": "Count of all packets received within the measurement interval",
- "type": "number"
- },
- "receivedUnicastPacketsAccumulated": {
- "description": "Cumulative count of unicast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedUnicastPacketsDelta": {
- "description": "Count of unicast packets received within the measurement interval",
- "type": "number"
- },
- "transmittedBroadcastPacketsAccumulated": {
- "description": "Cumulative count of broadcast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedBroadcastPacketsDelta": {
- "description": "Count of broadcast packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedDiscardedPacketsAccumulated": {
- "description": "Cumulative count of discarded packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedDiscardedPacketsDelta": {
- "description": "Count of discarded packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedErrorPacketsAccumulated": {
- "description": "Cumulative count of error packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedErrorPacketsDelta": {
- "description": "Count of error packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedMulticastPacketsAccumulated": {
- "description": "Cumulative count of multicast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedMulticastPacketsDelta": {
- "description": "Count of multicast packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedOctetsAccumulated": {
- "description": "Cumulative count of octets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedOctetsDelta": {
- "description": "Count of octets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedTotalPacketsAccumulated": {
- "description": "Cumulative count of all packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedTotalPacketsDelta": {
- "description": "Count of all packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedUnicastPacketsAccumulated": {
- "description": "Cumulative count of unicast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedUnicastPacketsDelta": {
- "description": "Count of unicast packets transmitted within the measurement interval",
- "type": "number"
- },
- "valuesAreSuspect": {
- "description": "Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions",
- "type": "string",
- "enum": [ "true", "false" ]
- }
- },
- "required": [ "nicIdentifier", "valuesAreSuspect" ]
- },
- "notificationFields": {
- "description": "notification fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "arrayOfNamedHashMap": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "changeContact": {
- "description": "identifier for a contact related to the change",
- "type": "string"
- },
- "changeIdentifier": {
- "description": "system or session identifier associated with the change",
- "type": "string"
- },
- "changeType": {
- "description": "describes what has changed for the entity",
- "type": "string"
- },
- "newState": {
- "description": "new state of the entity",
- "type": "string"
- },
- "oldState": {
- "description": "previous state of the entity",
- "type": "string"
- },
- "notificationFieldsVersion": {
- "description": "version of the notificationFields block",
- "type": "number"
- },
- "stateInterface": {
- "description": "card or port name of the entity that changed state",
- "type": "string"
- }
- },
- "required": [ "changeIdentifier", "changeType", "notificationFieldsVersion" ]
- },
- "otherFields": {
- "description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration",
- "type": "object",
- "properties": {
- "arrayOfNamedHashMap": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "hashMap": {"$ref": "#/definitions/hashMap"},
- "jsonObjects": {"$ref": "#/definitions/arrayOfJsonObject"},
- "otherFieldsVersion": {
- "description": "version of the otherFields block",
- "type": "number"
- }
- },
- "required": [ "otherFieldsVersion" ]
- },
- "pnfRegistrationFields": {
- "description": "hardware device registration fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "lastServiceDate": {
- "description": "TS 32.692 dateOfLastService = date of last service; e.g. 15022017",
- "type": "string"
- },
- "macAddress": {
- "description": "MAC address of OAM interface of the unit",
- "type": "string"
- },
- "manufactureDate": {
- "description": "TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016",
- "type": "string"
- },
- "modelNumber": {
- "description": "TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model",
- "type": "string"
- },
- "oamV4IpAddress": {
- "description": "IPv4 m-plane IP address to be used by the manager to contact the PNF",
- "type": "string"
- },
- "oamV6IpAddress": {
- "description": "IPv6 m-plane IP address to be used by the manager to contact the PNF",
- "type": "string"
- },
- "pnfRegistrationFieldsVersion": {
- "description": "version of the pnfRegistrationFields block",
- "type": "number"
- },
- "serialNumber": {
- "description": "TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3",
- "type": "string"
- },
- "softwareVersion": {
- "description": "TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201",
- "type": "string"
- },
- "unitFamily": {
- "description": "TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU",
- "type": "string"
- },
- "unitType": {
- "description": "TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale",
- "type": "string"
- },
- "vendorName": {
- "description": "TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor",
- "type": "string"
- }
- },
- "required": [ "pnfRegistrationFieldsVersion" ]
- },
- "processorDimmAggregateThermalMargin": {
- "description": "intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics",
- "type": "object",
- "properties": {
- "processorDimmAggregateThermalMarginIdentifier": {
- "description": "identifier for the aggregate thermal margin metrics from the processor dual inline memory module",
- "type": "string"
- },
- "thermalMargin": {
- "description": "the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point",
- "type": "number"
- }
- },
- "required": [ "processorDimmAggregateThermalMarginIdentifier", "thermalMargin" ]
- },
- "processStats": {
- "description": "metrics on system processes",
- "type": "object",
- "properties": {
- "forkRate": {
- "description": "the number of threads created since the last reboot",
- "type": "number"
- },
- "processIdentifier": {
- "description": "processIdentifier",
- "type": "string"
- },
- "psStateBlocked": {
- "description": "the number of processes in a blocked state",
- "type": "number"
- },
- "psStatePaging": {
- "description": "the number of processes in a paging state",
- "type": "number"
- },
- "psStateRunning": {
- "description": "the number of processes in a running state",
- "type": "number"
- },
- "psStateSleeping": {
- "description": "the number of processes in a sleeping state",
- "type": "number"
- },
- "psStateStopped": {
- "description": "the number of processes in a stopped state",
- "type": "number"
- },
- "psStateZombie": {
- "description": "the number of processes in a zombie state",
- "type": "number"
- }
- },
- "required": [ "processIdentifier" ]
- },
- "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" ]
- },
- "sipSignalingFields": {
- "description": "sip signaling fields",
- "type": "object",
- "properties": {
- "additionalInformation": { "$ref": "#/definitions/hashMap"},
- "compressedSip": {
- "description": "the full SIP request/response including headers and bodies",
- "type": "string"
- },
- "correlator": {
- "description": "this is the same for all events on this call",
- "type": "string"
- },
- "localIpAddress": {
- "description": "IP address on xNF",
- "type": "string"
- },
- "localPort": {
- "description": "port on xNF",
- "type": "string"
- },
- "remoteIpAddress": {
- "description": "IP address of peer endpoint",
- "type": "string"
- },
- "remotePort": {
- "description": "port of peer endpoint",
- "type": "string"
- },
- "sipSignalingFieldsVersion": {
- "description": "version of the sipSignalingFields block",
- "type": "number"
- },
- "summarySip": {
- "description": "the SIP Method or Response ('INVITE', '200 OK', 'BYE', etc)",
- "type": "string"
- },
- "vendorNfNameFields": {
- "$ref": "#/definitions/vendorNfNameFields"
- }
- },
- "required": [ "correlator", "localIpAddress", "localPort", "remoteIpAddress",
- "remotePort", "sipSignalingFieldsVersion", "vendorNfNameFields" ]
- },
- "stateChangeFields": {
- "description": "stateChange fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "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", "stateChangeFieldsVersion", "stateInterface" ]
- },
- "syslogFields": {
- "description": "sysLog fields",
- "type": "object",
- "properties": {
- "additionalFields": {
- "description": "additional syslog fields if needed provided as name=value delimited by a pipe '|' symbol, for example: 'name1=value1|name2=value2|...'",
- "type": "string"
- },
- "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": "integer"
- },
- "syslogFieldsVersion": {
- "description": "version of the syslogFields block",
- "type": "number"
- },
- "syslogMsg": {
- "description": "syslog message",
- "type": "string"
- },
- "syslogMsgHost": {
- "description": "hostname parsed from non-VES syslog message",
- "type": "string"
- },
- "syslogPri": {
- "description": "0-192 combined severity and facility",
- "type": "integer"
- },
- "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",
- "enum": [
- "Alert",
- "Critical",
- "Debug",
- "Emergency",
- "Error",
- "Info",
- "Notice",
- "Warning"
- ]
- },
- "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"
- },
- "syslogTs": {
- "description": "timestamp parsed from non-VES syslog message",
- "type": "string"
- },
- "syslogVer": {
- "description": "IANA assigned version of the syslog protocol specification - typically 1",
- "type": "number"
- }
- },
- "required": [ "eventSourceType", "syslogFieldsVersion", "syslogMsg", "syslogTag" ]
- },
- "thresholdCrossingAlertFields": {
- "description": "fields specific to threshold crossing alert events",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap"},
- "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",
- "thresholdCrossingFieldsVersion"
- ]
- },
- "vendorNfNameFields": {
- "description": "provides vendor, nf and nfModule identifying information",
- "type": "object",
- "properties": {
- "vendorName": {
- "description": "network function vendor name",
- "type": "string"
- },
- "nfModuleName": {
- "description": "name of the nfModule generating the event",
- "type": "string"
- },
- "nfName": {
- "description": "name of the network function generating the event",
- "type": "string"
- }
- },
- "required": [ "vendorName" ]
- },
- "voiceQualityFields": {
- "description": "provides statistics related to customer facing voice products",
- "type": "object",
- "properties": {
- "additionalInformation": { "$ref": "#/definitions/hashMap"},
- "calleeSideCodec": {
- "description": "callee codec for the call",
- "type": "string"
- },
- "callerSideCodec": {
- "description": "caller codec for the call",
- "type": "string"
- },
- "correlator": {
- "description": "this is the same for all events on this call",
- "type": "string"
- },
- "endOfCallVqmSummaries": {
- "$ref": "#/definitions/endOfCallVqmSummaries"
- },
- "phoneNumber": {
- "description": "phone number associated with the correlator",
- "type": "string"
- },
- "midCallRtcp": {
- "description": "Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers",
- "type": "string"
- },
- "vendorNfNameFields": {
- "$ref": "#/definitions/vendorNfNameFields"
- },
- "voiceQualityFieldsVersion": {
- "description": "version of the voiceQualityFields block",
- "type": "number"
- }
- },
- "required": [ "calleeSideCodec", "callerSideCodec", "correlator", "midCallRtcp",
- "vendorNfNameFields", "voiceQualityFieldsVersion" ]
- }
- }
-}
\ No newline at end of file diff --git a/docs/files/CommonEventFormat_30.1_ONAP.json b/docs/files/CommonEventFormat_30.1_ONAP.json deleted file mode 100644 index 8f6af50..0000000 --- a/docs/files/CommonEventFormat_30.1_ONAP.json +++ /dev/null @@ -1,2658 +0,0 @@ -{
- "$schema": "http://json-schema.org/draft-04/schema#",
- "title": "VES Event Listener Common Event Format",
- "type": "object",
- "properties": {
- "event": {"$ref": "#/definitions/event"},
- "eventList": {"$ref": "#/definitions/eventList"}
- },
-
- "definitions": {
- "schemaHeaderBlock": {
- "description": "schema date, version, author and associated API",
- "type": "object",
- "properties": {
- "associatedApi": {
- "description": "VES Event Listener",
- "type": "string"
- },
- "lastUpdatedBy": {
- "description": "re2947",
- "type": "string"
- },
- "schemaDate": {
- "description": "December 4, 2018",
- "type": "string"
- },
- "schemaVersion": {
- "description": "30.1",
- "type": "number"
- }
- }
- },
- "schemaLicenseAndCopyrightNotice": {
- "description": "Copyright (c) 2018, 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"
- }
- }
- },
- "arrayOfJsonObject": {
- "description": "array of json objects described by name, schema and other meta-information",
- "type": "array",
- "items": {
- "$ref": "#/definitions/jsonObject"
- }
- },
- "arrayOfNamedHashMap": {
- "description": "array of named hashMaps",
- "type": "array",
- "items": {
- "$ref": "#/definitions/namedHashMap"
- }
- },
- "codecsInUse": {
- "description": "number of times an identified codec was used over the measurementInterval",
- "type": "object",
- "properties": {
- "codecIdentifier": { "type": "string" },
- "numberInUse": { "type": "integer" }
- },
- "additionalProperties": false,
- "required": [ "codecIdentifier", "numberInUse" ]
- },
- "commonEventHeader": {
- "description": "fields common to all events",
- "type": "object",
- "properties": {
- "domain": {
- "description": "the eventing domain associated with the event",
- "type": "string",
- "enum": [
- "fault",
- "heartbeat",
- "measurement",
- "mobileFlow",
- "notification",
- "other",
- "perf3gpp",
- "pnfRegistration",
- "sipSignaling",
- "stateChange",
- "syslog",
- "thresholdCrossingAlert",
- "voiceQuality"
- ]
- },
- "eventId": {
- "description": "event key that is unique to the event source",
- "type": "string"
- },
- "eventName": {
- "description": "unique event name",
- "type": "string"
- },
- "eventType": {
- "description": "for example - applicationNf, guestOS, hostOS, platform",
- "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"
- },
- "nfcNamingCode": {
- "description": "3 character network function component type, aligned with vfc naming standards",
- "type": "string"
- },
- "nfNamingCode": {
- "description": "4 character network function type, aligned with nf naming standards",
- "type": "string"
- },
- "nfVendorName": {
- "description": "network function vendor name",
- "type": "string"
- },
- "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 EMS name; may be the same as sourceName",
- "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"
- },
- "timeZoneOffset": {
- "description": "UTC offset for the local time zone of the device as UTC+/-hh.mm",
- "type": "string"
- },
- "version": {
- "description": "version of the event header",
- "type": "string",
- "enum": [ "4.0", "4.0.1", "4.1" ]
- },
- "vesEventListenerVersion": {
- "description": "version of the VES Event Listener API",
- "type": "string",
- "enum": [ "7.0", "7.0.1", "7.1" ]
- }
- },
- "additionalProperties": false,
- "required": [ "domain", "eventId", "eventName", "lastEpochMicrosec",
- "priority", "reportingEntityName", "sequence", "sourceName",
- "startEpochMicrosec", "version", "vesEventListenerVersion" ]
- },
- "counter": {
- "description": "performance counter",
- "type": "object",
- "properties": {
- "criticality": { "type": "string", "enum": [ "CRIT", "MAJ" ] },
- "hashMap": { "$ref": "#/definitions/hashMap" },
- "thresholdCrossed": { "type": "string" }
- },
- "additionalProperties": false,
- "required": [ "criticality", "hashMap", "thresholdCrossed" ]
- },
- "cpuUsage": {
- "description": "usage of an identified CPU",
- "type": "object",
- "properties": {
- "cpuCapacityContention": {
- "description": "the amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuDemandAvg": {
- "description": "the total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuDemandMhz": {
- "description": "CPU demand in megahertz",
- "type": "number"
- },
- "cpuDemandPct": {
- "description": "CPU demand as a percentage of the provisioned capacity",
- "type": "number"
- },
- "cpuIdentifier": {
- "description": "cpu identifer",
- "type": "string"
- },
- "cpuIdle": {
- "description": "percentage of CPU time spent in the idle task",
- "type": "number"
- },
- "cpuLatencyAvg": {
- "description": "percentage of time the VM is unable to run because it is contending for access to the physical CPUs",
- "type": "number"
- },
- "cpuOverheadAvg": {
- "description": "the overhead demand above available allocations and reservations, in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuSwapWaitTime": {
- "description": "swap wait time. in milliseconds over the measurementInterval",
- "type": "number"
- },
- "cpuUsageInterrupt": {
- "description": "percentage of time spent servicing interrupts",
- "type": "number"
- },
- "cpuUsageNice": {
- "description": "percentage of time spent running user space processes that have been niced",
- "type": "number"
- },
- "cpuUsageSoftIrq": {
- "description": "percentage of time spent handling soft irq interrupts",
- "type": "number"
- },
- "cpuUsageSteal": {
- "description": "percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing",
- "type": "number"
- },
- "cpuUsageSystem": {
- "description": "percentage of time spent on system tasks running the kernel",
- "type": "number"
- },
- "cpuUsageUser": {
- "description": "percentage of time spent running un-niced user space processes",
- "type": "number"
- },
- "cpuWait": {
- "description": "percentage of CPU time spent waiting for I/O operations to complete",
- "type": "number"
- },
- "percentUsage": {
- "description": "aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "cpuIdentifier", "percentUsage" ]
- },
- "diskUsage": {
- "description": "usage of an identified disk",
- "type": "object",
- "properties": {
- "diskBusResets": {
- "description": "number of bus resets over the measurementInterval",
- "type": "number"
- },
- "diskCommandsAborted": {
- "description": "number of disk commands aborted over the measurementInterval",
- "type": "number"
- },
- "diskCommandsAvg": {
- "description": "average number of commands per second over the measurementInterval",
- "type": "number"
- },
- "diskFlushRequests": {
- "description": "total flush requests of the disk cache over the measurementInterval",
- "type": "number"
- },
- "diskFlushTime": {
- "description": "milliseconds spent on disk cache flushing over the measurementInterval",
- "type": "number"
- },
- "diskIdentifier": {
- "description": "disk identifier",
- "type": "string"
- },
- "diskIoTimeAvg": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval",
- "type": "number"
- },
- "diskIoTimeLast": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskIoTimeMax": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskIoTimeMin": {
- "description": "milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadAvg": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadLast": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadMax": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedReadMin": {
- "description": "number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteAvg": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteLast": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteMax": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval",
- "type": "number"
- },
- "diskMergedWriteMin": {
- "description": "number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadAvg": {
- "description": "number of octets per second read from a disk or partition; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadLast": {
- "description": "number of octets per second read from a disk or partition; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadMax": {
- "description": "number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsReadMin": {
- "description": "number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteAvg": {
- "description": "number of octets per second written to a disk or partition; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteLast": {
- "description": "number of octets per second written to a disk or partition; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteMax": {
- "description": "number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOctetsWriteMin": {
- "description": "number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadAvg": {
- "description": "number of read operations per second issued to the disk; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadLast": {
- "description": "number of read operations per second issued to the disk; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadMax": {
- "description": "number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsReadMin": {
- "description": "number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteAvg": {
- "description": "number of write operations per second issued to the disk; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteLast": {
- "description": "number of write operations per second issued to the disk; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteMax": {
- "description": "number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskOpsWriteMin": {
- "description": "number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsAvg": {
- "description": "queue size of pending I/O operations per second; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsLast": {
- "description": "queue size of pending I/O operations per second; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsMax": {
- "description": "queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskPendingOperationsMin": {
- "description": "queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskReadCommandsAvg": {
- "description": "average number of read commands issued per second to the disk over the measurementInterval",
- "type": "number"
- },
- "diskTime": {
- "description": "nanoseconds spent on disk cache reads/writes within the measurement interval",
- "type": "number"
- },
- "diskTimeReadAvg": {
- "description": "milliseconds a read operation took to complete; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadLast": {
- "description": "milliseconds a read operation took to complete; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadMax": {
- "description": "milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeReadMin": {
- "description": "milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteAvg": {
- "description": "milliseconds a write operation took to complete; provide the average measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteLast": {
- "description": "milliseconds a write operation took to complete; provide the last measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteMax": {
- "description": "milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval",
- "type": "number"
- },
- "diskTimeWriteMin": {
- "description": "milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval",
- "type": "number"
- },
- "diskTotalReadLatencyAvg": {
- "description": "average read time from the perspective of a Guest OS: sum of the Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval",
- "type": "number"
- },
- "diskTotalWriteLatencyAvg": {
- "description": "average write time from the perspective of a Guest OS: sum of the Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval",
- "type": "number"
- },
- "diskWeightedIoTimeAvg": {
- "description": "measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating; value is the average within the collection interval",
- "type": "number"
- },
- "diskWeightedIoTimeLast": {
- "description": "measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating; value is the last within the collection interval",
- "type": "number"
- },
- "diskWeightedIoTimeMax": {
- "description": "measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating; value is the maximum within the collection interval",
- "type": "number"
- },
- "diskWeightedIoTimeMin": {
- "description": "measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating; value is the minimum within the collection interval",
- "type": "number"
- },
- "diskWriteCommandsAvg": {
- "description": "average number of write commands issued per second to the disk over the measurementInterval",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "diskIdentifier" ]
- },
- "endOfCallVqmSummaries": {
- "description": "provides end of call voice quality metrics",
- "type": "object",
- "properties": {
- "adjacencyName": {
- "description": " adjacency name",
- "type": "string"
- },
- "endpointAverageJitter": {
- "description": "endpoint average jitter",
- "type": "number"
- },
- "endpointDescription": {
- "description": "either Caller or Callee",
- "type": "string",
- "enum": ["Caller", "Callee"]
- },
- "endpointMaxJitter": {
- "description": "endpoint maximum jitter",
- "type": "number"
- },
- "endpointRtpOctetsDiscarded": {
- "description": "",
- "type": "number"
- },
- "endpointRtpOctetsLost": {
- "description": "endpoint RTP octets lost",
- "type": "number"
- },
- "endpointRtpOctetsReceived": {
- "description": "",
- "type": "number"
- },
- "endpointRtpOctetsSent": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsDiscarded": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsLost": {
- "description": "endpoint RTP packets lost",
- "type": "number"
- },
- "endpointRtpPacketsReceived": {
- "description": "",
- "type": "number"
- },
- "endpointRtpPacketsSent": {
- "description": "",
- "type": "number"
- },
- "localAverageJitter": {
- "description": "Local average jitter",
- "type": "number"
- },
- "localAverageJitterBufferDelay": {
- "description": "Local average jitter delay",
- "type": "number"
- },
- "localMaxJitter": {
- "description": "Local maximum jitter",
- "type": "number"
- },
- "localMaxJitterBufferDelay": {
- "description": "Local maximum jitter delay",
- "type": "number"
- },
- "localRtpOctetsDiscarded": {
- "description": "",
- "type": "number"
- },
- "localRtpOctetsLost": {
- "description": "Local RTP octets lost",
- "type": "number"
- },
- "localRtpOctetsReceived": {
- "description": "",
- "type": "number"
- },
- "localRtpOctetsSent": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsDiscarded": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsLost": {
- "description": "Local RTP packets lost",
- "type": "number"
- },
- "localRtpPacketsReceived": {
- "description": "",
- "type": "number"
- },
- "localRtpPacketsSent": {
- "description": "",
- "type": "number"
- },
- "mosCqe": {
- "description": "1-5 1dp",
- "type": "number"
- },
- "oneWayDelay": {
- "description": "one-way path delay in milliseconds",
- "type": "number"
- },
- "packetLossPercent": {
- "description" : "Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)",
- "type": "number"
- },
- "rFactor": {
- "description": "0-100",
- "type": "number"
- },
- "roundTripDelay": {
- "description": "millisecs",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "adjacencyName", "endpointDescription" ]
- },
- "event": {
- "description": "the root level of the common event format",
- "type": "object",
- "properties": {
- "commonEventHeader": { "$ref": "#/definitions/commonEventHeader" },
- "faultFields": { "$ref": "#/definitions/faultFields" },
- "heartbeatFields": { "$ref": "#/definitions/heartbeatFields" },
- "measurementFields": { "$ref": "#/definitions/measurementFields" },
- "mobileFlowFields": { "$ref": "#/definitions/mobileFlowFields" },
- "notificationFields": { "$ref": "#/definitions/notificationFields" },
- "otherFields": { "$ref": "#/definitions/otherFields" },
- "perf3gppFields": { "$ref": "#/definitions/perf3gppFields" },
- "pnfRegistrationFields": { "$ref": "#/definitions/pnfRegistrationFields" },
- "sipSignalingFields": { "$ref": "#/definitions/sipSignalingFields" },
- "stateChangeFields": { "$ref": "#/definitions/stateChangeFields" },
- "syslogFields": { "$ref": "#/definitions/syslogFields" },
- "thresholdCrossingAlertFields": { "$ref": "#/definitions/thresholdCrossingAlertFields" },
- "voiceQualityFields": { "$ref": "#/definitions/voiceQualityFields" }
- },
- "additionalProperties": false,
- "required": [ "commonEventHeader" ]
- },
- "eventList": {
- "description": "array of events",
- "type": "array",
- "items": {
- "$ref": "#/definitions/event"
- }
- },
- "faultFields": {
- "description": "fields specific to fault events",
- "type": "object",
- "properties": {
- "alarmAdditionalInformation": { "$ref": "#/definitions/hashMap" },
- "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"
- },
- "eventCategory": {
- "description": "Event category, for example: license, link, routing, security, signaling",
- "type": "string"
- },
- "eventSeverity": {
- "description": "event severity",
- "type": "string",
- "enum": [
- "CRITICAL",
- "MAJOR",
- "MINOR",
- "WARNING",
- "NORMAL"
- ]
- },
- "eventSourceType": {
- "description": "type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction",
- "type": "string"
- },
- "faultFieldsVersion": {
- "description": "version of the faultFields block",
- "type": "string",
- "enum": [ "4.0" ]
- },
- "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"
- ]
- }
- },
- "additionalProperties": false,
- "required": [ "alarmCondition", "eventSeverity", "eventSourceType",
- "faultFieldsVersion", "specificProblem", "vfStatus" ]
- },
- "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" }
- },
- "additionalProperties": false,
- "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": { "$ref": "#/definitions/hashMap" },
- "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": { "$ref": "#/definitions/hashMap" },
- "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": { "$ref": "#/definitions/hashMap" },
- "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"
- }
- },
- "additionalProperties": false,
- "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"
- ]
- },
- "hashMap": {
- "description": "an associative array which is an array of key:value pairs",
- "type": "object",
- "additionalProperties": { "type": "string" },
- "default": {}
- },
- "heartbeatFields": {
- "description": "optional field block for fields specific to heartbeat events",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "heartbeatFieldsVersion": {
- "description": "version of the heartbeatFields block",
- "type": "string",
- "enum": [ "3.0" ]
- },
- "heartbeatInterval": {
- "description": "current heartbeat interval in seconds",
- "type": "integer"
- }
- },
- "additionalProperties": false,
- "required": [ "heartbeatFieldsVersion", "heartbeatInterval" ]
- },
- "hugePages": {
- "description": "metrics on system hugepages",
- "type": "object",
- "properties": {
- "bytesFree": {
- "description": "number of free hugepages in bytes",
- "type": "number"
- },
- "bytesUsed": {
- "description": "number of used hugepages in bytes",
- "type": "number"
- },
- "hugePagesIdentifier": {
- "description": "hugePages identifier",
- "type": "string"
- },
- "percentFree": {
- "description": "number of free hugepages in percent",
- "type": "number"
- },
- "percentUsed": {
- "description": "number of free hugepages in percent",
- "type": "number"
- },
- "vmPageNumberFree": {
- "description": "number of free vmPages in numbers",
- "type": "number"
- },
- "vmPageNumberUsed": {
- "description": "number of used vmPages in numbers",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "hugePagesIdentifier" ]
- },
- "internalHeaderFields": {
- "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
- "type": "object"
- },
- "ipmi": {
- "description": "intelligent platform management interface metrics",
- "type": "object",
- "properties": {
- "exitAirTemperature": {
- "description": "system fan exit air flow temperature in celsius",
- "type": "number"
- },
- "frontPanelTemperature": {
- "description": "front panel temperature in celsius",
- "type": "number"
- },
- "ioModuleTemperature": {
- "description": "io module temperature in celsius",
- "type": "number"
- },
- "ipmiBaseboardTemperatureArray": {
- "description": "array of ipmiBaseboardTemperature objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBaseboardTemperature"
- }
- },
- "ipmiBaseboardVoltageRegulatorArray": {
- "description": "array of ipmiBaseboardVoltageRegulator objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBaseboardVoltageRegulator"
- }
- },
- "ipmiBatteryArray": {
- "description": "array of ipmiBattery objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiBattery"
- }
- },
- "ipmiFanArray": {
- "description": "array of ipmiFan objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiFan"
- }
- },
- "ipmiHsbpArray": {
- "description": "array of ipmiHsbp objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiHsbp"
- }
- },
- "ipmiGlobalAggregateTemperatureMarginArray": {
- "description": "array of ipmiGlobalAggregateTemperatureMargin objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiGlobalAggregateTemperatureMargin"
- }
- },
- "ipmiNicArray": {
- "description": "array of ipmiNic objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiNic"
- }
- },
- "ipmiPowerSupplyArray": {
- "description": "array of ipmiPowerSupply objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiPowerSupply"
- }
- },
- "ipmiProcessorArray": {
- "description": "array of ipmiProcessor objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ipmiProcessor"
- }
- },
- "systemAirflow": {
- "description": "airfflow in cubic feet per minute (cfm)",
- "type": "number"
- }
- },
- "additionalProperties": false
- },
- "ipmiBaseboardTemperature": {
- "description": "intelligent platform management interface (ipmi) baseboard temperature metrics",
- "type": "object",
- "properties": {
- "baseboardTemperatureIdentifier": {
- "description": "identifier for the location where the temperature is taken",
- "type": "string"
- },
- "baseboardTemperature": {
- "description": "baseboard temperature in celsius",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "baseboardTemperatureIdentifier" ]
- },
- "ipmiBaseboardVoltageRegulator": {
- "description": "intelligent platform management interface (ipmi) baseboard voltage regulator metrics",
- "type": "object",
- "properties": {
- "baseboardVoltageRegulatorIdentifier": {
- "description": "identifier for the baseboard voltage regulator",
- "type": "string"
- },
- "voltageRegulatorTemperature": {
- "description": "voltage regulator temperature in celsius",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "baseboardVoltageRegulatorIdentifier" ]
- },
- "ipmiBattery": {
- "description": "intelligent platform management interface (ipmi) battery metrics",
- "type": "object",
- "properties": {
- "batteryIdentifier": {
- "description": "identifier for the battery",
- "type": "string"
- },
- "batteryType": {
- "description": "type of battery",
- "type": "string"
- },
- "batteryVoltageLevel": {
- "description": "battery voltage level",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "batteryIdentifier" ]
- },
- "ipmiFan": {
- "description": "intelligent platform management interface (ipmi) fan metrics",
- "type": "object",
- "properties": {
- "fanIdentifier": {
- "description": "identifier for the fan",
- "type": "string"
- },
- "fanSpeed": {
- "description": "fan speed in revolutions per minute (rpm)",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "fanIdentifier" ]
- },
- "ipmiGlobalAggregateTemperatureMargin": {
- "description": "intelligent platform management interface (ipmi) global aggregate temperature margin",
- "type": "object",
- "properties": {
- "globalAggregateTemperatureMarginIdentifier": {
- "description": "identifier for the ipmi global aggregate temperature margin metrics",
- "type": "string"
- },
- "globalAggregateTemperatureMargin": {
- "description": "the difference between the current global aggregate temperature, in celsius, and the global aggregate throttling thermal trip point",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "globalAggregateTemperatureMarginIdentifier", "globalAggregateTemperatureMargin" ]
- },
- "ipmiHsbp": {
- "description": "intelligent platform management interface (ipmi) hot swap backplane power metrics",
- "type": "object",
- "properties": {
- "hsbpIdentifier": {
- "description": "identifier for the hot swap backplane power unit",
- "type": "string"
- },
- "hsbpTemperature": {
- "description": "hot swap backplane power temperature in celsius",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "hsbpIdentifier" ]
- },
- "ipmiNic": {
- "description": "intelligent platform management interface (ipmi) network interface control card (nic) metrics",
- "type": "object",
- "properties": {
- "nicIdentifier": {
- "description": "identifier for the network interface control card",
- "type": "string"
- },
- "nicTemperature": {
- "description": "nic temperature in celsius",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "nicIdentifier" ]
- },
- "ipmiPowerSupply": {
- "description": "intelligent platform management interface (ipmi) power supply metrics",
- "type": "object",
- "properties": {
- "powerSupplyIdentifier": {
- "description": "identifier for the power supply",
- "type": "string"
- },
- "powerSupplyInputPower": {
- "description": "input power in watts",
- "type": "number"
- },
- "powerSupplyCurrentOutputPercent": {
- "description": "current output voltage as a percentage of the design specified level",
- "type": "number"
- },
- "powerSupplyTemperature": {
- "description": "power supply temperature in celsius",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "powerSupplyIdentifier" ]
- },
- "ipmiProcessor": {
- "description": "intelligent platform management interface processor metrics",
- "type": "object",
- "properties": {
- "processorIdentifier": {
- "description": "identifier for an ipmi processor",
- "type": "string"
- },
- "processorThermalControlPercent": {
- "description": "io module temperature in celsius",
- "type": "number"
- },
- "processorDtsThermalMargin": {
- "description": "front panel temperature in celsius",
- "type": "number"
- },
- "processorDimmAggregateThermalMarginArray": {
- "description": "array of processorDimmAggregateThermalMargin objects",
- "type": "array",
- "items": {
- "$ref": "#/definitions/processorDimmAggregateThermalMargin"
- }
- }
- },
- "additionalProperties": false,
- "required": [ "processorIdentifier" ]
- },
- "jsonObject": {
- "description": "json object schema, name and other meta-information along with one or more object instances",
- "type": "object",
- "properties": {
- "objectInstances": {
- "description": "one or more instances of the jsonObject",
- "type": "array",
- "items": {
- "$ref": "#/definitions/jsonObjectInstance"
- }
- },
- "objectName": {
- "description": "name of the JSON Object",
- "type": "string"
- },
- "objectSchema": {
- "description": "json schema for the object",
- "type": "string"
- },
- "objectSchemaUrl": {
- "description": "Url to the json schema for the object",
- "type": "string"
- },
- "nfSubscribedObjectName": {
- "description": "name of the object associated with the nfSubscriptonId",
- "type": "string"
- },
- "nfSubscriptionId": {
- "description": "identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "objectInstances", "objectName" ]
- },
- "jsonObjectInstance": {
- "description": "meta-information about an instance of a jsonObject along with the actual object instance",
- "type": "object",
- "properties": {
- "jsonObject": { "$ref": "#/definitions/jsonObject" },
- "objectInstance": {
- "description": "an instance conforming to the jsonObject objectSchema",
- "type": "object"
- },
- "objectInstanceEpochMicrosec": {
- "description": "the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
- "type": "number"
- },
- "objectKeys": {
- "description": "an ordered set of keys that identifies this particular instance of jsonObject",
- "type": "array",
- "items": {
- "$ref": "#/definitions/key"
- }
- }
- },
- "additionalProperties": false
- },
- "key": {
- "description": "tuple which provides the name of a key along with its value and relative order",
- "type": "object",
- "properties": {
- "keyName": {
- "description": "name of the key",
- "type": "string"
- },
- "keyOrder": {
- "description": "relative sequence or order of the key with respect to other keys",
- "type": "integer"
- },
- "keyValue": {
- "description": "value of the key",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "keyName" ]
- },
- "latencyBucketMeasure": {
- "description": "number of counts falling within a defined latency bucket",
- "type": "object",
- "properties": {
- "countsInTheBucket": { "type": "number" },
- "highEndOfLatencyBucket": { "type": "number" },
- "lowEndOfLatencyBucket": { "type": "number" }
- },
- "additionalProperties": false,
- "required": [ "countsInTheBucket" ]
- },
- "load": {
- "description": "/proc/loadavg cpu utilization and io utilization metrics",
- "type": "object",
- "properties": {
- "longTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg",
- "type": "number"
- },
- "midTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg",
- "type": "number"
- },
- "shortTerm": {
- "description": "number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg",
- "type": "number"
- }
- },
- "additionalProperties": false
- },
- "machineCheckException": {
- "description": "metrics on vm machine check exceptions",
- "type": "object",
- "properties": {
- "correctedMemoryErrors": {
- "description": "total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval",
- "type": "number"
- },
- "correctedMemoryErrorsIn1Hr": {
- "description": "total hardware errors that were corrected by the hardware over the last one hour",
- "type": "number"
- },
- "uncorrectedMemoryErrors": {
- "description": "total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval",
- "type": "number"
- },
- "uncorrectedMemoryErrorsIn1Hr": {
- "description": "total uncorrected hardware errors that were detected by the hardware over the last one hour",
- "type": "number"
- },
- "vmIdentifier": {
- "description": "virtual machine identifier associated with the machine check exception",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "vmIdentifier" ]
- },
- "measDataCollection": {
- "description": "3GPP measurement collection structure aligned with 3GPP PM format",
- "type": "object",
- "properties": {
- "formatVersion": {
- "description": "3gpp PM reporting file format version from pre-standard TS 28.550 v2.0.0",
- "type": "string"
- },
- "granularityPeriod": {
- "description": "granularity period for the PM report in seconds",
- "type": "number"
- },
- "measInfoList": {
- "description": "array of measurements",
- "type": "array",
- "items": { "$ref": "#/definitions/measInfo" }
- },
- "measObjInstIdList": {
- "description": "array of monitored object local distinguished name ids per 3GPP TS 32.300",
- "type": "array",
- "items": { "type": "string" }
- },
- "measuredEntityDn": {
- "description": "distinguished name per 3GPP TS 28.550",
- "type": "string"
- },
- "measuredEntitySoftwareVersion": {
- "description": "software version for the NF providing the PM data as specified in 3GPP TS 28.550",
- "type": "string"
- },
- "measuredEntityUserName": {
- "description": "user definable name for the measured object per 3GPP TS 28.550",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "granularityPeriod", "measInfoList", "measuredEntityDn" ]
- },
- "measInfo": {
- "description": "measurement information.",
- "type": "object",
- "properties": {
- "jobId": {
- "description": "name of the measurement job",
- "type": "string"
- },
- "measInfoId": {
- "description": "measurement group identifier",
- "oneOf": [
- { "$ref": "#/definitions/measInfoIdInteger" },
- { "$ref": "#/definitions/measInfoIdString" }
- ]
- },
- "measTypes": {
- "oneOf": [
- { "$ref": "#/definitions/measTypesInteger" },
- { "$ref": "#/definitions/measTypesString" }
- ]
- },
- "measValuesList": {
- "description": "an array of measurement values",
- "type": "array",
- "items": {
- "$ref": "#/definitions/measValues"
- }
- }
- },
- "additionalProperties": false,
- "required": ["measTypes", "measValues"]
- },
- "measInfoIdInteger": {
- "description": "integer measurement group identifier",
- "type": "object",
- "properties": {
- "iMeasInfoId": { "type": "integer" }
- },
- "additionalProperties": false,
- "required": ["iMeasInfoId"]
- },
- "measInfoIdString": {
- "description": "string measurement group identifier",
- "type": "object",
- "properties": {
- "sMeasInfoId": { "type": "string" }
- },
- "additionalProperties": false,
- "required": ["sMeasInfoId"]
- },
- "measResultInteger": {
- "description": "integer 3GPP PM measurement result",
- "type": "object",
- "properties": {
- "p": {
- "description": "integer reference to the counter",
- "type": "integer"
- },
- "iValue": {
- "description": "integer counter value",
- "type": "integer"
- }
- },
- "additionalProperties": false,
- "required": ["p", "iValue"]
- },
- "measResultNull": {
- "description": "null 3GPP PM measurement result",
- "type": "object",
- "properties": {
- "p": {
- "description": "integer reference to the counter",
- "type": "integer"
- },
- "isNull": {
- "description": "true if the counter has no value",
- "type": "string",
- "enum": [ "true", "false" ]
- }
- },
- "additionalProperties": false,
- "required": ["p", "isNull"]
- },
- "measResultNumber": {
- "description": "number 3GPP PM measurement result",
- "type": "object",
- "properties": {
- "p": {
- "description": "integer reference to the counter",
- "type": "integer"
- },
- "rValue": {
- "description": "numeric counter value",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": ["p", "rValue"]
- },
- "measResultString": {
- "description": "string 3GPP PM measurement result",
- "type": "object",
- "properties": {
- "p": {
- "description": "integer reference to the counter",
- "type": "integer"
- },
- "sValue": {
- "description": "string counter value",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": ["p", "sValue"]
- },
- "measTypesInteger": {
- "description": "object containing an array of integer measurement identifiers associated with the measurement results",
- "type": "object",
- "properties": {
- "iMeasTypesList": {
- "type": "array",
- "items": { "type": "integer" }
- }
- },
- "additionalProperties": false,
- "required": ["iMeasTypesList"]
- },
- "measTypesString": {
- "description": "object containing an array of string measurement identifiers associated with the measurement results",
- "type": "object",
- "properties": {
- "sMeasTypesList": {
- "type": "array",
- "items": { "type": "string" }
- }
- },
- "additionalProperties": false,
- "required": ["iMeasTypesList"]
- },
- "measurementFields": {
- "description": "measurement fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "additionalMeasurements": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "additionalObjects": {"$ref": "#/definitions/arrayOfJsonObject"},
- "codecUsageArray": {
- "description": "array of codecs in use",
- "type": "array",
- "items": {
- "$ref": "#/definitions/codecsInUse"
- }
- },
- "concurrentSessions": {
- "description": "peak concurrent sessions for the VM or xNF over the measurementInterval",
- "type": "integer"
- },
- "configuredEntities": {
- "description": "over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the xNF",
- "type": "integer"
- },
- "cpuUsageArray": {
- "description": "usage of an array of CPUs",
- "type": "array",
- "items": {
- "$ref": "#/definitions/cpuUsage"
- }
- },
- "diskUsageArray": {
- "description": "usage of an array of disks",
- "type": "array",
- "items": {
- "$ref": "#/definitions/diskUsage"
- }
- },
- "featureUsageArray": { "$ref": "#/definitions/hashMap" },
- "filesystemUsageArray": {
- "description": "filesystem usage of the VM on which the xNFC reporting the event is running",
- "type": "array",
- "items": {
- "$ref": "#/definitions/filesystemUsage"
- }
- },
- "hugePagesArray": {
- "description": "array of metrics on hugepPages",
- "type": "array",
- "items": {
- "$ref": "#/definitions/hugePages"
- }
- },
- "ipmi": { "$ref": "#/definitions/ipmi" },
- "latencyDistribution": {
- "description": "array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges",
- "type": "array",
- "items": {
- "$ref": "#/definitions/latencyBucketMeasure"
- }
- },
- "loadArray": {
- "description": "array of system load metrics",
- "type": "array",
- "items": {
- "$ref": "#/definitions/load"
- }
- },
- "machineCheckExceptionArray": {
- "description": "array of machine check exceptions",
- "type": "array",
- "items": {
- "$ref": "#/definitions/machineCheckException"
- }
- },
- "meanRequestLatency": {
- "description": "mean seconds required to respond to each request for the VM on which the xNFC reporting the event is running",
- "type": "number"
- },
- "measurementInterval": {
- "description": "interval over which measurements are being reported in seconds",
- "type": "number"
- },
- "measurementFieldsVersion": {
- "description": "version of the measurementFields block",
- "type": "string",
- "enum": [ "4.0" ]
- },
- "memoryUsageArray": {
- "description": "memory usage of an array of VMs",
- "type": "array",
- "items": {
- "$ref": "#/definitions/memoryUsage"
- }
- },
- "numberOfMediaPortsInUse": {
- "description": "number of media ports in use",
- "type": "integer"
- },
- "requestRate": {
- "description": "peak rate of service requests per second to the xNF over the measurementInterval",
- "type": "number"
- },
- "nfcScalingMetric": {
- "description": "represents busy-ness of the network function from 0 to 100 as reported by the xNFC",
- "type": "integer"
- },
- "nicPerformanceArray": {
- "description": "usage of an array of network interface cards",
- "type": "array",
- "items": {
- "$ref": "#/definitions/nicPerformance"
- }
- },
- "processStatsArray": {
- "description": "array of metrics on system processes",
- "type": "array",
- "items": {
- "$ref": "#/definitions/processStats"
- }
- }
- },
- "additionalProperties": false,
- "required": [ "measurementInterval", "measurementFieldsVersion" ]
- },
- "measValues": {
- "description": "3GPP measurement values",
- "type": "object",
- "properties": {
- "measObjAddlFlds": {
- "$ref": "#/definitions/hashMap"
- },
- "measObjInstId": {
- "description": "monitored object local distinguished name per 3GPP TS 32.300 and 3GPP TS 32.432",
- "type": "string"
- },
- "measResults": {
- "description": "array of results",
- "type": "array",
- "items": {
- "oneOf": [
- { "$ref": "#/definitions/measResultInteger" },
- { "$ref": "#/definitions/measResultNull" },
- { "$ref": "#/definitions/measResultNumber" },
- { "$ref": "#/definitions/measResultString" }
- ]
- }
- },
- "suspectFlag": {
- "description": "indicates if the values are suspect",
- "type": "string",
- "enum": [ "true", "false" ]
- }
- },
- "additionalProperties": false,
- "required": ["measObjInstId", "measResults"]
- },
- "memoryUsage": {
- "description": "memory usage of an identified virtual machine",
- "type": "object",
- "properties": {
- "memoryBuffered": {
- "description": "kibibytes of temporary storage for raw disk blocks",
- "type": "number"
- },
- "memoryCached": {
- "description": "kibibytes of memory used for cache",
- "type": "number"
- },
- "memoryConfigured": {
- "description": "kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running",
- "type": "number"
- },
- "memoryDemand": {
- "description": "host demand in kibibytes",
- "type": "number"
- },
- "memoryFree": {
- "description": "kibibytes of physical RAM left unused by the system",
- "type": "number"
- },
- "memoryLatencyAvg": {
- "description": "Percentage of time the VM is waiting to access swapped or compressed memory",
- "type": "number"
- },
- "memorySharedAvg": {
- "description": "shared memory in kilobytes",
- "type": "number"
- },
- "memorySlabRecl": {
- "description": "the part of the slab that can be reclaimed such as caches measured in kibibytes",
- "type": "number"
- },
- "memorySlabUnrecl": {
- "description": "the part of the slab that cannot be reclaimed even when lacking memory measured in kibibytes",
- "type": "number"
- },
- "memorySwapInAvg": {
- "description": "Amount of memory swapped-in from host cache in kibibytes",
- "type": "number"
- },
- "memorySwapInRateAvg": {
- "description": "rate at which memory is swapped from disk into active memory during the interval in kilobytes per second",
- "type": "number"
- },
- "memorySwapOutAvg": {
- "description": "Amount of memory swapped-out to host cache in kibibytes",
- "type": "number"
- },
- "memorySwapOutRateAvg": {
- "description": "rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second",
- "type": "number"
- },
- "memorySwapUsedAvg": {
- "description": "space used for caching swapped pages in the host cache in kibibytes",
- "type": "number"
- },
- "memoryUsed": {
- "description": "total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes",
- "type": "number"
- },
- "percentMemoryUsage": {
- "description": "Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise",
- "type": "number"
- },
- "vmIdentifier": {
- "description": "virtual machine identifier associated with the memory metrics",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "memoryFree", "memoryUsed", "vmIdentifier" ]
- },
- "mobileFlowFields": {
- "description": "mobileFlow fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "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": "string",
- "enum": [ "4.0" ]
- },
- "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": "integer"
- },
- "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": "integer"
- },
- "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": "integer"
- },
- "tac": {
- "description": "transport area code",
- "type": "string"
- },
- "tunnelId": {
- "description": "tunnel identifier",
- "type": "string"
- },
- "vlanId": {
- "description": "VLAN identifier used by this flow",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "flowDirection", "gtpPerFlowMetrics", "ipProtocolType", "ipVersion",
- "mobileFlowFieldsVersion", "otherEndpointIpAddress", "otherEndpointPort",
- "reportingEndpointIpAddr", "reportingEndpointPort" ]
- },
- "namedHashMap": {
- "description": "a hashMap which is associated with and described by a name",
- "type": "object",
- "properties": {
- "name": { "type": "string" },
- "hashMap": { "$ref": "#/definitions/hashMap" }
- },
- "additionalProperties": false,
- "required": [ "name", "hashMap" ]
- },
- "nicPerformance": {
- "description": "describes the performance and errors of an identified network interface card",
- "type": "object",
- "properties": {
- "administrativeState": {
- "description": "administrative state",
- "type": "string",
- "enum": [ "inService", "outOfService" ]
- },
- "nicIdentifier": {
- "description": "nic identification",
- "type": "string"
- },
- "operationalState": {
- "description": "operational state",
- "type": "string",
- "enum": [ "inService", "outOfService" ]
- },
- "receivedBroadcastPacketsAccumulated": {
- "description": "Cumulative count of broadcast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedBroadcastPacketsDelta": {
- "description": "Count of broadcast packets received within the measurement interval",
- "type": "number"
- },
- "receivedDiscardedPacketsAccumulated": {
- "description": "Cumulative count of discarded packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedDiscardedPacketsDelta": {
- "description": "Count of discarded packets received within the measurement interval",
- "type": "number"
- },
- "receivedErrorPacketsAccumulated": {
- "description": "Cumulative count of error packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedErrorPacketsDelta": {
- "description": "Count of error packets received within the measurement interval",
- "type": "number"
- },
- "receivedMulticastPacketsAccumulated": {
- "description": "Cumulative count of multicast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedMulticastPacketsDelta": {
- "description": "Count of multicast packets received within the measurement interval",
- "type": "number"
- },
- "receivedOctetsAccumulated": {
- "description": "Cumulative count of octets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedOctetsDelta": {
- "description": "Count of octets received within the measurement interval",
- "type": "number"
- },
- "receivedTotalPacketsAccumulated": {
- "description": "Cumulative count of all packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedPercentDiscard": {
- "description": "Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise",
- "type": "number"
- },
- "receivedPercentError": {
- "description": "Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise.",
- "type": "number"
- },
- "receivedTotalPacketsDelta": {
- "description": "Count of all packets received within the measurement interval",
- "type": "number"
- },
- "receivedUnicastPacketsAccumulated": {
- "description": "Cumulative count of unicast packets received as read at the end of the measurement interval",
- "type": "number"
- },
- "receivedUnicastPacketsDelta": {
- "description": "Count of unicast packets received within the measurement interval",
- "type": "number"
- },
- "receivedUtilization": {
- "description": "Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise",
- "type": "number"
- },
- "speed": {
- "description": "Speed configured in mbps",
- "type": "number"
- },
- "transmittedBroadcastPacketsAccumulated": {
- "description": "Cumulative count of broadcast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedBroadcastPacketsDelta": {
- "description": "Count of broadcast packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedDiscardedPacketsAccumulated": {
- "description": "Cumulative count of discarded packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedDiscardedPacketsDelta": {
- "description": "Count of discarded packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedErrorPacketsAccumulated": {
- "description": "Cumulative count of error packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedErrorPacketsDelta": {
- "description": "Count of error packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedMulticastPacketsAccumulated": {
- "description": "Cumulative count of multicast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedMulticastPacketsDelta": {
- "description": "Count of multicast packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedOctetsAccumulated": {
- "description": "Cumulative count of octets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedOctetsDelta": {
- "description": "Count of octets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedTotalPacketsAccumulated": {
- "description": "Cumulative count of all packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedTotalPacketsDelta": {
- "description": "Count of all packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedUnicastPacketsAccumulated": {
- "description": "Cumulative count of unicast packets transmitted as read at the end of the measurement interval",
- "type": "number"
- },
- "transmittedUnicastPacketsDelta": {
- "description": "Count of unicast packets transmitted within the measurement interval",
- "type": "number"
- },
- "transmittedPercentDiscard": {
- "description": "Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise",
- "type": "number"
- },
- "transmittedPercentError": {
- "description": "Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise",
- "type": "number"
- },
- "transmittedUtilization": {
- "description": "Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise.",
- "type": "number"
- },
- "valuesAreSuspect": {
- "description": "Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions",
- "type": "string",
- "enum": [ "true", "false" ]
- }
- },
- "additionalProperties": false,
- "required": [ "nicIdentifier", "valuesAreSuspect" ]
- },
- "notificationFields": {
- "description": "notification fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "arrayOfNamedHashMap": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "changeContact": {
- "description": "identifier for a contact related to the change",
- "type": "string"
- },
- "changeIdentifier": {
- "description": "system or session identifier associated with the change",
- "type": "string"
- },
- "changeType": {
- "description": "describes what has changed for the entity",
- "type": "string"
- },
- "newState": {
- "description": "new state of the entity",
- "type": "string"
- },
- "oldState": {
- "description": "previous state of the entity",
- "type": "string"
- },
- "notificationFieldsVersion": {
- "description": "version of the notificationFields block",
- "type": "string",
- "enum": [ "2.0" ]
- },
- "stateInterface": {
- "description": "card or port name of the entity that changed state",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "changeIdentifier", "changeType", "notificationFieldsVersion" ]
- },
- "otherFields": {
- "description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration",
- "type": "object",
- "properties": {
- "arrayOfNamedHashMap": {"$ref": "#/definitions/arrayOfNamedHashMap"},
- "hashMap": {"$ref": "#/definitions/hashMap"},
- "jsonObjects": {"$ref": "#/definitions/arrayOfJsonObject"},
- "otherFieldsVersion": {
- "description": "version of the otherFields block",
- "type": "string",
- "enum": [ "3.0" ]
- }
- },
- "additionalProperties": false,
- "required": [ "otherFieldsVersion" ]
- },
- "perf3gppFields": {
- "description": "fields for 3GPP PM format events, based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the commonEventHeader domain enumeration",
- "type": "object",
- "properties": {
- "eventAddlFields": {"$ref": "#/definitions/hashMap"},
- "measDataCollection": {"$ref": "#/definitions/measDataCollection"},
- "perf3gppFieldsVersion": {
- "description": "version of the perf3gppFields block",
- "type": "string",
- "enum": [ "1.0" ]
- }
- },
- "additionalProperties": false,
- "required": [ "measDataCollection", "perf3gppFieldsVersion" ]
- },
- "pnfRegistrationFields": {
- "description": "hardware device registration fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "lastServiceDate": {
- "description": "TS 32.692 dateOfLastService = date of last service; e.g. 15022017",
- "type": "string"
- },
- "macAddress": {
- "description": "MAC address of OAM interface of the unit",
- "type": "string"
- },
- "manufactureDate": {
- "description": "TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016",
- "type": "string"
- },
- "modelNumber": {
- "description": "TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model",
- "type": "string"
- },
- "oamV4IpAddress": {
- "description": "IPv4 m-plane IP address to be used by the manager to contact the PNF",
- "type": "string"
- },
- "oamV6IpAddress": {
- "description": "IPv6 m-plane IP address to be used by the manager to contact the PNF",
- "type": "string"
- },
- "pnfRegistrationFieldsVersion": {
- "description": "version of the pnfRegistrationFields block",
- "type": "string",
- "enum": [ "2.0" ]
- },
- "serialNumber": {
- "description": "TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3",
- "type": "string"
- },
- "softwareVersion": {
- "description": "TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201",
- "type": "string"
- },
- "unitFamily": {
- "description": "TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU",
- "type": "string"
- },
- "unitType": {
- "description": "TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale",
- "type": "string"
- },
- "vendorName": {
- "description": "TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "pnfRegistrationFieldsVersion" ]
- },
- "processorDimmAggregateThermalMargin": {
- "description": "intelligent platform management interface (ipmi) processor dual inline memory module aggregate thermal margin metrics",
- "type": "object",
- "properties": {
- "processorDimmAggregateThermalMarginIdentifier": {
- "description": "identifier for the aggregate thermal margin metrics from the processor dual inline memory module",
- "type": "string"
- },
- "thermalMargin": {
- "description": "the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "processorDimmAggregateThermalMarginIdentifier", "thermalMargin" ]
- },
- "processStats": {
- "description": "metrics on system processes",
- "type": "object",
- "properties": {
- "forkRate": {
- "description": "the number of threads created since the last reboot",
- "type": "number"
- },
- "processIdentifier": {
- "description": "processIdentifier",
- "type": "string"
- },
- "psStateBlocked": {
- "description": "the number of processes in a blocked state",
- "type": "number"
- },
- "psStatePaging": {
- "description": "the number of processes in a paging state",
- "type": "number"
- },
- "psStateRunning": {
- "description": "the number of processes in a running state",
- "type": "number"
- },
- "psStateSleeping": {
- "description": "the number of processes in a sleeping state",
- "type": "number"
- },
- "psStateStopped": {
- "description": "the number of processes in a stopped state",
- "type": "number"
- },
- "psStateZombie": {
- "description": "the number of processes in a zombie state",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "processIdentifier" ]
- },
- "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"
- }
- },
- "additionalProperties": false,
- "required": [ "messageId", "text" ]
- },
- "sipSignalingFields": {
- "description": "sip signaling fields",
- "type": "object",
- "properties": {
- "additionalInformation": { "$ref": "#/definitions/hashMap"},
- "compressedSip": {
- "description": "the full SIP request/response including headers and bodies",
- "type": "string"
- },
- "correlator": {
- "description": "this is the same for all events on this call",
- "type": "string"
- },
- "localIpAddress": {
- "description": "IP address on xNF",
- "type": "string"
- },
- "localPort": {
- "description": "port on xNF",
- "type": "string"
- },
- "remoteIpAddress": {
- "description": "IP address of peer endpoint",
- "type": "string"
- },
- "remotePort": {
- "description": "port of peer endpoint",
- "type": "string"
- },
- "sipSignalingFieldsVersion": {
- "description": "version of the sipSignalingFields block",
- "type": "string",
- "enum": [ "3.0" ]
- },
- "summarySip": {
- "description": "the SIP Method or Response ('INVITE', '200 OK', 'BYE', etc)",
- "type": "string"
- },
- "vendorNfNameFields": {
- "$ref": "#/definitions/vendorNfNameFields"
- }
- },
- "additionalProperties": false,
- "required": [ "correlator", "localIpAddress", "localPort", "remoteIpAddress",
- "remotePort", "sipSignalingFieldsVersion", "vendorNfNameFields" ]
- },
- "stateChangeFields": {
- "description": "stateChange fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "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": "string",
- "enum": [ "4.0" ]
- },
- "stateInterface": {
- "description": "card or port name of the entity that changed state",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "newState", "oldState", "stateChangeFieldsVersion", "stateInterface" ]
- },
- "syslogFields": {
- "description": "sysLog fields",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap" },
- "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": "integer"
- },
- "syslogFieldsVersion": {
- "description": "version of the syslogFields block",
- "type": "string",
- "enum": [ "4.0" ]
- },
- "syslogMsg": {
- "description": "syslog message",
- "type": "string"
- },
- "syslogMsgHost": {
- "description": "hostname parsed from non-VES syslog message",
- "type": "string"
- },
- "syslogPri": {
- "description": "0-192 combined severity and facility",
- "type": "integer"
- },
- "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",
- "enum": [
- "Alert",
- "Critical",
- "Debug",
- "Emergency",
- "Error",
- "Info",
- "Notice",
- "Warning"
- ]
- },
- "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"
- },
- "syslogTs": {
- "description": "timestamp parsed from non-VES syslog message",
- "type": "string"
- },
- "syslogVer": {
- "description": "IANA assigned version of the syslog protocol specification - typically 1",
- "type": "number"
- }
- },
- "additionalProperties": false,
- "required": [ "eventSourceType", "syslogFieldsVersion", "syslogMsg", "syslogTag" ]
- },
- "thresholdCrossingAlertFields": {
- "description": "fields specific to threshold crossing alert events",
- "type": "object",
- "properties": {
- "additionalFields": { "$ref": "#/definitions/hashMap"},
- "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": "string",
- "enum": [ "4.0" ]
- }
- },
- "additionalProperties": false,
- "required": [
- "additionalParameters",
- "alertAction",
- "alertDescription",
- "alertType",
- "collectionTimestamp",
- "eventSeverity",
- "eventStartTimestamp",
- "thresholdCrossingFieldsVersion"
- ]
- },
- "vendorNfNameFields": {
- "description": "provides vendor, nf and nfModule identifying information",
- "type": "object",
- "properties": {
- "vendorName": {
- "description": "network function vendor name",
- "type": "string"
- },
- "nfModuleName": {
- "description": "name of the nfModule generating the event",
- "type": "string"
- },
- "nfName": {
- "description": "name of the network function generating the event",
- "type": "string"
- }
- },
- "additionalProperties": false,
- "required": [ "vendorName" ]
- },
- "voiceQualityFields": {
- "description": "provides statistics related to customer facing voice products",
- "type": "object",
- "properties": {
- "additionalInformation": { "$ref": "#/definitions/hashMap"},
- "calleeSideCodec": {
- "description": "callee codec for the call",
- "type": "string"
- },
- "callerSideCodec": {
- "description": "caller codec for the call",
- "type": "string"
- },
- "correlator": {
- "description": "this is the same for all events on this call",
- "type": "string"
- },
- "endOfCallVqmSummaries": {
- "$ref": "#/definitions/endOfCallVqmSummaries"
- },
- "phoneNumber": {
- "description": "phone number associated with the correlator",
- "type": "string"
- },
- "midCallRtcp": {
- "description": "Base64 encoding of the binary RTCP data excluding Eth/IP/UDP headers",
- "type": "string"
- },
- "vendorNfNameFields": {
- "$ref": "#/definitions/vendorNfNameFields"
- },
- "voiceQualityFieldsVersion": {
- "description": "version of the voiceQualityFields block",
- "type": "string",
- "enum": [ "4.0" ]
- }
- },
- "additionalProperties": false,
- "required": [ "calleeSideCodec", "callerSideCodec", "correlator", "midCallRtcp",
- "vendorNfNameFields", "voiceQualityFieldsVersion" ]
- }
- }
-}
\ No newline at end of file diff --git a/docs/files/EventRegistration-v2.0.rst b/docs/files/EventRegistration-v2.0.rst deleted file mode 100644 index 917b997..0000000 --- a/docs/files/EventRegistration-v2.0.rst +++ /dev/null @@ -1,2884 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -========================== -VES Event Registration 2.0 -========================== - -.. contents:: Table of Contents - -Introduction -============ - -This document specifies a YAML format for the registration of VES -Events. The YAML format enables both human designers and applications to -parse and understand the fields that will be sent by event sources in -conjunction with specific types of events, which are identified by their -eventNames. - -The semantics of the YAML format are easily extensible to accommodate -processing needs that may arise in the future. Among the types of -information specified in the YAML are field optionality, restrictions on -field values, and event handling recommendations and requirements. - -This document should be read in conjunction with the VES Event Listener -service specification, which defines the Common Event Format and -introduces the concept of specific types of events, identified by -eventNames. - -Audience --------- - -This document is intended to support the following groups: - -- VNF Vendors - -- Service Provider (e.g., AT&T) Teams responsible for deploying VNFs - within their infrastructure - -VNF vendors will provide a YAML file to the Service Provider that -describes the events that their VNFs generate. Using the semantics and -syntax supported by YAML, vendors will indicate specific conditions that -may arise, and recommend actions that should be taken at specific -thresholds, or if specific conditions repeat within a specified time -interval. - -Based on the vendor’s recommendations, the Service Provider may create -another YAML, which finalizes their engineering rules for the processing -of the vendor’s events. The Service Provider may alter the threshold -levels recommended by the vendor, and may modify and more clearly -specify actions that should be taken when specified conditions arise. -The Service Provided-created version of the YAML will be distributed to -Service Provider applications at design time. - -Goal ----- - -The goal of the YAML is to completely describe the processing of VNF -events in a way that can be compiled or interpreted by applications -across a Service Provider’s infrastructure. - -Relation to the Common Event Format ------------------------------------ - -The Common Event Format described in the VES Event Listener service -specification defines the structure of VES events including optional -fields that may be provided. - -Specific eventNames registered by the YAML (e.g., an InvalidLicense -fault), may require that certain fields, which are optional in the -Common Event Format, be present when events with that eventName are -published. For example, a fault eventName which communicates an -‘InvalidLicense’ condition, may be registered to require that the -configured ‘licenseKey’ be provided as a name-value pair in the Common -Event Format’s ‘additionalFields’ structure, within the ‘faultFields’ -block. Anytime an ‘InvalidLicense’ fault event is detected, designers, -applications and microservices across the Service Provider’s -infrastructure can count on that name-value pair being present. - -The YAML registration may also restrict ranges or enumerations defined -in the Common Event Format. For example, eventSeverity is an enumerated -string within the Common Event Format with several values ranging from -‘NORMAL’ to ‘CRITICAL’. The YAML registration for a particular eventName -may require that it always be sent with eventSeverity set to a single -value (e.g., ‘MINOR’), or to a subset of the possible enumerated values -allowed by the Common Event Format (e.g., ‘MINOR’ or ‘NORMAL’). - -Relation to Service Design and Creation ---------------------------------------- - -Event registration for a VNF (or other event source) is provided to the -Service Provider’s Service Creation and Design Environment (e.g., SDC) -as a set of two YAML files consisting of the vendor recommendation YAML -and (optionally) the final Service Provider YAML. These YAML files -describe all the eventNames that that VNF (or other event source) -generates. - -Once their events are registered, the Service Creation and Design -Environment can then list the registered eventNames (e.g., as a drop -down list), for each VNF or other event source (e.g., a service), and -enable designers to study the YAML registrations for specific -eventNames. YAML registrations are both human readable and machine -readable. - -The final Service Provider YAML is a type of Service Design and Creation -‘artifact’, which can be distributed to Service Provider applications at -design time: notably, to applications involved in the collection and -processing of VNF events. It can be parsed by those applications so they -can support the receipt and processing of VNF events, without the need -for any manual, VNF-specific development. - -YAML Files -========== - -YAML Specification Conformance ------------------------------- - -YAML files should conform to version 1.2 of the YAML specification -available at: http://yaml.org/spec/1.2/spec.html. - -Filename --------- - -YAML file names should conform to the following naming convention: - - {NamingCode}_{ModelType}_{v#}_{AdditionalInfo}.yml - -The NamingCode identifies the entity, whose events are being registered -in the yaml, with a naming code that was established in the Service -Providers’ Service Design and Creation Environment (SDC). Example Naming -codes are: - -- tbcx - -- sgsn-mme - -The ModelType describes the type of entity whose events are being -registered. It consists of values like: - -- service - -- vfModule - -- vnf - -- vnfc - -The ‘#’ should be replaced with the current numbered version of the -file. Note that ‘#’ can be an integer or a number of the form x.y or -x.y.z (where x is the major number, y is the minor number and z is the -patch number) - -Additional descriptive info may be added after the version information - -Example file name: - -- vIsbcSsc_vnfc_v1.yml - -File Structure --------------- - -Each eventType is registered as a distinct YAML ‘document’. - -YAML files consist of a series of YAML documents delimited by ‘---‘ and -‘…’ for example: - - --- - - # Event Registration for eventName ‘name1’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name2’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name3’ - - # details omitted - - ... - -YAML Syntax and Semantics -========================= - -YAML registration documents show each relevant VES Common Event Model -object and field (i.e., each element) for the eventName being -registered, including any extensible fields (e.g., specific name-value -pairs). - -Qualifiers ----------- - -Each object or field name in the eventName being registered is followed -by a ‘qualifier’, which consists of a colon and two curly braces, for -example: - - “objectOrFieldName: { }” - -The curly braces contain meta-information about that object or field -name (also known as the ‘element’), such as whether it is required to be -present, what values it may have, what handling it should trigger, etc… - -Semantics have been defined for the following types of meta-information -within the curly braces: - -Action -~~~~~~ - -The ‘action’ keyword may be applied to field values or to the event as a -whole. The ‘action’ keyword specifies a set of actions that should be -taken if a specified trigger occurs. For example, the ‘action’ keyword -may specify that a threshold crossing alert (i.e., tca) be generated, -and/or that a specific microservice handler be invoked, and/or that a -specific named-condition be asserted. In the Rules section of the YAML -file, tca’s and microservices may be defined on individual -named-conditions or on logical combinations of named-conditions. - -The ‘action:’ keyword is followed by five values in square brackets. The -first two values communicate the trigger, and the last three values -communicate the actions to be taken if that trigger occurs: - -1. The first value conveys the trigger level. If the field on which the - action is defined reaches or passes through that level, then the - trigger fires. If a specific level is not important to the - recommended action, the ‘any’ keyword may be used as the first value. - (Note: ‘any’ is often used when an action is defined on the ‘event’ - structure as a whole). - -2. The second value indicates the direction of traversal of the level - specified in the first value. The second value may be ‘up’, ‘down’, - ‘at’ or ‘any’. ‘any’ is used if the direction of traversal is not - important. ‘at’ implies that it traversed (or exactly attained) the - trigger level but it doesn’t matter if the traversal was in the up - direction or down direction. Note: If ‘up’, ‘down’ or ‘at’ are used, - the implication is that the microservices processing the events - within the service provider are maintaining state (e.g., to know that - a measurement field traversed a trigger level in an ‘up’ direction, - the microservice would have to know that the field was previously - below the trigger level). When initially implementing support for - YAML actions, a service provider may choose to use and interpret - these keywords in a simpler way to eliminate the need to handle - state. Specifically, they may choose to define and interpret all ‘up’ - guidance to mean ‘at the indicated trigger level or greater’, and - they may choose to define and interpret all ‘down’ guidance to mean - ‘at the indicated trigger level or lower’. - -3. The third value optionally names the condition that has been attained - when the triggers fires (e.g., ‘invalidLicence’ or - ‘capacityExhaustion’). Named-conditions should be expressed in camel - case with no underscores, hyphens or spaces and with the first letter - in lowercase. In the Rules section of the YAML file, named-conditions - may be used to specify events that should be generated and/or - microservices that should be invoked. If it is not important to name - a condition, then the string ‘null’ (without the quotes) must be used - as the third value. - -4. The fourth value recommends a specific microservice (e.g., ‘rebootVm’ - or ‘rebuildVnf’) supported by the Service Provider, be invoked if the - trigger is attained. Design time processing of the YAML by the - service provider can use these directives to automatically establish - policies and configure flows that need to be in place to support the - recommended runtime behavior. - -.. - - If a vendor wants to recommend an action, it can either work with the - service provider to identify and specify microservices that the - service provider support, or, the vendor may simply indicate and - recommend a generic microservice function by prefixing ‘RECO-’ in - front of the microservice name, which should be expressed in upper - camel case with no underscores, hyphens or spaces. - - A fourth value must be provided. If not needed, the string ‘null’ - (without the quotes) must be used. - -5. The fifth value indicates a specific named event (e.g., a TCA) that - should be generated if the trigger occurs. This field must be - provided as a VES eventName or, if not needed, as the string ‘null’ - (without the quotes). - -.. - - When an event is specified, a YAML registration for that eventName - should be added to the event registrations within the YAML file. - -Examples: - -- event: { action: [ any, any, null, rebootVm, null ] } - -.. - - # whenever the above event occurs, the VM should be rebooted - -- fieldname: { action: [ 80, up, null, null, tcaUpEventName ], action: - [ 60, down, overcapacity, null, null ] } - -.. - - # when the value of fieldname crosses 80 in an up direction, - tcaUpEventName - - should be published; if the fieldname crosses 60 in a down direction - an - - ‘overCapacity’ named-condition is asserted. - -AggregationRole -~~~~~~~~~~~~~~~ - -The ‘aggregationRole’ keyword is applied to a keyValuePair. - -AggregationRole may be set to one of the following: - -- counter - -- index - -- reference - -If needed, the aggergationRole setting tells the receiving event -processor how to aggregate the extensible keyValuePair data. Data -aggregation may use a combination of ‘index’ and ‘reference’ data fields -as aggregation keys while applying aggregation formulas, such as -summation or average on the ‘counter’ fields. - -Example 1: - - Interpretation of the below: If additionalMeasurements is supplied, - it must have key name1 and name1’s value should be interpreted as an - index: - -- additionalMeasurements: {presence: optional, structure: { - -.. - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: name1}, - - value: {presence: required, aggregationRole: index } - - }}, - - . . . - - }} - -Example 2: - -- Let’s say a vnf wants to send the following ‘TunnelTraffic’ fields - through a VES arrayOfNamedHashMap structure (specifically through - additionalMeasurements in the VES measurementField block): - -+-------------+-------------+-------------+-------------+-------------+ -| Tunnel Name | Tunnel Type | Total | Total | Total | -| | | Output | Output | Output | -| | | Bytes | Packets | Errors | -+=============+=============+=============+=============+=============+ -| ST6WA21CRS: | PRIMARY | 2457205 | 21505 | 0 | -| TUNNEL-TE40 | | | | | -| 018 | | | | | -+-------------+-------------+-------------+-------------+-------------+ -| ST6WA21CRS: | PRIMARY | 46677 | 220 | 0 | -| TUNNEL-TE10 | | | | | -| 29 | | | | | -+-------------+-------------+-------------+-------------+-------------+ -| ST6WA21CRS: | PRIMARY | 80346 | 577 | 0 | -| TUNNEL-TE10 | | | | | -| 28 | | | | | -+-------------+-------------+-------------+-------------+-------------+ - -- Tunnel Name is an index, Tunnel Type is reference data and the other - three columns are counters - -- The first three columns would be sent through VES as follows: - -additionalMeasurements: { presence: required, isHomogeneous: true, -array: [ - -namedHashMap: { presence: required, structure: { - -name: { presence: required, value: "TunnelTraffic" }, - -hashMap: { presence: required, array: [ - -keyValuePair: { presence: required, aggregationRole: index, structure: { - -key: { presence: required, value: TunnelName }, - -value: { presence: required } - -}}, - -keyValuePair: { presence: required, aggregationRole: reference, -structure: { - -key: { presence: required, value: TunnelType }, - -value: { presence: required } - -}}, - -keyValuePair: { presence: required, aggregationRole: counter, structure: -{ - -key: { presence: required, value: TotalOutputBytes }, - -value: { presence: required, castTo: integer } - -}} - -]} - -}} - -]} - -Array -~~~~~ - -The ‘array’ keyword indicates that the element is an array; ‘array:’ is -following by square brackets which contain the elements of the array. -Note that unlike JSON itself, the YAML registration will explicitly -declare the array elements and will not communicate them anonymously. - -Examples: - -- element: { array: [ - -.. - - firstArrayElement: { }, - - secondArrayElement: { } - - ] } - -CastTo -~~~~~~ - -The ‘castTo’ keyword is applied to ‘value’ keywords. It tells the -receiving event processor to cast the supplied value from its standard -VES datatype (typically a string) to some other datatype. If not -supplied the implication is the standard VES datatype applies. - -A value may be castTo one and only one of the following data types: - -- boolean - -- integer - -- number (note: this supports decimal values as well as integral - values) - -- string - -Example: - -- fieldname: { value: [ x, y, z ], castTo: number } # only values ‘x’, - ‘y’, or ‘z’ allowed - -.. - - # each must be cast to a number - -- additionalMeasurements: {presence: optional, structure: { - -.. - - keyValuePair: {presence: required, structure: { # if - additionalMeasurements is - - key: {presence: required, value: name1}, # supplied, it must have key - ‘name1’ - - value: {presence: required, castTo: integer} # its value must be cast - to integer - - }} - - }} - - For another example, see the second example under AggregationRole. - -Default -~~~~~~~ - -The ‘default’ keyword specifies a default field value. Note: the default -value must be within the range or enumeration of acceptable values. - -Examples: - -- fieldname: { range: [ 1, unbounded ], default: 5 } - -- fieldname: { value: [ red, white, blue ], default: blue } - -HeartbeatAction -~~~~~~~~~~~~~~~ - -The ‘heartbeatAction’ keyword is provided on the ‘event’ objectName for -heartbeat events only. It provides design time guidance to the service -provider’s heartbeat processing applications (i.e., their watchdog -timers). The syntax and semantics of the ‘heartbeatAction’ keyword are -similar to the ‘action’ keyword except the trigger is specified by the -first field only instead of the first two fields. When the -‘heartbeatAction’ keyword is indicated, the first field is an integer -indicating the number of successively missed heartbeat events. Should -that trigger occur, the remaining fields have the same order, meaning -and optionality as those described for the ‘action’ keyword. - -Examples: - -- event: { heartbeatAction: [ 3, vnfDown, RECO-rebootVnf, tcaEventName - ] } - -.. - - # whenever the above event occurs, a vnfDown condition is asserted - and the vnf should be rebooted, plus the indicated tca should be - generated. - -isHomogeneous -~~~~~~~~~~~~~ - -The isHomogeneous keyword is applied to fields containing -arrayOfNamedHashMap. It lets the receiving event processor know whether -each namedHashMap in the arrayOfNamedHashMap conveys the same data -structure or whether convey different data structures. - -isHomogeneous may be set to one of the following (note that lowercase -letters only should be used): - -- true - -- false - -Example: The second example for the AggregationRole keyword, shows how -isHomogeneous is used. In that example, the implication is that all -namedHashMapssent through additionalMeasurements would convey -TunnelTraffic data sets and thus the receiving event processor could -convert all the data within additionalMeasurements into a single table. - -On the other hand, if isHomogeneous had been set to ‘false’, that would -tell the receiving event processor that different types of data are -being conveyed through additionalMeasurements (e.g., maybe TunnelTraffic -data is sent in some namedHashMaps while QosReport data is sent in other -namedHashMaps) and the receiving event processor would have to process -it accordingly. - -key -~~~ - -The ‘key’ keyword describes a specific key as part of a key-value pair -that may be sent within a keyValuePair keyword (see ‘keyValuePair’ -keyword for more explanation and examples). - -keyValuePair -~~~~~~~~~~~~ - -The ‘keyValuePair’ keyword describes a specific key-value pair that may -be sent within a hashMap structure (i.e., a VES field with the hashMap -datatype) or a keyValuePairString structure (see the keyValuePairString -keyword for more information). - -Within keyValuePair is a single ‘key’ and a single ‘value’ keyword, each -of which may be decorated with other keywords specified in this document -(e.g., with ‘presence’, ‘range’ and other relevant keywords). - -Examples: - -- The following specifies an additionalInformation field within VES, - which is of type hashMap: - -.. - - additionalInformation: {presence: optional, structure: { - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: name1}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: optional, structure: { - - key: {presence: required, value: name2}, - - value: {presence: required} - - }} - - }} - -keyValuePairString -~~~~~~~~~~~~~~~~~~ - -The ‘keyValuePairString’ keyword describes the key-value pairs to be -communicated through a string (e.g., in the VES Syslog Fields -‘syslogSData’ or ‘additionalFields’ strings). This keyword takes three -parameters: - -- the first parameter specifies the character used to delimit (i.e., to - separate) the key-value pairs. If a space is used as a delimiter, - it should be communicated within single quotes as ‘ ‘; otherwise, - the delimiter character should be provided without any quotes. - -- The second parameter specifies the characters used to separate the - keys and values. If a space is used as a separator, it should be - communicated within single quotes as ‘ ‘; otherwise, the separator - character should be provided without any quotes. - -- The third parameter is a “sub-keyword” (i.e., it is used only within - ‘keyValuePairString’) called ‘keyValuePairs: [ ]’. Within the - square brackets, a list of ‘keyValuePair’ keywords can be provided - (see the ‘keyValuePair keyword for more information). - -Examples: - -- The following specifies an additionalFields string which is stuffed - with ‘key=value’ pairs delimited by the pipe (‘|’) symbol as in - (“key1=value1|key2=value2|key3=value3…”). - -additionalFields: {presence: required, keyValuePairString: {|, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: someKeyName}, - -value: {presence: required, range: [0, 100]} - -} }, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: someOtherKeyName}, - -value: {presence: required, value [red, white, blue]} - -} } - -] } } - -Presence -~~~~~~~~ - -The ‘presence’ keyword may be defined as ‘required’ or ‘optional’. If -not provided, the element is assumed to be ‘optional’. - -Examples - -- element: { presence: required } # element must be present - -- element: { presence: optional } # element is optional - -- element: { value: blue } # by omitting a presence definition, the - -.. - - element is assumed to be optional - -Range -~~~~~ - -The ‘range’ keyword applies to fields (i.e., simpleTypes); indicates the -value of the field is a number within a specified range of values from -low to high (inclusive of the indicated values). . ‘range:’ is followed -by two parameters in square brackets: - -- the first parameter conveys the minimum value - -- the second parameter conveys the maximum value or ‘unbounded’ - -The keyword ‘unbounded’ is supported to convey an unbounded upper limit. -Note that the range cannot override any restrictions defined in the VES -Common Event Format. - -Examples: - -- fieldname: { range: [ 1, unbounded ] } - -- fieldname: { range: [ 0, 3.14 ] } - -Structure -~~~~~~~~~ - -The ‘structure’ keyword indicates that the element is a complexType -(i.e., an object) and is followed by curly braces containing that -object. - -Example: - -- objectName: { structure: { - -element1: { }, - -element2: { }, - -anotherObject: { structure: { - -element3: { }, - -element4: { } - -} } - -} } - -Units -~~~~~ - -The ‘units’ qualifier may be applied to values provided in VES Common -Event Format extensible field structures. The ‘units’ qualifier -communicates the units (e.g., megabytes, seconds, Hz) that the value is -expressed in. Note: the ‘units’ should not contain any space characters -and should be expressed in camel casing (e.g., use ‘numberOfPorts’, not -‘number_of_ports’ nor ‘number of ports’). - -Example: - -- additionalInformation: { presence: optional, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: pilotNumberPoolSize}, - -value: {presence: required, units: megaBytes} - -}} - -}} - -Value -~~~~~ - -The ‘value’ keyword applies to fields (i.e., simpleTypes); indicates a -single value or an enumeration of possible values. If not provided, it -is assumed the value will be determined at runtime. Note that the -declared value cannot be inconsistent with restrictions defined in the -VES Common Event Format (e.g., it cannot add an enumerated value to an -enumeration defined in the Common Event Format, but it can subset the -defined enumerations in the Common Event Format). - -Values that are strings containing spaces should always be indicated in -single quotes. - -Examples: - -- fieldname: { value: x } # the value is ‘x’ - -- fieldname: { value: [ x, y, z ] } # the value is either ‘x’, ‘y’, or - ‘z’ - -- fieldname: { presence: required } # the value will be provided at - runtime - -- fieldname: { value: ‘error state’ } # the value is the string within - the single quotes - -Complex Conditions ------------------- - -Conditions Document -~~~~~~~~~~~~~~~~~~~ - -After all events have been defined, the YAML file may provide a YAML -document delimited by ‘---‘ and ‘…’, which specifies complex conditions -defined in terms of other conditions, which were asserted in the action -qualifiers of the preceding event definitions. For example: - - --- - - # Event Registration for eventName ‘name1’ - - event: {presence: required, action: [any, any, A, null], structure: { - - # details omitted - - }} - - ... - - --- - - # Event Registration for eventName ‘name2’ - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - # details omitted - - }} - - measurementFields: {presence: required, structure: { - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, action: [90, up, B, null]} - -}} - -]}, - -# details omitted - - }} - - }} - - ... - - --- - - # Complex Conditions - - conditions: [ - - conditionC: { defined in terms of A and B, details omitted }, - - conditionD: { defined in terms of A, B and C details omitted } - - ] - - ... - -Conditions Syntax and Semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The YAML ‘conditions’ document begins with the keyword ‘conditions’ -followed by a colon and square brackets. Each condition is then defined -within the square brackets. Commas are used to separate conditions. - -Each condition is expressed as follows: - -conditionName: *logical expression in terms of other conditions* - -Logical Expressions -~~~~~~~~~~~~~~~~~~~ - -The following logical operators are supported: - -- &&: which is a logical AND - -- \||, which is a logical OR - -In addition parentheses may be used to group expressions. - -Example logical expression: - - (A && B) \|\| (C && D) - -Where A, B, C and D are named conditions expressed earlier in the YAML -file. - -Because YAML doesn’t support the above operators, the whole expression -needs to be enclosed in double quotes. - -Example for a condition named ‘ConditionP’: - ---- - -conditions: [ - -conditionP: "B \|\| (C && D)" - -] - -... - -Alternatively, Logical ORs and ANDs can be expressed using a syntax -defined by `metacpan.org <https://metacpan.org/pod/YAML::Logic>`__ for -Perl. Using this syntax, the example above looks like this: - ---- - -conditions: [ - -conditionP: [or, [B, [and, [C, D]]]] - -] - -... - -In the above syntax, both ORs and ANDs are provided as two nested -arrays, where the outer array consists of two items: - -- The desired operator as either ‘or’ or ‘and’ - -- The inner array which consists of the conditions to be OR’d or AND’d - together - -Note1: more than two conditions may be or’d or and’d (e.g., “B \|\| C -\|\| D” or “B && C && D”) - -Note2: however expressed by YAML, parsers must be developed to make use -of the above expressions. - -Time Based Qualifiers -~~~~~~~~~~~~~~~~~~~~~ - -Time based rules may be established using a timing keyword as follows: - ---- - -conditions: [ - -PersistentB1: { - -timing: { - -condition: B, - -occurrences: 3, - -interval: 300, - -units: seconds - -} - -} - -] - -... - -This means that if condition B occurs 3 (or more) times in 300 seconds -(e.g., 5 minutes), then condition ‘PersistentB1’ has occurred. - -Array Item Qualifiers -~~~~~~~~~~~~~~~~~~~~~ - -This ‘arrayItems’ keyword defines conditions evaluated across the items -in an array. In the example below, the condition is named ‘AnyOfC’: - ---- - -conditions: [ - -AnyOfC: { - -arrayItems: { - -condition: C, - -arrayItem: measurements.cpuUsageArray.cpuUsage, - -scope: anyOf - -} - -} - -] - -... - -This means that if condition C occurs on any cpuUsage structure within -the cpuUsageArray, then the condition ‘AnyOfC’ is in effect. - -Note the dotted notation used to convey the path to the arrayItem with -respect to the encapsulating domain field block. - -Scope may have the values ‘anyOf’ or ‘allOf’ - -Mathematical Expressions -~~~~~~~~~~~~~~~~~~~~~~~~ - -Mathematical expressions evaluate to a number, using ‘(‘, ‘)’, ‘+’, ‘-‘, -‘*’, ‘/’ and variables of the form $variablePath where the variablePath -is defined with respect to the encapsulating domain field block. - -Mathematical expressions are specified as "${mathematicalExpress}". -Because YAML does not support mathematical operators, the expressions -must be enclosed within double quotes. - ---- - -conditions: [ - -PersistentB2: { - -timing: { - -condition: B, - -occurrences: 3, - -interval: "${60 \* $measurements.measurementInterval}", - -units: seconds - -} - -} - -] - -... - -This means that if condition B occurs 3 (or more) times in an interval -defined by 60 times the measurementInterval (e.g., if the -measurementInterval was expressed in seconds as 5, then this would -evaluate to 300), then condition ‘PersistentB2’ is in effect. - -Rules ------ - -Rules Document -~~~~~~~~~~~~~~ - -After all events and conditions have been defined, the YAML file may -conclude with a final YAML document delimited by ‘---‘ and ‘…’, which -defines rules based on the named ‘conditions’ asserted previously. For -example: - - --- - - # Event Registration for eventName ‘name1’ - - event: {presence: required, action: [any, any, A, null], structure: { - - # details omitted - - }} - - ... - - --- - - # Event Registration for eventName ‘name2’ - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - # details omitted - - }} - - measurementFields: {presence: required, structure: { - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, action: [90, up, B, null]} - -}} - -]}, - -# details omitted - - }} - - }} - - ... - - --- - - # Complex Conditions - - conditions: [ - - C: { details omitted } - - ] - - ... - - --- - - # Rules - - rules: [ - - # defined based on conditions ‘A’, ‘B’ and ‘C’ - details omitted - - ] - - ... - -Rules Syntax and Semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a -colon and square brackets. Each rule is then defined within the square -brackets (of ‘rules’). Commas are used to separate rule structure. - -Each rule structure is expressed as follows: - -rule: { - -trigger: *logical expression in terms of conditions*, - -microservices: [ *microservice1, microservice2, microservice3…* ] - -events: [e*ventName1, eventName2, eventName3…* ], - -} - -Notes: - -- All referenced eventNames should be defined within the YAML. - -- At least one microservice or event should be specified, and both - microservices and events may be specified. - -- For information about microservices, see section 3.1.1 bullet number - 4. - -Triggers -~~~~~~~~ - -Triggers may be as simple as a named condition, or they may be logical -expressions in terms of other conditions using the same syntax as used -by the complex conditions described above. For example: - -rules: [ - -ruleName1: { - -trigger: A, - -eventss: [eventName1], - -microservices: [rebootVm] - -}, - -ruleName2: { - -trigger: "B \|\| (C && D)", - -microservices: [scaleOut] - -} - -] - -Note: when microservices are defined in terms of multiple event -conditions, the designer should take care to consider whether the target -of the microservice is clear (e.g., which VNF or VM instance to perform -the action on). Future versions of this document may provide more -clarity. - -YAML Examples -============= - -An example YAML file is provided below which registers some events for a -hypothetical VNF. Note: some of the lines have been manually -wrapped/indented to make it easier to read. Please ignore the section -breaks that interrupt this single file; they were added to make it -easier to rapidly find examples of different types of events. - -Fault ------ - ---- - -# registration for Fault_vMrf_alarm003 - -# Constants: the values of domain, eventName, priority, vfstatus - -# , version, alarmCondition, eventSeverity, eventSourceType, - -# faultFieldsVersion, specificProblem, - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, -sourceName, - -# startEpochMicrosec - -event: {presence: required, action: [ any, any, alarm003, -RECO-rebuildVnf ], - -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: fault}, - -eventName: {presence: required, value: Fault_Vmrf-Nokia_Alarm003}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Medium}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -faultFields: {presence: required, structure: { - -alarmCondition: {presence: required, value: alarm003}, - -eventSeverity: {presence: required, value: MAJOR}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -faultFieldsVersion: {presence: required, value: 3.0}, - -specificProblem: {presence: required, value: "Configuration file was -corrupt or - -not present"}, - -vfStatus: {presence: required, value: "Requesting Termination"} - -}} - -}} - -... - ---- - -# registration for clearing Fault_vMrf_alarm003Cleared - -# Constants: the values of domain, eventName, priority, - -# , version, alarmCondition, eventSeverity, eventSourceType, - -# faultFieldsVersion, specificProblem, - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, - -# sourceName, startEpochMicrosec, vfStatus - -event: {presence: required, action: [ any, any, alarm003, Clear ], -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: fault}, - -eventName: {presence: required, value: -Fault_Vmrf-Nokia_Alarm003Cleared}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Medium}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -faultFields: {presence: required, structure: { - -alarmCondition: {presence: required, value: alarm003}, - -eventSeverity: {presence: required, value: NORMAL}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -faultFieldsVersion: {presence: required, value: 3.0}, - -specificProblem: {presence: required, value: "Valid configuration file -found"}, - -vfStatus: {presence: required, value: "Requesting Termination"} - -}} - -}} - -... - -Heartbeat ---------- - ---- - -# registration for Heartbeat_vMRF - -# Constants: the values of domain, eventName, priority, version - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, -sourceName, - -# startEpochMicrosec - -event: {presence: required, heartbeatAction: [3, vnfDown, -RECO-rebuildVnf], - -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: heartbeat}, - -eventName: {presence: required, value: Heartbeat_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -heartbeatFields: {presence: optional, structure:{ - - heartbeatFieldsVersion: {presence: required, value: 2.0}, - - heartbeatInterval: {presence: required, range: [ 15, 300 ], -default: 60 } - -}} - -}} - -... - -Measurements ------------- - -To see how additionalMeasurements may be sent in a way that is easy for -service providers to process without custom logic, please see the -following keywords: aggregationRole, castTo and isHomogeneous. In -particular, see the second example under aggergationRole. - ---- - -# registration for Measurement_vMRF - -# Constants: the values of domain, eventName, priority, version, - -# measurementFieldsVersion, -additionalMeasurements.namedArrayOfFields.name, - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, sequence, - -# sourceName, start/lastEpochMicrosec, measurementInterval, - -# concurrentSessions, requestRate, numberOfMediaPortsInUse, - -# cpuUsageArray.cpuUsage,cpuUsage.cpuIdentifier, cpuUsage.percentUsage, - -# additionalMeasurements.namedArrayOfFields.arrayOfFields, - -# vNicPerformance.receivedOctetsAccumulated, - -# vNicPerformance.transmittedOctetsAccumulated, - -# vNicPerformance.receivedTotalPacketsAccumulated, - -# vNicPerformance.transmittedTotalPacketsAccumulated, - -# vNicPerformance.vNicIdentifier, vNicPerformance.receivedOctetsDelta, - -# vNicPerformance.receivedTotalPacketsDelta, - -# vNicPerformance.transmittedOctetsDelta, - -# vNicPerformance.transmittedTotalPacketsDelta, - -# vNicPerformance.valuesAreSuspect, memoryUsageArray.memoryUsage, - -# memoryUsage.memoryConfigured, memoryUsage.vmIdentifier, - -# memoryUsage.memoryUsed, memoryUsage.memoryFree - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: measurement}, - -eventName: {presence: required, value: Measurement_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -measurementFields: {presence: required, structure: { - -measurementFieldsVersion: {presence: required, value: 3.0}, - -measurementInterval: {presence: required, range: [ 60, 3600 ], default: -300}, - -concurrentSessions: {presence: required, range: [ 0, 100000 ]}, - -requestRate: {presence: required, range: [ 0, 100000 ]}, - -numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]}, - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, range: [ 0, 100 ], - -action: [80, up, CpuUsageHigh, RECO-scaleOut], - -action: [10, down, CpuUsageLow, RECO-scaleIn]} - -}} - -]}, - -memoryUsageArray: {presence: required, array: [ - -memoryUsage: {presence: required, structure: { - -memoryConfigured: {presence: required, value: 33554432}, - -memoryFree: {presence: required, range: [ 0, 33554432 ], - -action: [100, down, FreeMemLow, RECO-scaleOut], - -action: [30198989, up, FreeMemHigh, RECO-scaleIn]}, - -memoryUsed: {presence: required, range: [ 0, 33554432 ]}, - -vmIdentifier: {presence: required} - -}} - -]}, - -additionalMeasurements: {presence: required, array: [ - -namedHashMap: {presence: required, structure: { - -name: {presence: required, value: licenseUsage}, - -hashMap: {presence: required, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G711AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G729AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G722AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AMRAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AMRWBAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: OpusAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H263VideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H264NonHCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H264HCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: MPEG4VideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VP8NonHCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VP8HCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: PLC}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AEC}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NR}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NG}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NLD}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G711FaxPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: T38FaxPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: RFactor}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: T140TextPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: EVSAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}} - -}} - -}}, - -namedHashMap: {presence: required, structure: { - -name: {presence: required, value: mediaCoreUtilization}, - -hashMap: {presence: required, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgAudio}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - -action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgAudio}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - -action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxAudio}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxAudio}, - -value: {presence: required, range: [ 0, 100 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgVideo}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgVideo}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxVideo}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxVideo}, - -value: {presence: required, range: [ 0, 100 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgHcVideo}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgHcVideo}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxHcVideo}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxHcVideo}, - -value: {presence: required, range: [ 0, 100 ]} - -}} - -}} - -}} - -]}, - -vNicPerformanceArray: {presence: required, array: [ - -vNicPerformance: {presence: required, structure: { - -receivedOctetsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -receivedTotalPacketsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -receivedOctetsDelta: {presence: required}, - -range: [ 0, 18446744073709551615 ], - -receivedTotalPacketsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedOctetsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedOctetsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedTotalPacketsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedTotalPacketsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -valuesAreSuspect: {presence: required, value: [ true, false ]}, - -vNicIdentifier: {presence: required} - -}} - -]} - -}} - -}} - -... - -Mobile Flow ------------ - ---- - -# registration for mobileFlow - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, - -# sequence, sourceName, start/lastEpochMicrosec - -# - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: mobileFlow}, - -eventName: {presence: required, value: MobileFlow_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -mobileFlowFields: {presence: required, structure: { - -mobileFlowFieldsVersion: {presence: required, value: 3.0}, - -applicationType: {presence: optional}, - -appProtocolType: {presence: optional}, - -appProtocolVersion: {presence: optional}, - -cid: {presence: optional}, - -connectionType: {presence: optional}, - -ecgi: {presence: optional}, - -flowDirection: {presence: required}, - -gtpPerFlowMetrics: {presence: required, structure: { - -avgBitErrorRate: {presence: required}, - -avgPacketDelayVariation: {presence: required}, - -avgPacketLatency: {presence: required}, - -avgReceiveThroughput: {presence: required}, - -avgTransmitThroughput: {presence: required}, - -durConnectionFailedStatus: {presence: optional}, - -durTunnelFailedStatus: {presence: optional}, - -flowActivatedBy: {presence: optional}, - -flowActivationEpoch: {presence: required}, - -flowActivationMicrosec: {presence: required}, - -flowActivationTime: {presence: optional}, - -flowDeactivatedBy: {presence: optional}, - -flowDeactivationEpoch: {presence: required}, - -flowDeactivationMicrosec: {presence: required}, - -flowDeactivationTime: {presence: required}, - -flowStatus: {presence: required}, - -gtpConnectionStatus: {presence: optional}, - -gtpTunnelStatus: {presence: optional}, - -ipTosCountList: {presence: optional}, - -ipTosList: {presence: optional}, - -largePacketRtt: {presence: optional}, - -largePacketThreshold: {presence: optional}, - -maxPacketDelayVariation: {presence: required}, - -maxReceiveBitRate: {presence: optional}, - -maxTransmitBitRate: {presence: optional}, - -mobileQciCosCountList: {presence: optional}, - -mobileQciCosList: {presence: optional}, - -numActivationFailures: {presence: required}, - -numBitErrors: {presence: required}, - -numBytesReceived: {presence: required}, - -numBytesTransmitted: {presence: required}, - -numDroppedPackets: {presence: required}, - -numGtpEchoFailures: {presence: optional}, - -numGtpTunnelErrors: {presence: optional}, - -numHttpErrors: {presence: optional}, - -numL7BytesReceived: {presence: required}, - -numL7BytesTransmitted: {presence: required}, - -numLostPackets: {presence: required}, - -numOutOfOrderPackets: {presence: required}, - -numPacketErrors: {presence: required}, - -numPacketsReceivedExclRetrans: {presence: required}, - -numPacketsReceivedInclRetrans: {presence: required}, - -numPacketsTransmittedInclRetrans: {presence: required}, - -numRetries: {presence: required}, - -numTimeouts: {presence: required}, - -numTunneledL7BytesReceived: {presence: required}, - -roundTripTime: {presence: required}, - -tcpFlagCountList: {presence: optional}, - -tcpFlagList: {presence: optional}, - -timeToFirstByte: {presence: required} - -}}, - -gtpProtocolType: {presence: optional}, - -gtpVersion: {presence: optional}, - -httpHeader: {presence: optional}, - -imei: {presence: optional}, - -imsi: {presence: optional}, - -ipProtocolType: {presence: required}, - -ipVersion: {presence: required}, - -lac: {presence: optional}, - -mcc: {presence: optional}, - -mnc: {presence: optional}, - -msisdn: {presence: optional}, - -otherEndpointIpAddress: {presence: required}, - -otherEndpointPort: {presence: required}, - -otherFunctionalRole: {presence: optional}, - -rac: {presence: optional}, - -radioAccessTechnology: {presence: optional}, - -reportingEndpointIpAddr: {presence: required}, - -reportingEndpointPort: {presence: required}, - -sac: {presence: optional}, - -samplingAlgorithm: {presence: optional}, - -tac: {presence: optional}, - -tunnelId: {presence: optional}, - -vlanId: {presence: optional}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -Sip Signaling -------------- - ---- - -# registration for sipSignaling - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, - -# sequence, sourceName, start/lastEpochMicrosec - -# - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: sipSignaling}, - -eventName: {presence: required, value: SipSignaling_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -sipSignalingFields: {presence: required, structure: { - -compressedSIP: {presence: optional}, - -correlator: {presence: required}, - -localIpAaddress: {presence: required}, - -localPort: {presence: required}, - -remoteIpAddress: {presence: required}, - -remotePort: {presence: required}, - -sipSignalingFieldsVersion: {presence: required, value: 2.0}, - -summarySip: {presence: optional}, - -vnfVendorNameFields: {presence: required, structure: { - -vendorName: {presence: required}, - -vfModuleName: {presence: optional}, - -vnfName: {presence: optional} - -}}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -Syslog ------- - ---- - -# registration for Syslog_vMRF - -# Constants: the values of domain, eventName, priority, -lastEpochMicrosec, version, - -# syslogFields.syslogFieldsVersion, syslogFields.syslogTag - -# Variables include: eventId, lastEpochMicrosec, reportingEntityId, -reportingEntityName, - -# sequence, sourceId, sourceName, startEpochMicrosec, - -# syslogFields.eventSourceHost, syslogFields.eventSourceType, - -# syslogFields.syslogFacility, syslogFields.syslogMsg - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: syslog}, - -eventName: {presence: required, value: Syslog_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0}, - -}}, - -syslogFields: {presence: required, structure: { - -eventSourceHost: {presence: required}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -syslogFacility: {presence: required, range: [16, 23]}, - -syslogSev: {presence: required, value: [Emergency, Alert, Critical, -Error]}, - -syslogFieldsVersion: {presence: required, value: 3.0}, - -syslogMsg: {presence: required}, - -syslogSData: {presence: required, keyValuePairString: {‘ ‘, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ATTEST}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DATE_IN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DATE_OUT}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DEST_IN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: FUNCTION}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ICID}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ORIGID}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ORIG_TN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: SIP_REASON_HEADER}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: STATE}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: STATUS}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VERSTAT}, - -value: {presence: required} - -}} - -]}} }] - -syslogTag: {presence: required, value: vMRF}, - -additionalFields: {presence: required, keyValuePairString: {|, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: someKeyName}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: someOtherKeyName}, - -value: {presence: required} - -}} - -]}} - -}} - -}} - -... - -Voice Quality -------------- - ---- - -# registration for voiceQuality - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, - -# sourceName, startEpochMicrosec - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: voiceQualityFields}, - -eventName: {presence: required, value: VoiceQuality_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -voiceQualityFields: {presence: required, structure: { - -voiceQualityFieldsVersion: {presence: required, value: 2.0}, - -calleeSideCodec: {presence: required}, - -callerSideCodec: {presence: required}, - -correlator: {presence: required}, - -remoteIpAddress: {presence: required}, - -endOfCallVqmSummaries: {presence: required, structure: { - -adjacencyName: {presence: required}, - -endpointDescription: {presence: required}, - -endpointAverageJitter: {presence: optional}, - -endpointMaxJitter: {presence: optional}, - -endpointRtpOctetsLost: {presence: optional}, - -endpointRtpPacketsLost: {presence: optional}, - -endpointRtpOctetsDiscarded: {presence: optional}, - -endpointRtpOctetsReceived: {presence: optional}, - -endpointRtpOctetsSent: {presence: optional}, - -endpointRtpPacketsDiscarded: {presence: optional}, - -endpointRtpPacketsReceived: {presence: optional}, - -endpointRtpPacketsSent: {presence: optional}, - -localAverageJitter: {presence: optional}, - -localMaxJitter: {presence: optional}, - -localAverageJitterBufferDelay: {presence: optional}, - -localMaxJitterBufferDelay: {presence: optional}, - -localRtpOctetsDiscarded: {presence: optional}, - -localRtpOctetsLost: {presence: optional}, - -localRtpOctetsReceived: {presence: optional}, - -localRtpOctetsSent: {presence: optional}, - -localRtpPacketsDiscarded: {presence: optional}, - -localRtpPacketsLost: {presence: optional}, - -localRtpPacketsReceived: {presence: optional}, - -localRtpPacketsSent: {presence: optional}, - -mosCqe: {presence: optional}, - -oneWayDelay: {presence: optional}, - -packetLossPercent: {presence: optional}, - -rFactor: {presence: optional}, - -roundTripDelay: {presence: optional} - -}}, - -phoneNumber: {presence: required}, - -midCallRtcp: {presence: required}, - -vendorVnfNameFields: {presence: required, structure: { - -vendorName: {presence: required}, - -vfModuleName: {presence: optional}, - -vnfName: {presence: optional} - -}}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -.. _rules-1: - -Rules ------ - ---- - -#Rules - -Rules: [ - -ruleName1: { - -trigger: "CpuUsageHigh \|\| FreeMemLow \|\| AudioCoreUsageHigh \|\| - -VideoCoreUsageHigh \|\| HcVideoCoreUsageHigh", - -microservices: [scaleOut] - -}, - -ruleName2: { - -trigger: "CpuUsageLow && FreeMemHigh && AudioCoreUsageLow && - -VideoCoreUsageLow && HcVideoCoreUsageLow", - -microservices: [scaleIn] - -} - -] - -... - -Appendix: Historical Change Log -=============================== - -For the latest changes, see the Change Block just before the Table of -Contents. - -+-----------------------+-----------------------+-----------------------+ -| Date | Revision | Description | -+-----------------------+-----------------------+-----------------------+ -| 3/15/2017 | 1.0 | This is the initial | -| | | release of the VES | -| | | Event Registration | -| | | document. | -+-----------------------+-----------------------+-----------------------+ -| 3/22/2017 | 1.1 | - Changed the | -| | | ‘alert’ | -| | | qualifier to | -| | | ‘action’ and | -| | | added support | -| | | for conditions | -| | | that will | -| | | trigger rules. | -| | | | -| | | - Formatted the | -| | | document with | -| | | more sections | -| | | and | -| | | subsections. | -| | | | -| | | - Defined the syntax | -| | | and semantics | -| | | for condition | -| | | based rules. | -| | | | -| | | - Fixed the YAML | -| | | examples. | -+-----------------------+-----------------------+-----------------------+ -| 3/27/2017 | 1.2 | - Clarified the | -| | | audience of the | -| | | document and | -| | | the | -| | | expectations | -| | | for vendors. | -| | | | -| | | - Changed the order | -| | | of fields in | -| | | the action | -| | | keyword. | -| | | | -| | | - Updated the YAML | -| | | examples. | -| | | | -| | | - Wordsmithed | -| | | throughout. | -+-----------------------+-----------------------+-----------------------+ -| 3/31/2017 | 1.3 | - Generalized the | -| | | descriptions | -| | | from an ASDC, | -| | | ECOMP and | -| | | AT&T-specific | -| | | interaction | -| | | with a VNF | -| | | vendor, to a | -| | | generic Service | -| | | Provider | -| | | interaction | -| | | with a VNF | -| | | vendor. | -| | | | -| | | - Wordsmithed | -| | | throughout. | -| | | | -| | | - Added a ‘default’ | -| | | qualifier | -| | | | -| | | - Fixed syntax and | -| | | semantic | -| | | inconsistencies | -| | | in the Rules | -| | | section | -| | | | -| | | - Brought all | -| | | examples into | -| | | compliance with | -| | | v5.0 | -| | | | -| | | - Added a heartbeat | -| | | example | -| | | | -| | | - Modified the | -| | | measurement | -| | | example | -| | | | -| | | - Modified the | -| | | syslog example | -| | | | -| | | - Added two complex | -| | | rules | -+-----------------------+-----------------------+-----------------------+ -| 4/14/2017 | 1.4 | - Wordsmithed | -| | | throughout | -| | | | -| | | - Action keyword: | -| | | clarified use | -| | | of ‘up’, ‘down’ | -| | | and ‘at’ | -| | | triggers; | -| | | clarified the | -| | | specification | -| | | and use of | -| | | microservices | -| | | directives at | -| | | design time and | -| | | runtime, | -| | | clarified the | -| | | use of tca’s | -| | | | -| | | - HeartbeatAction | -| | | keyword: Added | -| | | the | -| | | heartbeatAction | -| | | keyword | -| | | | -| | | - Value keyword: | -| | | clarified the | -| | | communicaton of | -| | | strings | -| | | containing | -| | | spaces. | -| | | | -| | | - Rules: corrected | -| | | the use of | -| | | quotes in | -| | | examples | -| | | | -| | | - Examples: added | -| | | the | -| | | heartbeatAction | -| | | keyword on the | -| | | heartbeat event | -| | | example; also | -| | | corrected use | -| | | of quotes | -| | | throughout. | -+-----------------------+-----------------------+-----------------------+ -| 10/3/2017 | 1.5 | - Back of Cover | -| | | Page: updated the | -| | | license and | -| | | copyright notice | -| | | to comply with | -| | | ONAP guidelines | -| | | | -| | | - Section 3.1: Added | -| | | a ‘Units’ | -| | | qualifier | -| | | | -| | | - Examples: updated | -| | | the examples to | -| | | align with VES | -| | | 5.4.1 | -+-----------------------+-----------------------+-----------------------+ -| 10/31/2017 | 1.6 | - Added | -| | | KeyValuePairString | -| | | keyword to handle | -| | | strings which have | -| | | delimited | -| | | key-value pairs | -| | | within them. | -| | | | -| | | - Updated the syslog | -| | | example to show | -| | | the use of | -| | | KeyValuePairStr | -| | | ing | -| | | | -| | | - Updated the syslog | -| | | example to | -| | | align syslogSev | -| | | with VES 5.4.1 | -| | | | -| | | - Added examples for | -| | | mobile flow, | -| | | sip signaling | -| | | and voice | -| | | quality | -| | | | -| | | - Added sections | -| | | within the | -| | | examples to | -| | | facilitate | -| | | rapid access to | -| | | specific types | -| | | of example | -| | | events | -| | | | -| | | - Wordsmithed the | -| | | Introduction | -+-----------------------+-----------------------+-----------------------+ diff --git a/docs/files/ICE.rst b/docs/files/ICE.rst deleted file mode 100644 index 094c4f3..0000000 --- a/docs/files/ICE.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Orange Labs. - -ICE validation scripts -====================== - -The ICE validation scripts are based on the python ``pytest`` tool. -These scripts check that the Heat Templates are compliant with the ONAP Heat Template Guidelines. - -Installation ------------- - -This software is not platform dependent and can be run in a Windows, Unix or -OS X environment. - -- Install python 2.7 or python 3 -- Install pip - -In addition to python, this project requires the following packages: - -- pytest -- PyYAML - -Depending on the desired output format, you should add the following optional packages: - -- pytest-tap -- pytest-html - -These can be installed using pip (assuming pip is installed) with the command: - -``$ pip install pytest PyYAML pytest-tap pytest-html`` - -Usage ------ - -Retrieve the ICE scripts, by cloning the sources: - -``$ git clone https://git.onap.org/vnfsdk/ice`` - -Go into the ice_validator directory: - -``$ cd ice/validation-scripts/ice_validator`` - -The Heat templates validation may generate different output format (plain, tap, html): - -- plain format - -``$ pytest --template-directory=<Directory>`` - -- tap format - -``$ pytest --tap-stream --template-directory=<Directory>`` - -- html format - -``$ pytest --html=/path/to/report.html --template-directory=<Directory>`` - -NB: ``<Directory>`` is the absolute path of the folder containing the Heat -Templates to be verified. - -.. image:: ./ice-report.png - -Figure 1: example of html report generated by ICE scripts diff --git a/docs/files/Use-Case-1.png b/docs/files/Use-Case-1.png Binary files differdeleted file mode 100644 index f1f6c92..0000000 --- a/docs/files/Use-Case-1.png +++ /dev/null diff --git a/docs/files/Use-Case-2.png b/docs/files/Use-Case-2.png Binary files differdeleted file mode 100644 index cff08c2..0000000 --- a/docs/files/Use-Case-2.png +++ /dev/null diff --git a/docs/files/VESEventListener.rst b/docs/files/VESEventListener.rst deleted file mode 100644 index b79670f..0000000 --- a/docs/files/VESEventListener.rst +++ /dev/null @@ -1,2383 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -=================================== -Service: *VES Event Listener 5.4.1* -=================================== - -.. contents:: Table of Contents - -Introduction -============ - -This document describes the RESTful interface for the VES (Virtual function Event Streaming) Event Listener. The VES Event Listener is capable of receiving any event sent in the VES Common Event Format. The Common Event Format is a JSON structure consisting of a required Common Event Header Block accompanied by zero or more event domain blocks. A JSON Schema of the VES Common Event Format is provided in Section 4 of this document. - -It should be understood that events are well structured packages of information, identified by an eventName, which are asynchronously communicated to subscribers who are interested in the eventName. Events can convey measurements, faults, syslogs, threshold crossing alerts and others types of information. Events are simply a way of communicating well-structured packages of information to one or more instances of an Event Listener service. - -This document describes a RESTful connectionless push event listener that is capable of receiving single events or batches of events in the Common Event Format. In future, additional documents may describe other transports which make use of persistent TCP connections for high volumes of streaming events. - -Event Registration ------------------- - -All events must be compliant with the common event format, but specific events identified by their eventNames, may require that certain fields, which are optional in the common event format, be present when they are published. For example, a specific eventName may require that specific name-value pairs be present in the extensible structures provided within the Common Event Format. - -Events are registered using an extensible YAML format (defined in a separate document), which specifies, for each eventName, the fields that are required, what field values may be sent, and any special handling that should be performed on those eventNames. - -Naming Standards for eventName ------------------------------- - -To prevent naming collisions, eventNames sent as part of the -commonEventHeader, should conform to the following naming convention designed to summarize the purpose and type of the event, and to ensure the uniqueness of the eventName: - - {DomainAbbreviation}\_{SdcModel or - ApplicationPlatform}\_{DescriptionOfInfoBeingConveyed} - -Domain abbreviations are derived from the 'domain' field in the -commonEventHeader, as specified below: -- 'Fault'for the fault domain -- 'Heartbeat'for the heartbeat domain -- 'Mfvs'for the measurementsForVfScaling domain -- 'MobileFlow'for the mobileFlow domain -- 'Other'for the other domain -- 'SipSignaling'for the sipSignaling domain -- 'StateChange'for the stateChange domain -- 'Syslog'for the syslog domain -- 'Tca'for the thresholdCrossingAlert domain -- 'voiceQuality'for the voiceQuality domain - -SDC (the ONAP Service Design and Creation environment) defines and catalogs specific services, VNFs, VF modules and other entities, which are generically referred to as 'SDC models'. The SDC model that an event is associated with should be indicated in the second subfield within the eventName. If the event is not associated with an Sdc model but is instead being generated by an application platform like SO, then a string identifying the Application Platform may be used instead. In either case, all subfield names should be converted to camel case format (with no spaces, hyphens or underscores). - -The final subfield of the eventName name should describe, in a compact camel case format (with no spaces, hyphens or underscores), the specific information being conveyed by the event. In some cases, this final subfield will not be required (e.g., in the case of Heartbeats or in the case of an event source which, for a domain like syslog, defines only one eventName to support it): - -Examples of eventNames following the naming standards are provided below: - -- Fault\_MobileCallRecording\_PilotNumberPoolExhaustion -- Heartbeat\_vIsbcMmc -- Other\_WanBonding\_InstantiationPart1Complete -- Syslog\_vDbe -- Tca\_vDbe\_CpuThresholdExceeded -- Other\_SO\_InstantiationPhase1Complete - -Any questions about the naming of eventNames should be resolved as part of service and resource onboarding to the ONAP Service Design and Creation environment (i.e., SDC). - -Support for Protocols Other Than HTTPS --------------------------------------- - -This API specification describes an HTTPS RESTful interface using the JSON content-type. - -Alternative specifications may be provided in future using Websockets, which would establish a permanent TCP socket, or Apache Avro which provides a binary format over an RPC protocol to be defined. Both would leverage the JSON schema provided in this document. - -Versioning ----------- - -Three types of version numbers supported by this specification: -- The API specification itself is versioned. Going forward, the major number of the specification version will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the spec (e.g., a field name is added or text changes are made to the specification itself) will increment only the minor number. Note that the major number appears in REST resource URLs as v# (where '#'is the major number). - -- The JSON schema is versioned. Going forward, the major number of the JSON schema will be incremented whenever any change could break an existing client (e.g., a field name is deleted or changed). All other changes to the schema (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number. - -- The field blocks are versioned. Field blocks include the commonEventHeader and the domain blocks (e.g., the faultFields block). Going forward, the major number of each field block will be incremented whenever any change to that block could break an existing client (e.g., a field name is deleted or changed). All other changes to that block (e.g., a field name is added or text changes are made to the field descriptions) will increment only the minor number. - -Security --------- - -Event sources must identify themselves to the VES Event Listener. - -Event source credentials are passed using HTTP `Basic Authentication <http://tools.ietf.org/html/rfc2617>`__. - -Credentials must not be passed on the query string. Credentials must be sent in an Authorization header as follows: - -1. The username and password are formed into one string as "username:password" - -2. The resulting string is Base64 encoded to produce the encoded credential. - -3. The encoded credential is communicated in the header after the string "Authorization: Basic " - -Because the credentials are merely encoded but not encrypted, HTTPS (rather than HTTP) should be used. HTTPS will also encrypt and protect event contents. - -Examples are provided below. - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - - .. code:: bash - - POST /eventListener/v5 HTTPS/1.1 - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== - content-type: application/json - content-length: 12345 - { - "event": { - "commonEventHeader": { - "version": 3.0, - "domain": "heartbeat", - "eventName": "Heartbeat\_vIsbcMmc", - "eventId": "ab305d54-85b4-a31b-7db2fb6b9e546015", - "sequence": 0, - "priority": "Normal", - "reportingEntityId": "cc305d54-75b4-431badb2eb6b9e541234", - "reportingEntityName": "EricssonOamVf", - "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", - "sourceName": "ibcx0001vm002ssc001", - "nfNamingCode": "ibcx", - "nfcNamingCode": "ssc", - "startEpochMicrosec": 1413378172000000, - "lastEpochMicrosec": 1413378172000000 - } - } - } - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - - .. code:: bash - - HTTPS/1.1 202 Accepted - -Resource Structure -================== - -REST resources are defined with respect to a ServerRoot: - - ServerRoot = /{optionalRoutingtPath} - -The resource structure is provided below: - - |image0| - -Figure 1 REST Resource Structure - -The {Domain} or FQDN above is typically provisioned into each -eventsource when it is instantiated. The {Port} above is typically 8443. - -Common Event Format -=================== - -A JSON schema describing the Common Event Format is provided below and is reproduced in the tables that follow. - -Common Event Datatypes ----------------------- - -Command List Processing Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: command -^^^^^^^^^^^^^^^^^ - -The command datatype is used by an event collector to request changes in the behavior of an event source (for more information, see 6.1.3); it consists of the following fields: - -+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=====================================+====================================+=============+=====================================================================================================+ -| commandType | string | Yes | Enumeration: 'heartbeatIntervalChange', 'measurementIntervalChange', | -| | | | | -| | | | 'provideThrottlingState', 'throttllingSpecification' | -+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ -| eventDomainThrottle Specification | eventDomainThrottleSpecification | No | If commandType is 'throttlingSpecification', the fields to suppress within an event domain | -+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ -| heartbeatInterval | integer | No | If commandType is 'heartbeatIntervalChange', the heartbeatInterval duration to use in seconds | -+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ -| measurementInterval | integer | No | If commandType is 'measurementIntervalChange', the measurementInterval duration to use in seconds | -+-------------------------------------+------------------------------------+-------------+-----------------------------------------------------------------------------------------------------+ - -Datatype: commandList -^^^^^^^^^^^^^^^^^^^^^ - -The commandList datatype is an array of commands from an event collector toward an event source; it consists of the following fields: - -+---------------+---------------+-------------+-------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============+===============+=============+===================================================================+ -| commandList | Command [ ] | Yes | List of commands from an event collector toward an event source | -+---------------+---------------+-------------+-------------------------------------------------------------------+ - -Datatype: eventDomainThrottleSpecification -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The eventDomainThrottleSpecification datatype specifies what fields to suppress within an event domain; it consists of the following fields common to all events: - -+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=========================+=========================+=============+=================================================================================================+ -| eventDomain | string | Yes | Event domain enum from the commonEventHeader domain field | -+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ -| suppressedFieldNames | string [ ] | No | List of optional field names in the event block that should not be sent to the Event Listener | -+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ -| suppressedNvPairsList | suppressedNvPairs [ ] | No | Optional list of specific NvPairsNames to suppress within a given Name-Value Field | -+-------------------------+-------------------------+-------------+-------------------------------------------------------------------------------------------------+ - -Datatype: eventDomainThrottleSpecificationList -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The eventDomainThrottleSpecificationList datatype consists of the -following fields: - -+----------------------------------------+----------------------------------------+-------------+----------------------------------------------+ -| Field | Type | Required? | Description | -+========================================+========================================+=============+==============================================+ -| eventDomainThrottleSpecificationList | eventDomainThrottleSpecification [ ] | Yes | Array of eventDomainThrottleSpecifications | -+----------------------------------------+----------------------------------------+-------------+----------------------------------------------+ - -Datatype: eventThrottlingState -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The eventThrottlingState datatype reports the throttling in force at the event source; it consists of the following fields: - -+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+========================================+========================================+=============+==============================================================================================================================+ -| eventThrottlingMode | string | Yes | Enumeration: 'normal', 'throttled' | -+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ -| eventDomainThrottleSpecificationList | eventDomainThrottleSpecificationList | No | A list of eventDomainThrottleSpecifications currently in force at the event source, if the eventManagerMode is 'throttled' | -+----------------------------------------+----------------------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: suppressedNvPairs -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The suppressedNvPairs datatype is a list of specific NvPairsNames to suppress within a given Name-Value Field (for event throttling); it consists of the following fields: - -+-------------------------+--------------+-------------+-------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=========================+==============+=============+===================================================================+ -| nvPairFieldName | string | Yes | Name of the field within which are the nvpair names to suppress | -+-------------------------+--------------+-------------+-------------------------------------------------------------------+ -| suppressedNvPairNames | string [ ] | Yes | Array of nvpair names to suppress (within the nvpairFieldName) | -+-------------------------+--------------+-------------+-------------------------------------------------------------------+ - -Common Event Datatypes -~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: event -^^^^^^^^^^^^^^^ - -The event datatype consists of the following fields which constitute the 'root level'of the common event format: - -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| Field | Type | Required? | Description | -+==================================+==================================+=============+======================================================+ -| commonEventHeader | commonEventHeader | Yes | Fields common to all events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| faultFields | faultFields | No | Fields specific to fault events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| heartbeatFields | heartbeatFields | No | Fields specific to heartbeat events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| measurementsForVfScalingFields | measurementsForVfScalingFields | No | Fields specific to measurementsForVfScaling events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| mobileFlowFields | mobileFlowFields | No | Fields specific to mobility flow events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| otherFields | otherFields | No | Fields specific to other types of events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| sipSignalingFields | sipSignalingFields | No | Fields specific to sipSignaling events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| stateChangeFields | stateChangeFields | No | Fields specific to state change events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| syslogFields | syslogFields | No | Fields specific to syslog events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| thresholdCrossingAlertFields | thresholdCrossingAlertFields | No | Fields specific to threshold crossing alert events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ -| voiceQualityFields | voiceQualityFields | No | Fields specific to voiceQuality events | -+----------------------------------+----------------------------------+-------------+------------------------------------------------------+ - -Datatype: eventList -^^^^^^^^^^^^^^^^^^^ - -The eventList datatype consists of the following fields: - -+-------------+-------------+-------------+-------------------+ -| Field | Type | Required? | Description | -+=============+=============+=============+===================+ -| eventList | event [ ] | Yes | Array of events | -+-------------+-------------+-------------+-------------------+ - -Datatype: field -^^^^^^^^^^^^^^^ - -The field datatype consists of the following fields: - -+---------+----------+-------------+----------------------------+ -| Field | Type | Required? | Description | -+=========+==========+=============+============================+ -| name | string | Yes | Name of the field | -+---------+----------+-------------+----------------------------+ -| value | string | Yes | Value of the named field | -+---------+----------+-------------+----------------------------+ - -Datatype: jsonObject -^^^^^^^^^^^^^^^^^^^^ - -The jsonObject datatype provides a json object schema, name and other meta-information along with one or more object instances that conform to the schema: - -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+==========================+=============+===========================================================================================================================================================================+ -| objectInstances | JsonObjectInstance [ ] | Yes | Contains one or more instances of the json object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectName | string | Yes | Name of the json object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectSchema | string | No | json schema for the object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| objectSchemaUrl | string | No | URL to the json schema for the object | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfSubscribedObjectName | string | No | Name of the object associated with the nfSubscriptionId | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfSubscriptionId | string | No | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject | -+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: jsonObjectInstance -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The jsonObjectInstance datatype provides meta-information about an -instance of a jsonObject along with the actual object instance: - -+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============================+===========+=============+===========================================================================================================================================+ -| objectInstance | object | Yes | Contains an instance conforming to the jsonObject schema | -+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| objectInstanceEpochMicrosec | number | No | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds | -+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ -| objectKeys | key [ ] | No | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy) | -+-------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: key -^^^^^^^^^^^^^ - -The key datatype is a tuple which provides the name of a key along with -its value and relative order; it consists of the following fields: - -+------------+-----------+-------------+----------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+============+===========+=============+======================================================================+ -| keyName | string | Yes | Name of the key | -+------------+-----------+-------------+----------------------------------------------------------------------+ -| keyOrder | Integer | No | Relative sequence or order of the key (with respect to other keys) | -+------------+-----------+-------------+----------------------------------------------------------------------+ -| keyValue | string | No | Value of the key | -+------------+-----------+-------------+----------------------------------------------------------------------+ - -Datatype: namedArrayOfFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The namedArrayOfFields datatype is an array of name value pairs along with a name for the array; it consists of the following fields: - -+-----------------+-------------+-------------+------------------------------------------+ -| Field | Type | Required? | Description | -+=================+=============+=============+==========================================+ -| name | string | Yes | Name for the array of name-value pairs | -+-----------------+-------------+-------------+------------------------------------------+ -| arrayOfFields | field [ ] | Yes | Name-value pairs | -+-----------------+-------------+-------------+------------------------------------------+ - -Datatype: requestError -^^^^^^^^^^^^^^^^^^^^^^ - -The requestError datatype defines the standard request error data -structure: - -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============+==========+=============+================================================================================================================================================================================================================================================================================================+ -| messageId | string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined. | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| text | string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| url | string | No | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| variables | string | No | List of zero or more strings that represent the contents of the variables used by the message text | -+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: vendorVnfNameFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The vendorVnfNameFields provides vendor, vnf and vfModule identifying information: - -+----------------+----------+-------------+---------------------------------------------------------------+ -| Field | Type | Required? | Description | -+================+==========+=============+===============================================================+ -| vendorName | string | Yes | VNF vendor name | -+----------------+----------+-------------+---------------------------------------------------------------+ -| vfModuleName | string | No | The Sdc vfModuleName for the vfModule generating the event | -+----------------+----------+-------------+---------------------------------------------------------------+ -| vnfName | string | No | The Sdc modelName for the VNF generating the event | -+----------------+----------+-------------+---------------------------------------------------------------+ - -'Common Event Header'Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: commonEventHeader -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The commonEventHeader datatype consists of the following fields common to all events: - -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=========================+=========================+=============+================================================================================================================================================================================================================================================================================+ -| version | number | Yes | Version of the event header (currently: 3.0) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventName | string | Yes | Unique event name (see section 1 for more information) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| domain | string | Yes | Event domain enumeration: 'fault', 'heartbeat', 'measurementsForVfScaling', 'mobileFlow', 'other', 'sipSignaling', 'stateChange', 'syslog', 'thresholdCrossingAlert', 'voiceQuality' | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventId | string | Yes | Event key that is unique to the event source | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventType | string | No | For example: 'applicationVnf', 'guestOS', 'hostOS', 'platform' | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfcNamingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf naming standards) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sourceId | string | No | UUID identifying the entity experiencing the event issue (note: the AT&T internal enrichment process shall ensure that this field is populated) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sourceName | string | Yes | Name of the entity experiencing the event issue | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEntityId | string | No | UUID identifying the entity reporting the event, for example an OAM VM (note: the AT&T internal enrichment process shall ensure that this field is populated) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEntityName | string | Yes | Name of the entity reporting the event, for example, an EMS name. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| priority | string | Yes | Processing priority enumeration: 'High', 'Medium', 'Normal', 'Low' | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| startEpochMicrosec | number | Yes | 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 | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| lastEpochMicrosec | number | Yes | 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 | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| internalHeader Fields | internalHeader Fields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener. | -+-------------------------+-------------------------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: internalHeaderFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener. -The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener: - -Technology Independent Datatypes --------------------------------- - -'Fault'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: faultFields -^^^^^^^^^^^^^^^^^^^^^ - -The faultFields datatype consists of the following fields: - -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============================+=============+=============+================================================================================================================================================================+ -| faultFieldsVersion | number | Yes | Version of the faultFields block (currently: 2.0) | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSeverity | string | Yes | Event severity enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceType | string | Yes | Examples: 'card', 'host', 'other', 'port', 'portThreshold', 'router', 'slotThreshold', 'switch', 'virtualMachine', 'virtualNetworkFunction' | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventCategory | string | No | Event category, for example: 'license', 'link', 'routing', 'security', 'signaling' | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| alarmCondition | string | Yes | Alarm condition reported by the device (e.g., 'tpLgCgiNotInConfig') | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| specificProblem | string | Yes | Short description of the alarm or problem (e.g., 'This event is sent when the LG is asked to perform a location for a CGI that is not in its configuration') | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vfStatus | string | Yes | Virtual function status enumeration: 'Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting Termination' | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| alarmInterfaceA | string | No | Card, port, channel or interface name of the device generating the alarm | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| alarmAdditional Information | field [ ] | No | Additional alarm information (note: for SNMP mapping to VES, for name use OID of varbind, for value use incoming data for that varbind) | -+-------------------------------+-------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -'Heartbeat'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: heartbeatFields -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The heartbeatFields datatype is an optional field block for fields specific to heartbeat events; it consists of the following fields: - -+--------------------------+-------------+-------------+---------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+=============+=============+=========================================================+ -| heartbeatFieldsVersion | number | Yes | Version of the heartbeatFields block (currently: 1.0) | -+--------------------------+-------------+-------------+---------------------------------------------------------+ -| additionalFields | field [ ] | No | Additional expansion fields if needed | -+--------------------------+-------------+-------------+---------------------------------------------------------+ -| heartbeatInterval | Integer | Yes | Current heartbeatInterval in seconds | -+--------------------------+-------------+-------------+---------------------------------------------------------+ - -Measurements For VF Scaling'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: codecsInUse -^^^^^^^^^^^^^^^^^^^^^ - -The codecsInUse datatype consists of the following fields describing the number of times an identified codec was used over the measurementInterval: - -+------------------+-----------+-------------+--------------------------------+ -| Field | Type | Required? | Description | -+==================+===========+=============+================================+ -| codecIdentifer | string | Yes | Description of the codec | -+------------------+-----------+-------------+--------------------------------+ -| numberInUse | integer | Yes | Number of such codecs in use | -+------------------+-----------+-------------+--------------------------------+ - -Datatype: cpuUsage -^^^^^^^^^^^^^^^^^^ - -The cpuUsage datatype defines the usage of an identifier CPU and -consists of the following fields: - -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=====================+==========+=============+=====================================================================================================================================+ -| cpuIdentifier | string | Yes | CPU Identifier | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuIdle | number | No | Percentage of CPU time spent in the idle task | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageInterrupt | number | No | Percentage of time spent servicing interrupts | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageNice | number | No | Percentage of time spent running user space processes that have been niced | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSoftIrq | number | No | Percentage of time spent handling soft irq interrupts | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSteal | number | No | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageSystem | number | No | Percentage of time spent on system tasks running the kernel | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageUser | number | No | Percentage of time spent running un-niced user space processes | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| cpuWait | number | No | Percentage of CPU time spent waiting for I/O operations to complete | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ -| percentUsage | number | Yes | Aggregate cpu usage of the virtual machine on which the VNFC reporting the event is running | -+---------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: diskUsage -^^^^^^^^^^^^^^^^^^^ - -The diskUsage datatype defines the usage of a disk and consists of the following fields: - -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+==========+=============+===============================================================================================================================================================================================================================+ -| diskIdentifier | string | Yes | Disk Identifier | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeAvg | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeLast | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeMax | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskIoTimeMin | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadAvg | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadLast | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadMax | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedReadMin | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteAvg | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteLast | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteMax | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskMergedWriteMin | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Avg | number | No | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Last | number | No | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Max | number | No | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsRead Min | number | No | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWrite Avg | number | No | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWrite Last | number | No | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWriteMax | number | No | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOctetsWriteMin | number | No | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadAvg | number | No | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadLast | number | No | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadMax | number | No | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsReadMin | number | No | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteAvg | number | No | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteLast | number | No | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWrite Max | number | No | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskOpsWriteMin | number | No | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsAvg | number | No | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsLast | number | No | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsMax | number | No | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskPendingOperationsMin | number | No | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeReadAvg | number | No | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Last | number | No | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Max | number | No | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeRead Min | number | No | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Avg | number | No | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Last | number | No | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Max | number | No | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskTimeWrite Min | number | No | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval | -+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: featuresInUse -^^^^^^^^^^^^^^^^^^^^^^^ - -The featuresInUse datatype consists of the following fields which -describe the number of times an identified feature was used over the measurementInterval: - -+----------------------+-----------+-------------+---------------------------------------------------+ -| Field | Type | Required? | Description | -+======================+===========+=============+===================================================+ -| featureIdentifer | string | Yes | Description of the feature | -+----------------------+-----------+-------------+---------------------------------------------------+ -| featureUtilization | integer | Yes | Number of times the identified feature was used | -+----------------------+-----------+-------------+---------------------------------------------------+ - -Datatype: filesystemUsage -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The filesystemUsage datatype consists of the following fields: - -+-----------------------+----------+-------------+--------------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================+==========+=============+========================================================+ -| filesystemName | string | Yes | File system name | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockConfigured | number | Yes | Configured block storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockIops | number | Yes | Block storage input-output operations per second | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| blockUsed | number | Yes | Used block storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralConfigured | number | Yes | Configured ephemeral storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralIops | number | Yes | Ephemeral storage input-output operations per second | -+-----------------------+----------+-------------+--------------------------------------------------------+ -| ephemeralUsed | number | Yes | Used ephemeral storage capacity in GB | -+-----------------------+----------+-------------+--------------------------------------------------------+ - -Datatype: latencyBucketMeasure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The latencyBucketMeasure datatype consists of the following fields which describe the number of counts falling within a defined latency bucket: - -+--------------------------+----------+-------------+------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================+==========+=============+============================================================+ -| countsInTheBucket | number | Yes | Number of counts falling within a defined latency bucket | -+--------------------------+----------+-------------+------------------------------------------------------------+ -| highEndOfLatencyBucket | number | No | High end of bucket range (typically in ms) | -+--------------------------+----------+-------------+------------------------------------------------------------+ -| lowEndOfLatencyBucket | number | No | Low end of bucket range (typically in ms) | -+--------------------------+----------+-------------+------------------------------------------------------------+ - -Datatype: measurementsForVfScalingFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The measurementsForVfScalingFields datatype consists of the following fields: - -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===================================+============================+=============+===========================================================================================================================================================================================================+ -| measurementsForVfScalingVersion | number | Yes | Version of the measurementsForVfScalingFields block (currently: 2.0) | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalFields | field [ ] | No | Additional measurement fields if needed | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalMeasurements | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays if needed | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information, if needed | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| codecUsageArray | codecsInUse [] | No | Array of codecs in use | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| concurrentSessions | integer | No | Peak concurrent sessions for the VM or VNF (depending on the context) over the measurementInterval | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| configuredEntities | integer | No | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the VNF | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| cpuUsageArray | cpuUsage [] | No | Usage of an array of CPUs | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| diskUsageArray | diskUsage [] | No | Usage of an array of disks | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| featureUsageArray | featuresInUse [] | No | Array of features in use | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| filesystemUsageArray | filesystemUsage [] | No | Filesystem usage of the VM on which the VNFC reporting the event is running | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| latencyDistribution | latencyBucketMeasure [ ] | No | Array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges; where latency is the duration between a service request and its fulfillment. | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| meanRequestLatency | number | No | Mean seconds required to respond to each request for the VM on which the VNFC reporting the event is running | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measurementInterval | number | Yes | Interval over which measurements are being reported in seconds | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| memoryUsageArray | memoryUsage [] | No | Memory usage of an array of VMs | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numberOfMediaPortsInUse | integer | No | Number of media ports in use | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| requestRate | number | No | Peak rate of service requests per second to the VNF over the measurementInterval | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vnfcScalingMetric | integer | No | Represents busy-ness of the VNF from 0 to 100 as reported by the VNFC | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vNicPerformanceArray | vNicPerformance [ ] | No | Performance metrics of an array of virtual network interface cards | -+-----------------------------------+----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: memoryUsage -^^^^^^^^^^^^^^^^^^^^^ - -The memoryUsage datatype defines the memory usage of a virtual machine and consists of the following fields: - -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+====================+==========+=============+==========================================================================================================+ -| memoryBuffered | number | No | Kibibytes of temporary storage for raw disk blocks | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memoryCached | number | No | Kibibytes of memory used for cache | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memoryConfigured | number | No | Kibibytes of memory configured in the virtual machine on which the VNFC reporting the event is running | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memoryFree | number | Yes | Kibibytes of physical RAM left unused by the system | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memorySlabRecl | number | No | The part of the slab that can be reclaimed such as caches measured in kibibytes | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memorySlabUnrecl | number | No | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| memoryUsed | number | Yes | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ -| vmIdentifier | string | Yes | Virtual Machine identifier associated with the memory metrics | -+--------------------+----------+-------------+----------------------------------------------------------------------------------------------------------+ - -Datatype: vNicPerformance -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The vNicPerformance datatype consists of the following fields which describe the performance and errors of an of an identified virtual network interface card: - -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+==========================================+==========+=============+===============================================================================================================================================+ -| receivedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedBroadcastPacketsDelta | number | No | Count of broadcast packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedDiscardedPacketsDelta | number | No | Count of discarded packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedErrorPacketsAccumulated | number | No | Cumulative count of error packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedErrorPacketsDelta | number | No | Count of error packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedMulticastPacketsDelta | number | No | Count of multicast packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedOctetsAccumulated | number | No | Cumulative count of octets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedOctetsDelta | number | No | Count of octets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedTotalPacketsAccumulated | number | No | Cumulative count of all packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedTotalPacketsDelta | number | No | Count of all packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets received as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| receivedUnicastPacketsDelta | number | No | Count of unicast packets received within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedBroadcastPacketsDelta | number | No | Count of broadcast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedDiscardedPacketsDelta | number | No | Count of discarded packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedErrorPacketsAccumulated | number | No | Cumulative count of error packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedErrorPacketsDelta | number | No | Count of error packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedMulticastPacketsDelta | number | No | Count of multicast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedOctetsAccumulated | number | No | Cumulative count of octets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedOctetsDelta | number | No | Count of octets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedTotalPacketsAccumulated | number | No | Cumulative count of all packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedTotalPacketsDelta | number | No | Count of all packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets transmitted as read at the end of the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| transmittedUnicastPacketsDelta | number | No | Count of unicast packets transmitted within the measurement interval | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| valuesAreSuspect | string | Yes | Enumeration: 'true'or 'false'. If 'true'then the vNicPerformance values are likely inaccurate due to counter overflow or other condtions. | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| vNicIdentifier | string | Yes | vNic identification | -+------------------------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - -'Other'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: otherFields -^^^^^^^^^^^^^^^^^^^^^ - -The otherFields datatype defines fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration; it consists of the following fields: - -+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+==========================+=============+==============================================================================+ -| otherFieldsVersion | number | Yes | Version of the otherFields block (currently: 1.1) | -+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ -| hashOfNameValuePairArrays | namedArrayOfFields [ ] | No | Array of named name-value-pair arrays | -+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ -| jsonObjects | jsonObject [ ] | No | Array of JSON objects described by name, schema and other meta-information | -+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ -| nameValuePairs | field [ ] | No | Array of name-value pairs | -+-----------------------------+--------------------------+-------------+------------------------------------------------------------------------------+ - -'State Change'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: stateChangeFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The stateChangeFields datatype consists of the following fields: - -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+============================+=============+=============+============================================================================+ -| stateChangeFieldsVersion | number | Yes | Version of the stateChangeFields block (currently: 2.0) | -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ -| additionalFields | field [ ] | No | Additional stateChange fields if needed | -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ -| newState | string | Yes | New state of the entity: 'inService', 'maintenance', 'outOfService' | -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ -| oldState | string | Yes | Previous state of the entity: 'inService', 'maintenance', 'outOfService' | -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ -| stateInterface | string | Yes | Card or port name of the entity that changed state | -+----------------------------+-------------+-------------+----------------------------------------------------------------------------+ - -'Syslog'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: syslogFields -^^^^^^^^^^^^^^^^^^^^^^ - -The syslogFields datatype consists of the following fields: - -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=======================+===========+=============+===============================================================================================================================================+ -| syslogFieldsVersion | number | Yes | Version of the syslogFields block (currently: 3.0) | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalFields | string | No | Additional syslog fields if needed, provided as name=value delimited by a pipe '\|'symbol, for example: "name1=value1\|name2=value2\|"" | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceHost | string | No | Hostname of the device | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| eventSourceType | string | Yes | Examples: 'other', 'router', 'switch', 'host', 'card', 'port', 'slotThreshold', 'portThreshold', 'virtualMachine', 'virtualNetworkFunction' | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogFacility | integer | No | Numeric code from 0 to 23 for facility: | -| | | | | -| | | | 0 kernel messages | -| | | | | -| | | | 1 user-level messages | -| | | | | -| | | | 2 mail system | -| | | | | -| | | | 3 system daemons | -| | | | | -| | | | 4 security/authorization messages | -| | | | | -| | | | 5 messages generated internally by syslogd | -| | | | | -| | | | 6 line printer subsystem | -| | | | | -| | | | 7 network news subsystem | -| | | | | -| | | | 8 UUCP subsystem | -| | | | | -| | | | 9 clock daemon | -| | | | | -| | | | 10 security/authorization messages | -| | | | | -| | | | 11 FTP daemon | -| | | | | -| | | | 12 NTP subsystem | -| | | | | -| | | | 13 log audit | -| | | | | -| | | | 14 log alert | -| | | | | -| | | | 15 clock daemon (note 2) | -| | | | | -| | | | 16 local use 0 (local0) | -| | | | | -| | | | 17 local use 1 (local1) | -| | | | | -| | | | 18 local use 2 (local2) | -| | | | | -| | | | 19 local use 3 (local3) | -| | | | | -| | | | 20 local use 4 (local4) | -| | | | | -| | | | 21 local use 5 (local5) | -| | | | | -| | | | 22 local use 6 (local6) | -| | | | | -| | | | 23 local use 7 (local7 ) | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogMsg | string | Yes | Syslog message | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogPri | integer | No | 0-192 | -| | | | | -| | | | Combined Severity and Facility | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogProc | string | No | Identifies the application that originated the message | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogProcId | number | No | A change in the value of this field indicates a discontinuity in syslog reporting | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSData | string | No | Syslog structured data consisting of a structured data Id followed by a set of key value pairs (see below for an example) | -| | | | | -| | | | \*\*Note: SD-ID may not be present if syslogSdId is populated | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSdId | string | No | 0-32 char in format name@number, | -| | | | | -| | | | i.e., ourSDID@32473 | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogSev | string | No | Level-of-severity enumeration in quotes below: | -| | | | | -| | | | 'Emergency': system is unusable | -| | | | | -| | | | 'Alert': action must be taken immediately | -| | | | | -| | | | 'Critical': critical conditions | -| | | | | -| | | | 'Error': error conditions | -| | | | | -| | | | 'Warning': warning conditions | -| | | | | -| | | | 'Notice': normal but significant condition | -| | | | | -| | | | 'Info': Informational: informational messages | -| | | | | -| | | | 'Debug': debug-level messages | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogTag | string | Yes | MsgId indicating the type of message such as 'TCPOUT'or 'TCPIN'; 'NILVALUE'should be used when no other value can be provided | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ -| syslogVer | number | No | IANA assigned version of the syslog protocol specification (typically '1') | -+-----------------------+-----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - -Example of syslogSData: - - STRUCTURED-DATA = NILVALUE / 1\*SD-ELEMENT - - SD-ELEMENT = "[" SD-ID \*(SP SD-PARAM) "]" - - SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34 - - SD-ID = SD-NAME - - PARAM-NAME = SD-NAME - - PARAM-VALUE = UTF-8-STRING ; characters '"', '\\' and - - ; ']' MUST be escaped. - - SD-NAME = 1\*32PRINTUSASCII - - ; except '=', SP, ']', %d34 (") - -'Threshold Crossing Alert'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: counter -^^^^^^^^^^^^^^^^^ - -The counter datatype consists of the following fields: - -+---------------------+----------+-------------+-----------------------------------+ -| Field | Type | Required? | Description | -+=====================+==========+=============+===================================+ -| name | string | Yes | Name of the counter | -+---------------------+----------+-------------+-----------------------------------+ -| value | string | Yes | Current value of the counter | -+---------------------+----------+-------------+-----------------------------------+ -| threshholdCrossed | string | Yes | Last threshold that was crossed | -+---------------------+----------+-------------+-----------------------------------+ -| criticality | string | Yes | Enumeration: 'CRIT', 'MAJ' | -+---------------------+----------+-------------+-----------------------------------+ - -Datatype: thresholdCrossingAlertFields -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The thresholdCrossingAlertFields datatype consists of the following -fields: - -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===================================+===============+=============+=============================================================================================================================+ -| thresholdCrossing FieldsVersion | number | Yes | Version of the thresholdCrossingAlertFields block (currently: 2.0) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| additionalFields | field [ ] | No | Additional threshold crossing alert fields if needed | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| additionalParameters | counter [ ] | Yes | Array of performance counters | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| alertAction | string | Yes | Enumeration: 'SET', 'CONT', 'CLEAR' | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| alertDescription | string | Yes | Unique short alert description (e.g., NE-CPUMEM) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| alertType | string | Yes | Enumeration: 'CARD-ANOMALY', 'INTERFACE-ANOMALY', ELEMENT-ANOMALY', 'SERVICE-ANOMALY' | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| alertValue | string | No | Calculated API value (if applicable) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| associatedAlertIdList | string [ ] | No | List of eventIds associated with the event being reported | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| collectionTimestamp | string | Yes | Time when the performance collector picked up the data; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| dataCollector | string | No | Specific performance collector instance used | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| elementType | string | No | Type of network element (internal AT&T field) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| eventSeverity | string | Yes | Event severity or priority enumeration: 'CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL' | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| eventStartTimestamp | string | Yes | Time closest to when the measurement was made; with RFC 2822 compliant format: 'Sat, 13 Mar 2010 11:29:05 -0800' | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| interfaceName | string | No | Physical or logical port or card (if applicable) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| networkService | string | No | Network name (internal AT&T field) | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ -| possibleRootCause | string | No | Reserved for future use | -+-----------------------------------+---------------+-------------+-----------------------------------------------------------------------------------------------------------------------------+ - -Technology Specific Datatypes ------------------------------ - -'Mobile Flow' Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: gtpPerFlowMetrics -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The gtpPerFlowMetrics datatype consists of the following fields: - -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+====================================+=====================+=============+===================================================================================================================================================================================================================+ -| avgBitErrorRate | number | Yes | Average bit error rate | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgPacketDelayVariation | number | Yes | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgPacketLatency | number | Yes | Average delivery latency | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgReceiveThroughput | number | Yes | Average receive throughput | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| avgTransmitThroughput | number | Yes | Average transmit throughput | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| durConnectionFailedStatus | number | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| durTunnelFailedStatus | number | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivatedBy | string | No | Endpoint activating the flow | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationEpoch | number | Yes | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowActivationTime | string | No | 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' | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivatedBy | string | No | Endpoint deactivating the flow | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationEpoch | number | Yes | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDeactivationTime | string | Yes | 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' | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowStatus | string | Yes | Connection status at reporting time as a working / inactive / failed indicator value | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpConnectionStatus | string | No | Current connection state at reporting time | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpTunnelStatus | string | No | Current tunnel state at reporting time | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipTosCountList | associative array | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipTosList | string | No | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| largePacketRtt | number | No | large packet round trip time | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| largePacketThreshold | number | No | large packet threshold being applied | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxPacketDelayVariation | number | Yes | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxReceiveBitRate | number | No | maximum receive bit rate" | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| maxTransmitBitRate | number | No | maximum transmit bit rate | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mobileQciCosCountList | associative array | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mobileQciCosList | string | No | Array of unique LTE QCI or UMTS class-of-service values observed in the flow | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numActivationFailures | number | Yes | Number of failed activation requests, as observed by the reporting node | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBitErrors | number | Yes | number of errored bits | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBytesReceived | number | Yes | number of bytes received, including retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numBytesTransmitted | number | Yes | number of bytes transmitted, including retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numDroppedPackets | number | Yes | number of received packets dropped due to errors per virtual interface | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numGtpEchoFailures | number | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numGtpTunnelErrors | number | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numHttpErrors | number | No | Http error count | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, including retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numL7BytesTransmitted | number | Yes | number of tunneled layer 7 bytes transmitted, excluding retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numLostPackets | number | Yes | number of lost packets | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numOutOfOrderPackets | number | Yes | number of out-of-order packets | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketErrors | number | Yes | number of errored packets | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsReceivedExclRetrans | number | Yes | number of packets received, excluding retransmission | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsReceivedInclRetrans | number | Yes | number of packets received, including retransmission | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numRetries | number | Yes | number of packet retries | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numTimeouts | number | Yes | number of packet timeouts | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| numTunneledL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, excluding retransmissions | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| roundTripTime | number | Yes | Round Trip time | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tcpFlagCountList | associative array | No | 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 | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tcpFlagList | string | No | Array of unique TCP Flags observed in the flow | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| timeToFirstByte | number | Yes | Time in milliseconds between the connection activation and first byte received | -+------------------------------------+---------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: mobileFlowFields -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The mobileFlowFields datatype consists of the following fields: - -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===========================+======================+=============+==============================================================================================================================================================================================+ -| mobileFlowFieldsVersion | number | Yes | Version of the mobileFlowFields block (currently: 2.0) | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| additionalFields | field [ ] | No | Additional mobileFlow fields if needed | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| applicationType | string | No | Application type inferred | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| appProtocolType | string | No | Application protocol | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| appProtocolVersion | string | No | Application version | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| cid | string | No | Cell Id | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| connectionType | string | No | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ecgi | string | No | Evolved Cell Global Id | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| flowDirection | string | Yes | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpPerFlowMetrics | gtpPer FlowMetrics | Yes | Mobility GTP Protocol per flow metrics | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpProtocolType | string | No | GTP protocol | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| gtpVersion | string | No | GTP protocol version | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| httpHeader | string | No | HTTP request header, if the flow connects to a node referenced by HTTP | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| imei | string | No | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| imsi | string | No | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipProtocolType | string | Yes | IP protocol type e.g., TCP, UDP, RTP... | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| lac | string | No | Location area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mcc | string | No | Mobile country code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mnc | string | No | Mobile network code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| msisdn | string | No | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherEndpointIpAddress | string | Yes | IP address for the other endpoint, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherEndpointPort | integer | Yes | IP Port for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| otherFunctionalRole | string | No | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| rac | string | No | Routing area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| radioAccessTechnology | string | No | Radio Access Technology e.g., 2G, 3G, LTE | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEndpointIpAddr | string | Yes | IP address for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| reportingEndpointPort | integer | Yes | IP port for the reporting entity, as used for the flow being reported on | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| sac | string | No | Service area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| samplingAlgorithm | integer | No | 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 | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tac | string | No | Transport area code | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| tunnelId | string | No | Tunnel identifier | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| vlanId | string | No | VLAN identifier used by this flow | -+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -'SipSignaling'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: sipSignalingFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The sipSignalingFields datatype communicates information about sip -signaling messages, parameters and signaling state; it consists of the -following fields: - -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+=======================+=============+===============================================================+ -| sipSignalingFieldsVersion | number | Yes | Version of the sipSignalingFields block (currently: 1.0) | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| additionalInformation | field [ ] | No | Additional sipSignaling fields | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| compressedSip | string | No | The full SIP request/response including headers and bodies | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| correlator | string | Yes | Constant across all events on this call | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| localIpAddress | string | Yes | IP address on VNF | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| localPort | string | Yes | Port on VNF | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| remoteIpAddress | string | Yes | IP address of peer endpoint | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| remotePort | string | Yes | Port of peer endpoint | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| summarySip | string | No | The SIP Method or Response ('INVITE', '200 OK', 'BYE', etc) | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ -| vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names | -+-----------------------------+-----------------------+-------------+---------------------------------------------------------------+ - -'Voice Quality'Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: endOfCallVqmSummaries -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The endOfCallVqmSummaries datatype provides end of call voice quality -metrics; it consists of the following fields: - -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+===============================+==========+=============+==================================================================================================================================================================================================================+ -| adjacencyName | string | Yes | Adjacency name | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointDescription | string | Yes | Enumeration: 'Caller', 'Callee' | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointJitter | number | No | Endpoint jitter | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsDiscarded | number | No | Endpoint RTP octets discarded | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsReceived | number | No | Endpoint RTP octets received | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpOctetsSent | number | No | Endpoint RTP octets sent | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsDiscarded | number | No | Endpoint RTP packets discarded | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsReceived | number | No | Endpoint RTP packets received | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| endpointRtpPacketsSent | number | No | Endpoint RTP packets sent | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localJitter | number | No | Local jitter | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsDiscarded | number | No | Local RTP octets discarded | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsReceived | number | No | Local RTP octets received | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpOctetsSent | number | No | Local RTP octets sent | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsDiscarded | number | No | Local RTP packets discarded | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsReceived | number | No | Local RTP packets received | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| localRtpPacketsSent | number | No | Local RTP packets sent | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| mosCqe | number | No | Decimal range from 1 to 5 (1 decimal place) | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| packetsLost | number | No | Packets lost | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| packetLossPercent | number | No | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| rFactor | number | No | rFactor from 0 to 100 | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| roundTripDelay | number | No | Round trip delay in milliseconds | -+-------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Datatype: voiceQualityFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The voiceQualityFields datatype provides statistics related to customer -facing voice products; consists of the following fields: - -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| Field | Type | Required? | Description | -+=============================+==========================+=============+==========================================================================+ -| voiceQualityFieldsVersion | number | Yes | Version of the voiceQualityFields block (currently: 1.0) | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| additionalInformation | field [ ] | No | Additional voice quality fields | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| calleeSideCodec | string | Yes | Callee codec for the call | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| callerSideCodec | string | Yes | Caller codec for the call | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| correlator | string | Yes | Constant across all events on this call | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| endOfCallVqmSummaries | endOfCallVqm Summaries | No | End of call voice quality metric summaries | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| phoneNumber | string | No | Phone number associated with the correlator | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| midCallRtcp | string | Yes | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ -| vendorVnfNameFields | vendorVnfNameFields | Yes | Vendor, VNF and VfModule names | -+-----------------------------+--------------------------+-------------+--------------------------------------------------------------------------+ - -Exceptions -========== - -RESTful Web Services Exceptions -------------------------------- - -RESTful services generate and send exceptions to clients in response to -invocation errors. Exceptions send HTTP status codes (specified later in -this document for each operation). HTTP status codes may be followed by -an optional JSON exception structure described below. Two types of -exceptions may be defined: service exceptions and policy exceptions. - -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Field Name** | **Data Type** | **Required?** | **Description** | -+==================+============================+=================+========================================================================================================================================================================================================================================================================+ -| messageId | xs:string | Yes | Unique message identifier of the format 'ABCnnnn'where 'ABC'is either 'SVC'for Service Exceptions or 'POL'for Policy Exception. | -| | | | | -| | | | Exception numbers may be in the range of 0001 to 9999 where : | -| | | | | -| | | | - 0001 to 2999 are defined by OMA (see OMA's `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details) | -| | | | | -| | | | - 3000-9999 are available and undefined | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| text | xs:string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| variables | xs:string [0..unbounded] | No | List of zero or more strings that represent the contents of the variables used by the message text. | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| url | xs:anyUrl | No | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents). | -+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Service Exceptions ------------------- - -When a service is not able to process a request, and retrying the -request with the same information will also result in a failure, and the -issue is not related to a service policy issue, then the service will -issue a fault using the service exception fault message. Examples of -service exceptions include invalid input, lack of availability of a -required resource or a processing error. - -A service exception uses the letters 'SVC' at the beginning of the -message identifier. 'SVC'service exceptions used by the VES Event -Listener API are defined below. - -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | -+===============+=======================================+===============================================================+===============================================+======================+ -| SVC0001 | General service error (see SVC2000) | <custom error message> | None | 400 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC0002 | Bad parameter | Invalid input value for message part %1 | %1: message part | 400 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC1000 | No server resources | No server resources available to process the request | None | 500 | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ -| SVC2000 | More elaborate version of SVC0001 | The following service error occurred: %1. Error code is %2. | %1: human readable description of the error | 400 | -| | | | | | -| | | | %2: error code | | -+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+ - - Table - Service Exceptions - -Policy Exceptions ------------------ - -When a service is not able to complete because the request fails to meet -a policy criteria, then the service will issue a fault using the policy -exception fault message. To clarify how a policy exception differs from -a service exception, consider that all the input to an operation may be -valid as meeting the required input for the operation (thus no service -exception), but using that input in the execution of the service may -result in conditions that require the service not to complete. Examples -of policy exceptions include privacy violations, requests not permitted -under a governing service agreement or input content not acceptable to -the service provider. - -A Policy Exception uses the letters 'POL' at the beginning of the -message identifier. 'POL'policy exceptions used by the VES Event -Listener API are defined below. - -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* | -+===============+======================================+==============================================================+===============================================+======================+ -| POL0001 | General policy error (see POL2000) | A policy error occurred. | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL1009 | User not provisioned for service | User has not been provisioned for service | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL1010 | User suspended from service | User has been suspended from service | None | 401 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL2000 | More elaborate version of POL0001 | The following policy error occurred: %1. Error code is %2. | %1: human readable description of the error | 401 | -| | | | | | -| | | | %2: error code | | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ -| POL9003 | Message size exceeds limit | Message content size exceeds the allowable limit | None | 400 | -+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+ - - Table - Policy Exceptions - -RESTful Web Services Definition -=============================== - -REST Operation Overview ------------------------ - -REST Operation Summary -~~~~~~~~~~~~~~~~~~~~~~~ - -+--------------------------------+------------+----------------------------------------------------------------------------+ -| **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** | -| | | | -| | **Verb** | | -+--------------------------------+------------+----------------------------------------------------------------------------+ -| publishAnyEvent | POST | /eventListener/v{apiVersion} | -+--------------------------------+------------+----------------------------------------------------------------------------+ -| publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch | -+--------------------------------+------------+----------------------------------------------------------------------------+ -| provideClientThrottlingState | POST | /eventListener/v{apiVersion}/clientThrottlingState | -+--------------------------------+------------+----------------------------------------------------------------------------+ - -Table - REST Operation Summary - -API Version -~~~~~~~~~~~ - -apiVersion is used to describe the major version number of the event -listener API (which is the same as the major version number of this -specification). When this number changes, the implication is: clients of -older versions will break in some way, if they try to use the new API -without modification (e.g., unmodified v1 clients would not be able to -use v2 without error). - -Commands Toward Event Source Clients -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Note: Vendors are not currently required to implement support for -command processing; in addition, command processing may be supported by -an App-C interface in future. - -This specification supports commands from event consumers back toward -event source clients. This enables the event consumer (e.g., AT&T event -collectors) to command event sources to change their measurement -intervals or throttle the information they are sending to the event -consumer. Note that commands are sent as part of the synchronous -response to events sent by the event source toward the event consumer. -This is done so that the event source does not need to host a service to -listen for commands from events consumers. The following commands are -currently supported: - -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Command** | **Description** | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| heartbeatInterval Change | Commands the event source to change the interval (in seconds) it waits between heartbeat events sent to the VES Event Listener. If '0'is provided, the event source should return to its default heartbeatInterval. | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| measurementIntervalChange | Commands the event source to change its measurementInterval to the number provided (in seconds). If '0'is provided, the event source should return to its default measurementInterval. | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| provideThrottlingState | Commands the event source to invoke the provideThrottlingState operation on the event consumer. | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| throttlingSpecification | Commands the event source to throttle events as specified by the provided eventDomainThrottlingSpecification. This specification identifies the fields to suppress within the domain and even supports identification of subfields to suppress within objects or name-value pair structures. Note that required fields should not be suppressed and may result in errors being thrown by the event consumer back toward the event source when events without the required fields are sent to the event consumer. Other notes for event sources: | -| | | -| | - the default throttling state is \*off\* for all domains | -| | | -| | - the throttling state for a domain is altered only by receipt of an eventDomainThrottleSpecification for that domain | -| | | -| | - the presence of the optional suppressedFieldNames replaces any existing list of suppressed field names | -| | | -| | - if suppressedFieldNames is not provided, then any existing list of suppressed field names shall be discarded | -| | | -| | - the presence of the optional suppressedNvPairsList replaces the any existing list of suppressed name-value pairs | -| | | -| | - if suppressedNvPairsList is not provided, then any existing list of suppressed name-value pairs shall be discarded | -+-----------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Buffering of Events -~~~~~~~~~~~~~~~~~~~~ - -{ServerRoot} is defined in section 3 of this document, which defines the -REST resource URL. One or more FQDNs may be provisioned in an event -source when it is instantiated or updated. If an event source is unable -to reach any of the provisioned FQDNs, it should buffer the event data -specified below, up to a maximum of 1 hour, until a connection can be -established and the events can be successfully delivered to the VES -Event Listener service. - -During such an outage, only the following events should be buffered: - -- Faults with eventSeverity of "MINOR", "MAJOR" or "CRITICAL" - -- Syslogs with syslogSev of 0-5 - -- All MeasurementsForVfScaling events - -VNFs acting as event sources should not send syslog events to the VES -Event Listener during debug mode (which is controlled via the Netconf -management interface), but should store syslog events locally for -access, and possible FTP transfer, via the VNF console (e.g., command -line interface). - -If the internal event source event buffer or local storage should -overflow, then the event source should send a Fault event, and should -discard events in a first-in, first-out (FIFO) manner (i.e., discard -oldest events first). - -Operation: publishAnyEvent --------------------------- - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish any single event to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -- Allows the event collector to use the HTTP response to command the - event source to throttle event messages it may send in the future. - -Call Flow -~~~~~~~~~ - -|image1| - -Figure 2 - publishAnyEvent Call Flow - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Accept | string | No | Determines the format of the body of the response. Valid values are: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-length | integer | No | Note that content length is limited to 1Megabyte. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-type | string | Yes | Must be set to one of the following values: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ -| Event | event | Yes | Contains the JSON structure of the common event format. | -+-----------------+-----------------+-----------------+-----------------------------------------------------------+ - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+------------------+-----------------+-----------------+------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+------------------------------------+ -| Content-length | integer | No | Used only in error conditions. | -+------------------+-----------------+-----------------+------------------------------------+ -| Content-type | string | No | Used only in error conditions | -+------------------+-----------------+-----------------+------------------------------------+ -| Date | datetime | Yes | Date time of the response in GMT | -+------------------+-----------------+-----------------+------------------------------------+ - -Body Fields (for success responses without a commandList): no content is -provided and the header fields are not required. - -Body Fields (for success responses with one or more commands from the -event collector toward the event source): - -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| commandList | commandList | No | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation. | -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Body Fields (for error Responses): - -+-----------------+-----------------+--------------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+--------------------+----------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+-----------------+-----------------+--------------------+----------------------------------+ - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Code* | *Reason Phrase* | *Description* | -+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ -| 202 | Accepted | The request has been accepted for processing | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - - .. code:: bash - - POST /eventListener/v5 HTTPS/1.1 - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== - content-type: application/json - content-length: 12345 - { - "event": { - "commonEventHeader": { - "version": 3.0, - "domain": "fault", - "eventName": Fault\_MobileCallRecording\_PilotNumberPoolExhaustion", - "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015", - "sequence": 0, - "priority": "High", - "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", - "reportingEntityName": "EricssonOamVf", - "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", - "sourceName": "scfx0001vm002cap001", - "nfNamingCode": "scfx", - "nfcNamingCode": "ssc", - "startEpochMicrosec": 1413378172000000, - "lastEpochMicrosec": 1413378172000000 - }, - "faultFields": { - "faultFieldsVersion": 2.0, - "alarmCondition": "PilotNumberPoolExhaustion", - "eventSourceType": "other", - "specificProblem": "Calls cannot complete - pilot numbers are unavailable", - "eventSeverity": "CRITICAL", - "vfStatus": "Active", - "alarmAdditionalInformation": [ - { - "name": "PilotNumberPoolSize", - "value": "1000" - } - ] - } - } - } - -Sample Success Response #1 -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - For success responses without a provided command list: - - .. code:: bash - - HTTPS/1.1 202 Accepted - -Sample Success Response #2 -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - For success responses with a provided command list: - - .. code:: bash - - HTTPS/1.1 202 Accepted - content-type: application/json - content-length: nnn - date: Sat, 04 Jul 2015 02:03:15 GMT - { - "commandList": [ - { - "commandType": "throttlingSpecification", - "eventDomainThrottleSpecification": { - "eventDomain": "fault", - "suppressedFieldNames": [ - "alarmInterfaceA", - "alarmAdditionalInformation" - ] - } - }, - { - "commandType": "throttlingSpecification", - eventDomainThrottleSpecification": { - "eventDomain": "thresholdCrossingAlert", - "suppressedFieldNames": [ - "associatedAlertIdList", - "possibleRootCause" - ], - "suppressedNvPairs" { - "nvPairFieldName": additionalParameters", - "suppressedNvPairNames": [ - "someCounterName", - "someOtherCounterName" - ] - } - } - }, - { - "commandType": "measurementIntervalChange", - "measurementInterval": 600 - }, - { - "commandType": "heartbeatIntervalChange", - "heartbeatInterval": 90 - }, - { - "commandType": "provideThrottlingState" - } - ] - } - -1. .. rubric:: Sample Error Responses - - :name: sample-error-responses - - 1. .. rubric:: Sample Policy Exception - - :name: sample-policy-exception - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "policyException": { - "messageId": "POL9003", - "text": "Message content size exceeds the allowable limit", - } - } - } - -Sample Service Exception -'''''''''''''''''''''''' - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "serviceException": { - "messageId": "SVC2000", - "text": "Missing Parameter: %1. Error code is %2" - "variables": [ - "severity", - "400" - ] - } - } - } - -Operation: publishEventBatch ----------------------------- - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish any single event to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -- Allows the event collector to use the HTTP response to command the - event source to throttle event messages it may send in the future. - -Call Flow -~~~~~~~~~ - -|image2| - -Figure 3 publishEventBatch Call Flow - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Accept | string | No | Determines the format of the body of the response. Valid values are: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-length | integer | No | Note that content length is limited to 1Megabyte. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-type | string | Yes | Must be set to one of the following values: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+----------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+----------------------------------------------------------+ -| eventList | eventList | Yes | Array of events conforming to the common event format. | -+-----------------+-----------------+-----------------+----------------------------------------------------------+ - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+------------------+-----------------+-----------------+------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+------------------------------------+ -| Content-length | integer | No | Used only in error conditions. | -+------------------+-----------------+-----------------+------------------------------------+ -| Content-type | string | No | Used only in error conditions | -+------------------+-----------------+-----------------+------------------------------------+ -| Date | datetime | Yes | Date time of the response in GMT | -+------------------+-----------------+-----------------+------------------------------------+ - -Body Fields (for success responses without a commandList): no content is -provided and the header fields are not required. - -Body Fields (for success responses with one or more commands from the -event collector toward the event source): - -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| commandList | commandList | No | Array of commands (e.g., measurement Interval changes and/or what fields to suppress within specified event domains and/or a request to report the state of event throttling by event domain that is currently in force in the event source). Note: for 'provideThrottlingState'commands, the client should subsequently provide the throttling state by calling the provideThrottlingState operation. | -+-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Body Fields (for error Responses): - -+-----------------+-----------------+--------------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+--------------------+----------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+-----------------+-----------------+--------------------+----------------------------------+ - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Code* | *Reason Phrase* | *Description* | -+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ -| 202 | Accepted | The request has been accepted for processing | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - - .. code:: bash - - POST /eventListener/v5/eventBatch HTTPS/1.1 - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== - content-type: application/json - content-length: 12345 - { - "eventList": [ - { - "commonEventHeader": { - "version": 3.0, - "domain": "fault", - "eventName": "Fault\_MobileCallRecording\_PilotNumberPoolExhaustion", - "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015", - "sequence": 0, - "priority": "High", - "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", - "reportingEntityName": "EricssonOamVf", - "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", - "sourceName": "scfx0001vm002cap001", - "nfNamingCode": "scfx", - "nfcNamingCode": "ssc", - "startEpochMicrosec": 1413378172000000, - "lastEpochMicrosec": 1413378172000000 - }, - "faultFields": { - "faultFieldsVersion": 2.0, - "alarmCondition": "PilotNumberPoolExhaustion", - "eventSourceType": "other", - "specificProblem": "Calls cannot complete - pilot numbers are unavailable", - "eventSeverity": "CRITICAL", - "vfStatus": "Active", - "alarmAdditionalInformation": [ - { - "name": "PilotNumberPoolSize", - "value": "1000" - } - ] - } - }, - { - "commonEventHeader": { - "version": 3.0, - "domain": "fault", - "eventName": "Fault\_MobileCallRecording\_RecordingServerUnreachable", - "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546025", - "sequence": 0, - "priority": "High", - "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", - "reportingEntityName": "EricssonOamVf", - "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", - "sourceName": "scfx0001vm002cap001", - "nfNamingCode": "scfx", - "nfcNamingCode": "ssc", - "startEpochMicrosec": 1413378172000010, - "lastEpochMicrosec": 1413378172000010 - }, - "faultFields": { - "faultFieldsVersion": 2.0, - "alarmCondition": "RecordingServerUnreachable", - "eventSourceType": "other", - "specificProblem": "Recording server unreachable", - "eventSeverity": "CRITICAL", - "vfStatus": "Active" - } - } - ] - } - -Sample Success Response #1 -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - For success responses without a provided commandList: - - .. code:: bash - - HTTPS/1.1 202 Accepted - -Sample Success Response #2 -^^^^^^^^^^^^^^^^^^^^^^^^^^ - - For success responses with a provided commandList: - - .. code:: bash - - HTTPS/1.1 202 Accepted - content-type: application/json - content-length: nnn - date: Sat, 04 Jul 2015 02:03:15 GMT - { - "commandList": [ - { - "commandType": "throttlingSpecification", - "eventDomainThrottleSpecification": { - "eventDomain": "fault", - "suppressedFieldNames": [ - "alarmInterfaceA", - "alarmAdditionalInformation" - ] - } - }, - { - "commandType": "throttlingSpecification", - "eventDomainThrottleSpecification": { - "eventDomain": "thresholdCrossingAlert", - "suppressedFieldNames": [ - "associatedAlertIdList", - "possibleRootCause" - ], - "suppressedNvPairs" { - "nvPairFieldName": additionalParameters", - "suppressedNvPairNames": [ - "someCounterName", - "someOtherCounterName" - ] - } - } - }, - { - "commandType": "measurementIntervalChange", - "measurementInterval": 600 - }, - { - "commandType": "heartbeatIntervalChange", - "heartbeatInterval": 90 - }, - { - "commandType": "provideThrottlingState" - } - ] - } - -1. .. rubric:: Sample Error Responses - - :name: sample-error-responses-1 - -2. .. rubric:: Sample Policy Exception - - :name: sample-policy-exception-1 - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "policyException": { - "messageId": "POL9003", - "text": "Message content size exceeds the allowable limit", - } - } - } - -Sample Service Exception -'''''''''''''''''''''''' - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "serviceException": { - "messageId": "SVC2000", - "text": "Missing Parameter: %1. Error code is %2" - "variables": [ - "severity", - "400" - ] - } - } - } - -Operation: provideThrottlingState ---------------------------------- - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized event source clients to report the state of event -throttling by event domain that is currently in force in the event -source. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports application/json content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -Call Flow -~~~~~~~~~ - -|image3| - -Figure 4 - provideClientThrottlingState Call Flow - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Accept | string | No | Determines the format of the body of the response. Valid values are: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Authorization | string | Yes | The username and password are formed into one string as "username:password". This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string "Authorization: Basic ". See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-length | integer | No | Note that content length is limited to 1Megabyte. | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Content-type | string | Yes | Must be set to one of the following values: | -| | | | | -| | | | - application/json | -+------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Body Fields: - -+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| eventThrottlingState | eventThrottlingState | Yes | Consists of an eventThrottlingMode enumeration which can be 'normal'or 'throttled'followed by an optional array of eventDomainThrottleSpecification structures | -+------------------------+------------------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Output Parameters -~~~~~~~~~~~~~~~~~ - -The only output parameters are an HTTP response code and message. - -+------------------+-----------------+-----------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+------------------+-----------------+-----------------+----------------------------------+ -| Content-length | integer | No | Used only in error conditions. | -+------------------+-----------------+-----------------+----------------------------------+ -| Content-type | string | No | Used only in error conditions. | -+------------------+-----------------+-----------------+----------------------------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+----------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+-----------------+-----------------+-----------------+----------------------------------+ -| requestError | requestError | No | Used only in error conditions. | -+-----------------+-----------------+-----------------+----------------------------------+ - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| *Code* | *Reason Phrase* | *Description* | -+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+ -| 204 | No Content | The throttling state update message has been accepted. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | Locked | The request could not be completed due to a conflict with the current state of the resource. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 503 | Service Unavailable | The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 504 | Gateway Timeout | The server, while acting as a gateway or proxy, did not receive a timely response from the upstream process. | -+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - - .. code:: bash - - POST /eventListener/v5/clientThrottlingState HTTPS/1.1 - Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== - content-type: application/json - content-length: nnn - accept: application/json - { - "eventThrottlingState": { - "eventThrottlingMode": "throttled", - "eventDomainThrottleSpecificationList": [ - { - "eventDomain": "fault", - "suppressedFieldNames": [ - "alarmInterfaceA", - "alarmAdditionalInformation" - ] - }, - { - "eventDomain": "thresholdCrossingAlert", - "suppressedFieldNames": [ - "associatedAlertIdList", - "possibleRootCause" - ], - "suppressedNvPairsList": [ - { - "nvPairFieldName": "additionalParameters", - "suppressedNvPairNames": [ - "someCounterName", - "someOtherCounterName" - ] - } - ] - } - ] - } - } - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - - .. code:: bash - - HTTPS/1.1 204 No Content - -1. .. rubric:: Sample Error Responses - - :name: sample-error-responses-2 - - 1. .. rubric:: Sample Policy Exception - - :name: sample-policy-exception-2 - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "policyException": { - "messageId": "POL9003", - "text": "Message content size exceeds the allowable limit", - } - } - } - -Sample Service Exception -'''''''''''''''''''''''' - - .. code:: bash - - HTTPS/1.1 400 Bad Request - content-type: application/json - content-length: 12345 - Date: Thu, 04 Jun 2009 02:51:59 GMT - { - "requestError": { - "serviceException": { - "messageId": "SVC2000", - "text": "Missing Parameter: %1. Error code is %2" - "variables": [ - "severity", - "400" - ] - } - } - } - -.. |image0| image:: ves-rest-resource-structure.png - :height: 600px - :width: 800px -.. |image1| image:: ves-publishanyevent.png - :height: 600px - :width: 800px -.. |image2| image:: ves-publisheventbatch.png - :height: 600px - :width: 800px -.. |image3| image:: ves-providethrottlingstate.png - :height: 600px - :width: 800px - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/files/VESEventListener_7_0_1.rst b/docs/files/VESEventListener_7_0_1.rst deleted file mode 100644 index c8cd22f..0000000 --- a/docs/files/VESEventListener_7_0_1.rst +++ /dev/null @@ -1,10443 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -=================================== -Service: *VES Event Listener 7.0.1* -=================================== - -.. contents:: Table of Contents -Introduction -============ - -This document describes the RESTful interface for the VES Event -Listener. The VES acronym originally stood for Virtual-function Event -Streaming, but VES has been generalized to support network-function -event streaming, whether virtualized or not. The VES Event Listener is -capable of receiving any event sent in the VES Common Event Format. The -Common Event Format is expressed in JSON schema in section 4 of this -document. In the Common Event Format, an event consists of a required -Common Event Header block (i.e., object) accompanied by zero or more -event domain blocks. - -It should be understood that events are well structured packages of -information, identified by an eventName, which are asynchronously -communicated to subscribers who are interested in the eventName. Events -can convey measurements, faults, syslogs, threshold crossing alerts and -other types of information. Events are simply a way of communicating -well-structured packages of information to one or more instances of an -Event Listener service. - -This document describes a RESTful connectionless push event listener -that is capable of receiving single events or batches of events in the -Common Event Format. In future, additional documents may describe other -transports which make use of persistent TCP connections for high volumes -of streaming events. - -Event Registration ------------------- - -All events must be compliant with the common event format, but specific -events identified by their eventNames, may require that certain fields, -which are optional in the common event format, be present when they are -published. For example, a specific eventName may require that specific -name-value pairs be present in the extensible structures provided within -the Common Event Format. - -Events are registered using an extensible YAML format (defined in a -separate document), which specifies, for each eventName, the fields that -are required, what field values may be sent, and any special handling -that should be performed on those eventNames. - -Naming Standards for eventName ------------------------------- - -To prevent naming collisions, eventNames sent as part of the -commonEventHeader, should conform to the following naming convention -designed to summarize the purpose and type of the event, and to ensure -the uniqueness of the eventName: - - {DomainAbbreviation}_{PublisherName}_{Description} - -Each underscore-separated subfield above must start with a capital -letter and use camel-casing to separate words and acronyms. Acronyms -must capitalize only the first letter of the acronym. Spaces and -underscores should not appear within any subfield. - -The DomainAbbreviation subfield derives from the ‘domain’ field in the -commonEventHeader, as specified below: - -- ‘Fault’ for the fault domain - -- ‘Heartbeat’ for the heartbeat domain - -- ‘Measurement’ for the measurements domain - -- ‘MobileFlow’ for the mobileFlow domain - -- ‘Other’ for the other domain - -- ‘PnfReg’ for the pnfRegistration domain - -- ‘SipSignaling’ for the sipSignaling domain - -- ‘StateChange’ for the stateChange domain - -- ‘Syslog’ for the syslog domain - -- ‘Tca’ for the thresholdCrossingAlert domain - -- ‘VoiceQuality’ for the voiceQuality domain - -The PublisherName subfield describes the vendor product or application -publishing the event. This subfield conforms to the following -conventions: - -- Vendor products are specified as: - -{productName}-{vendorName} - - For example: Visbc-Metaswitch or Vdbe-Juniper, where a hyphen is used - to separate the productName and vendorName subfields. Note that the - productName and vendorName subfields must not include hyphens - themselves. - - Organizing the information in this way will cause an alphabetical - listing of eventNames to sort similar network functions together, - rather than to sort them by vendor. - - The productName subfield may describe a NF or a NFC. Where NFC names - may be reused across different NF’s, they should be specified as: - -{NfName}:{NfcName} - - where a colon is used to separate the NfName and NfcName subfields. - Note that the NfName and NfcName subfields must not include colons - themselves. - - The ProductName may also describe other types of vendor modules or - components such as a VM, application or hostname. As with NFs and - NFCs, parent:child relationships may be communicated using colon as a - subfield delimiter. - -- Service providers who adopt the VES Common Event Format for internal - use, may provide PublisherName without the vendorName subfield. They - would typically identify an application, system, service or - microservice publishing the event (e.g., ‘Policy’, ‘So’, - ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child - relationships may be communicated using colon as a subfield delimiter - (e.g., ApplicationName:ApplicationComponent). - -The final subfield of the eventName name should describe, in a compact -camel case format the specific information being conveyed by the event. -In some cases, this final subfield may not be required (e.g., in the -case of certain heartbeats). - -Examples of eventNames following the naming standards are provided -below: - -- Tca_Vdbe-Ericsson_CpuThresholdExceeded - -- Heartbeat_Visbc:Mmc-Metaswitch - -- Syslog_Vdbe-Ericsson - -- Fault_MobileCallRecording_PilotNumberPoolExhaustion - -- Other_So:WanBonding_InstantiationPart1Complete - -EventId Use Cases Examples --------------------------- - -[Author: Alok Gupta]: - -eventId Examples: - -Example 1: assumes a unique key for each domain consisting of domain -followed by an integer domainnnnnnn e.g. fault000001, heartbeat000001, -mfvs000005 - -Example 2: assumes an integer key for all events nnnnnnnnn: 000000001, -00000002, 000000003 - -Rules: - -1. All domains except Fault: each time a subsequent event is sent the - integer part of eventId will increment by 1. Repeat of eventId - assumes duplicate event. Sequence number is set to 0 for all domains - except fault. - -2. eventId construction for Fault Events: - - a. Most likely scenario - - i. The sourceName on each Fault event is the vNFC Name or VM - hostname. - - ii. The eventId on Fault events is the same every time a given - fault is raised (onset), re-raised at fixed time interval, - until it is cleared. Once the fault is cleared, a new eventId - is used. - - iii. The startEpochMicrosec value for the Fault event is the - timestamp for when that event is generated until a clear is - sent. - - iv. lastEpochMicrosec indicates the current event time. - - v. The sequence number for each Fault event is set to 1 when the - event is first raised, and increments each time the same - Fault event is raised, until a clear is sent. - - |image0| - - b. Alternative scenario: for vNF when fault event status is not - maintained. - - vi. The sourceName on each Fault event is the vNFC Name or VM - hostname. - - vii. The eventId on Fault events is the same every time a given - fault is raised or cleared, even if it is re-raised after it - had previously cleared. So, for example, if EMS loses - contact with a particular device then a Fault event might be - sent for a raise, re-raise (because EMS has re-tried and - still can’t contact the device), clear (because EMS has - re-tried and it can contact the device) and then raise again - (because EMS has lost contact with the device again). The - same eventId is used for all 4 of those Fault events. - - viii. The startEpochMicrosec value for each Fault event is the - timestamp for when that event is generated, not when the - fault first occurred. So all 4 of the Fault events in the - previous bullet point would have a different timestamp. - - ix. lastEpochMicrosec indicates the current event time. - - x. The sequence number for each Fault event is currently set to - 0 on a raise and 1 on a clear. We could change that so that - each Fault event is given a new monotonically increasing - sequence number whether it is a raise or a clear if that is - helpful (which is reset to 0 if the VM restarts) but they - won’t be consecutive. - -|image1| - -Measurement Expansion Fields ----------------------------- - -When expansion fields are used, the goal is to avoid custom development -by the service provider collecting the fields, since custom development -adds obvious cost, delay and resource overhead. In the domain of -measurements, it is expected that a high percentage (perhaps as high as -90 percent) of use cases for extensible fields can be satisfied by using -the additionalMeasurements arrayOfNamedHashMap data structure in -combination with a YAML registration file (provided at design time). The -YAML registration file conveys meta-information about the processing of -additionalMeasurements. For more information, please see the VES Event -Registration specification and in particular the aggregationRole, castTo -and isHomogeneous keywords. - -Syslogs -------- - -Syslog’s can be classified as either Control or Session/Traffic. They -differ by message content and expected volume: - -- Control logs are generally free-form human-readable text used for - reporting errors or warnings supporting the operation and - troubleshooting of NFs. The volume of these logs is typically less - than 2k per day. - -- Session logs use common structured fields to report normal NF - processing such as DNS lookups or firewall rules processed. The - volume of these logs is typically greater than 1k per hour (and - sometimes as high as 10k per second). - -VES supports both classes of syslog, however VES is only recommended for -control logs or for lower volume session logs, less than 60k per hour. -High volume session logging should use a file-based transport solution. - -Support for Protocols Other Than HTTPS --------------------------------------- - -This API specification describes an HTTPS RESTful interface using the -JSON content-type. - -Alternative API specifications may be provided in future using Google -Protobuf, websockets, or Apache Avro. - -Versioning ----------- - -Three types of version numbers supported by this specification: - -- The API specification itself is versioned. Going forward, the major - number of the specification version will be incremented whenever any - change could break an existing client (e.g., a field name is deleted - or changed). All other changes to the spec (e.g., a field name is - added or text changes are made to the specification itself) will - increment only the minor number or patch number. Note that the major - number appears in REST resource URLs as v# (where ‘#’ is the major - number). Minor and patch numbers are communicated in HTTP headers. - For more information, see the API Versioning writeup in section 6.1. - -- The JSON schema is versioned. Going forward, the major number of the - JSON schema will be incremented whenever any change could break an - existing client (e.g., a field name is deleted or changed). All other - changes to the schema (e.g., a field name is added or text changes - are made to the field descriptions) will increment only the minor - number or patch number. - -- The field blocks are versioned. Field blocks include the - commonEventHeader and the domain blocks (e.g., the faultFields - block). Going forward, the major number of each field block will be - incremented whenever any change to that block could break an existing - client (e.g., a field name is deleted or changed). All other changes - to that block (e.g., a field name is added or text changes are made - to the field descriptions) will increment only the minor number. - -Field Block Versions -~~~~~~~~~~~~~~~~~~~~ - -A summary of the latest field block versions as of this version of the -API spec is provided below: - -- commonEventHeader version:4.0.1 - -- commonEventHeader vesEventListenerVersion: 7.0.1 - -- faultFieldsVersion:4.0 - -- heartbeatFieldsVersion: 3.0 - -- measurementFieldsVersion: 4.0 - -- mobileFlowFieldsVersion: 4.0 - -- notificationFieldsVersion: 2.0 - -- otherFieldsVersion: 3.0 - -- pnfRegistrationFieldsVersion: 2.0 - -- sigSignalingFieldsVersion: 3.0 - -- stateChangeFieldsVersion: 4.0 - -- syslogFieldsVersion: 4.0 - -- thresholdCrossingFieldsVersion: 4.0 - -- voiceQualityFieldsVersion: 4.0 - -Security -======== - -Event sources must identify themselves to the VES Event Listener. - -In the future, support for 2-way SSL certificate authentication (aka -mutual SSL) will be provided but for now, event source credentials are -passed using HTTP `Basic -Authentication <http://tools.ietf.org/html/rfc2617>`__. - -Credentials must not be passed on the query string. Credentials must be -sent in an Authorization header as follows: - -1. The username and password are formed into one string as - “username:password” - -2. The resulting string is Base64 encoded to produce the encoded - credential. - -3. The encoded credential is communicated in the header after the string - “Authorization: Basic “ - -Because the credentials are merely encoded but not encrypted, HTTPS -(rather than HTTP) should be used. HTTPS will also encrypt and protect -event contents. TLS 1.2 or higher must be used. - -Examples are provided below. - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - -+---------------------------------------------------------------+ -| POST /eventListener/v7 HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": "4.0.1", | -| | -| "vesEventListenerVersion": "7.0.1", | -| | -| "domain": "heartbeat", | -| | -| "eventName": "Heartbeat_vIsbcMmc", | -| | -| "eventId": "heartbeat0000249", | -| | -| "sequence": 0, | -| | -| "priority": "Normal", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam001", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "ibcx0001vm002ssc001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "ibcx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------------------+ - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -+------------------------+ - -Resource Structure -================== - -REST resources are defined with respect to a ServerRoot: - -ServerRoot = /{optionalRoutingtPath} - -The resource structure is provided below: - -|image2| - -Figure 1 – REST Resource Structure - -The {Domain} or FQDN above is typically provisioned into each -eventsource when it is instantiated. The {Port} above is typically 8443. - -Common Event Format -=================== - -A JSON schema describing the Common Event Format is provided below and -is reproduced in the tables that follow. - -Note on optional fields: - - If the event publisher collects a field that is identified as - optional in the data structures below, then the event publisher - *must* send that field. - -Note on extensible fields: - - VES contains various extensible structures (e.g., hashMap) that - enable event publishers to send information that has not been - explicitly defined in VES data structures. - -- Event publishers *must not* send information through extensible - structures where VES has explicitly defined fields for that - information. For example, event publishers *must not* send - information like cpuIdle, through an extensible structure, because - VES has explicitly defined a cpuUsage.cpuIdle field for the - communication of that information. - -- Keys sent through extensible fields must use camel casing to separate - words and acronyms; only the first letter of each acronym shall be - capitalized. - -Common Event Datatypes ----------------------- - -.. _common-event-datatypes-1: - -Common Event Datatypes -~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: arrayOfJsonObject -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The arrayOfJsonObject datatype provides an array of json objects, each -of which is described by name, schema and other meta-information. It -consists of the following fields: - -+-------------------+----------------+-----------+---------------------+ -| Field | Type | Required? | Description | -+===================+================+===========+=====================+ -| arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject | -+-------------------+----------------+-----------+---------------------+ - -Datatype: arrayOfNamedHashMap -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The arrayOfNamedHashMap datatype provides an array of hashMaps, each of -which is associated with a descriptive name. It consists of the -following fields: - -+---------------------+------------------+-----------+-----------------------+ -| Field | Type | Required? | Description | -+=====================+==================+===========+=======================+ -| arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap | -+---------------------+------------------+-----------+-----------------------+ - -Datatype: event -^^^^^^^^^^^^^^^ - -The event datatype consists of the following fields which constitute the -‘root level’ of the common event format: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| commonEventHead | commonEventHead | Yes | Fields common | -| er | er | | to all events | -+-----------------+-----------------+-----------------+-----------------+ -| faultFields | faultFields | No | Fields specific | -| | | | to fault events | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatFields | heartbeatFields | No | Fields specific | -| | | | to heartbeat | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| measurementFiel | measurementFiel | No | Fields specific | -| ds | ds | | to measurement | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| mobileFlowField | mobileFlowField | No | Fields specific | -| s | s | | to mobility | -| | | | flow events | -+-----------------+-----------------+-----------------+-----------------+ -| notificationFie | notificationFie | No | Fields specific | -| lds | lds | | to notification | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| otherFields | otherFields | No | Fields specific | -| | | | to other types | -| | | | of events | -+-----------------+-----------------+-----------------+-----------------+ -| pnfRegistration | pnfRegistration | No | Fields specific | -| Fields | Fields | | to | -| | | | pnfRegistration | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| sipSignalingFie | sipSignalingFie | No | Fields specific | -| lds | lds | | to sipSignaling | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| stateChangeFiel | stateChangeFiel | No | Fields specific | -| ds | ds | | to state change | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFields | syslogFields | No | Fields specific | -| | | | to syslog | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| thresholdCrossi | thresholdCrossi | No | Fields specific | -| ngAlertFields | ngAlertFields | | to threshold | -| | | | crossing alert | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| voiceQualityFie | voiceQualityFie | No | Fields specific | -| lds | lds | | to voiceQuality | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: eventList -^^^^^^^^^^^^^^^^^^^ - -The eventList datatype consists of the following fields: - -+-----------+-----------+-----------+-----------------+ -| Field | Type | Required? | Description | -+===========+===========+===========+=================+ -| eventList | event [ ] | Yes | Array of events | -+-----------+-----------+-----------+-----------------+ - -Datatype: hashMap -^^^^^^^^^^^^^^^^^ - -The hashMap datatype is an ‘associative array’, which is an unordered -collection of key-value pairs of the form “key”: “value”, where each key -and value are strings. Keys must use camel casing to separate words and -acronyms; only the first letter of each acronym shall be capitalized. - -Datatype: jsonObject -^^^^^^^^^^^^^^^^^^^^ - -The jsonObject datatype provides a json object schema, name and other -meta-information along with one or more object instances that conform to -the schema: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| objectInstances | JsonObjectInsta | Yes | Contains one or | -| | nce | | more instances | -| | [ ] | | of the json | -| | | | object | -+-----------------+-----------------+-----------------+-----------------+ -| objectName | string | Yes | Name of the | -| | | | json object | -+-----------------+-----------------+-----------------+-----------------+ -| objectSchema | string | No | json schema for | -| | | | the object | -+-----------------+-----------------+-----------------+-----------------+ -| objectSchemaUrl | string | No | URL to the json | -| | | | schema for the | -| | | | object | -+-----------------+-----------------+-----------------+-----------------+ -| nfSubscribedObj | string | No | Name of the | -| ectName | | | object | -| | | | associated with | -| | | | the | -| | | | nfSubscriptionI | -| | | | d | -+-----------------+-----------------+-----------------+-----------------+ -| nfSubscriptionI | string | No | Identifies an | -| d | | | openConfig | -| | | | telemetry | -| | | | subscription on | -| | | | a network | -| | | | function, which | -| | | | configures the | -| | | | network | -| | | | function to | -| | | | send complex | -| | | | object data | -| | | | associated with | -| | | | the jsonObject | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: jsonObjectInstance -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The jsonObjectInstance datatype provides meta-information about an -instance of a jsonObject along with the actual object instance: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| jsonObject | jsonObject | No | Optional | -| | | | recursive | -| | | | specification | -| | | | of jsonObject | -+-----------------+-----------------+-----------------+-----------------+ -| objectInstance | object | No | Contains an | -| | | | instance | -| | | | conforming to | -| | | | the jsonObject | -| | | | schema | -+-----------------+-----------------+-----------------+-----------------+ -| objectInstanceE | number | No | the unix time, | -| pochMicrosec | | | aka epoch time, | -| | | | associated with | -| | | | this | -| | | | objectInstance- | -| | | | -as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| objectKeys | key [ ] | No | An ordered set | -| | | | of keys that | -| | | | identifies this | -| | | | particular | -| | | | instance of | -| | | | jsonObject | -| | | | (e.g., that | -| | | | places it in a | -| | | | hierarchy) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: key -^^^^^^^^^^^^^ - -The key datatype is a tuple which provides the name of a key along with -its value and relative order; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| keyName | string | Yes | Name of the key | -+-----------------+-----------------+-----------------+-----------------+ -| keyOrder | Integer | No | Relative | -| | | | sequence or | -| | | | order of the | -| | | | key (with | -| | | | respect to | -| | | | other keys) | -+-----------------+-----------------+-----------------+-----------------+ -| keyValue | string | No | Value of the | -| | | | key | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: namedHashMap -^^^^^^^^^^^^^^^^^^^^^^ - -The namedHashMap datatype is a hashMap which is associated with and -described by a name; it consists of the following fields: - -+---------+---------+-----------+------------------------------------------------+ -| Field | Type | Required? | Description | -+=========+=========+===========+================================================+ -| name | string | Yes | Name associated with or describing the hashmap | -+---------+---------+-----------+------------------------------------------------+ -| hashMap | hashMap | Yes | One or more key:value pairs | -+---------+---------+-----------+------------------------------------------------+ - -Datatype: requestError -^^^^^^^^^^^^^^^^^^^^^^ - -The requestError datatype defines the standard request error data -structure: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| messageId | string | Yes | Unique message | -| | | | identifier of | -| | | | the format | -| | | | ‘ABCnnnn’ where | -| | | | ‘ABC’ is either | -| | | | ‘SVC’ for | -| | | | Service | -| | | | Exceptions or | -| | | | ‘POL’ for | -| | | | Policy | -| | | | Exception. | -| | | | Exception | -| | | | numbers may be | -| | | | in the range of | -| | | | 0001 to 9999 | -| | | | where 0001 to | -| | | | 2999 are | -| | | | defined by OMA | -| | | | (see section | -| | | | 5.1) and | -| | | | 3000-9999 are | -| | | | available and | -| | | | undefined. | -+-----------------+-----------------+-----------------+-----------------+ -| text | string | Yes | Message text, | -| | | | with | -| | | | replacement | -| | | | variables | -| | | | marked with %n, | -| | | | where n is an | -| | | | index into the | -| | | | list of | -| | | | <variables> | -| | | | elements, | -| | | | starting at 1 | -+-----------------+-----------------+-----------------+-----------------+ -| url | string | No | Hyperlink to a | -| | | | detailed error | -| | | | resource e.g., | -| | | | an HTML page | -| | | | for browser | -| | | | user agents | -+-----------------+-----------------+-----------------+-----------------+ -| variables | string | No | List of zero or | -| | | | more strings | -| | | | that represent | -| | | | the contents of | -| | | | the variables | -| | | | used by the | -| | | | message text | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: vendorNfNameFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The vendorNfNameFields provides vendor, nf and nfModule identifying -information: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| vendorName | string | Yes | Network | -| | | | function vendor | -| | | | name | -+-----------------+-----------------+-----------------+-----------------+ -| nfModuleName | string | No | Name of the | -| | | | nfModule | -| | | | generating the | -| | | | event | -+-----------------+-----------------+-----------------+-----------------+ -| nfName | string | No | Name of the | -| | | | network | -| | | | function | -| | | | generating the | -| | | | event | -+-----------------+-----------------+-----------------+-----------------+ - -‘Common Event Header’ Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: commonEventHeader -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The commonEventHeader datatype consists of the following fields common -to all events: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| domain | string | Yes | Event domain | -| | | | enumeration: | -| | | | ‘fault’, | -| | | | ‘heartbeat’, | -| | | | ‘measurement’, | -| | | | ‘mobileFlow’, | -| | | | ‘notification’, | -| | | | ‘other’, | -| | | | ‘pnfRegistratio | -| | | | n’, | -| | | | ‘sipSignaling’, | -| | | | ‘stateChange’, | -| | | | ‘syslog’, | -| | | | ‘thresholdCross | -| | | | ingAlert’, | -| | | | ‘voiceQuality’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventId | string | Yes | Event key that | -| | | | is unique to | -| | | | the event | -| | | | source. | -| | | | The key must be | -| | | | unique within | -| | | | notification | -| | | | life cycle | -| | | | similar to | -| | | | EventID from | -| | | | 3GPP. It could | -| | | | be a sequential | -| | | | number, or a | -| | | | composite key | -| | | | formed from the | -| | | | event fields, | -| | | | such as | -| | | | domain_sequence | -| | | | . | -| | | | The eventId | -| | | | should not | -| | | | include | -| | | | whitespace. For | -| | | | fault events, | -| | | | eventId is the | -| | | | eventId of the | -| | | | initial alarm; | -| | | | if the same | -| | | | alarm is raised | -| | | | again for | -| | | | changed, | -| | | | acknowledged or | -| | | | cleared cases, | -| | | | eventId must be | -| | | | the same as the | -| | | | initial alarm | -| | | | (along with the | -| | | | same | -| | | | startEpochMicro | -| | | | sec | -| | | | but with a | -| | | | different | -| | | | sequence | -| | | | number). Note: | -| | | | see section 1.3 | -| | | | for eventId use | -| | | | case examples. | -+-----------------+-----------------+-----------------+-----------------+ -| eventName | string | Yes | Unique event | -| | | | name (see | -| | | | section 1.2 for | -| | | | more | -| | | | information) | -+-----------------+-----------------+-----------------+-----------------+ -| eventType | string | No | For example: | -| | | | ‘applicationNf’ | -| | | | , | -| | | | ‘guestOS’, | -| | | | ‘hostOS’, | -| | | | ‘platform’ | -+-----------------+-----------------+-----------------+-----------------+ -| internalHeader | internalHeader | No | Fields (not | -| Fields | Fields | | supplied by | -| | | | event sources) | -| | | | that the VES | -| | | | Event Listener | -| | | | service can use | -| | | | to enrich the | -| | | | event if needed | -| | | | for efficient | -| | | | internal | -| | | | processing. | -| | | | This is an | -| | | | empty object | -| | | | which is | -| | | | intended to be | -| | | | defined | -| | | | separately by | -| | | | each service | -| | | | provider (e.g., | -| | | | AT&T) | -| | | | implementing | -| | | | the VES Event | -| | | | Listener. | -+-----------------+-----------------+-----------------+-----------------+ -| lastEpochMicros | number | Yes | the latest unix | -| ec | | | time aka epoch | -| | | | time associated | -| | | | with the event | -| | | | from any | -| | | | component--as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| nfcNamingCode | string | No | Network | -| | | | function | -| | | | component type: | -| | | | 3 characters | -| | | | (aligned with | -| | | | vfc naming | -| | | | standards) | -+-----------------+-----------------+-----------------+-----------------+ -| nfNamingCode | string | No | Network | -| | | | function type: | -| | | | 4 characters | -| | | | (aligned with | -| | | | vnf and pnf | -| | | | naming | -| | | | standards) | -+-----------------+-----------------+-----------------+-----------------+ -| nfVendorName | string | No | Network | -| | | | function vendor | -| | | | name | -+-----------------+-----------------+-----------------+-----------------+ -| priority | string | Yes | Processing | -| | | | priority | -| | | | enumeration: | -| | | | ‘High’, | -| | | | ‘Medium’, | -| | | | ‘Normal’, ‘Low’ | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEntity | string | No | UUID | -| Id | | | identifying the | -| | | | entity | -| | | | reporting the | -| | | | event or | -| | | | detecting a | -| | | | problem in | -| | | | another vnf/vm | -| | | | or pnf which is | -| | | | experiencing | -| | | | the problem. | -| | | | (Note: the AT&T | -| | | | internal | -| | | | enrichment | -| | | | process shall | -| | | | ensure that | -| | | | this field is | -| | | | populated). The | -| | | | reportingEntity | -| | | | Id | -| | | | is an id for | -| | | | the | -| | | | reportingEntity | -| | | | Name. | -| | | | See | -| | | | ‘reportingEntit | -| | | | yName’ | -| | | | for more | -| | | | information. | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEntity | string | Yes | Name of the | -| Name | | | entity | -| | | | reporting the | -| | | | event or | -| | | | detecting a | -| | | | problem in | -| | | | another vnf/vm | -| | | | or pnf which is | -| | | | experiencing | -| | | | the problem. | -| | | | May be the same | -| | | | as the | -| | | | sourceName. For | -| | | | synthetic | -| | | | events | -| | | | generated by | -| | | | DCAE, it is the | -| | | | name of the app | -| | | | generating the | -| | | | event. | -+-----------------+-----------------+-----------------+-----------------+ -| sequence | integer | Yes | Ordering of | -| | | | events | -| | | | communicated by | -| | | | an event source | -| | | | instance (or 0 | -| | | | if not needed) | -+-----------------+-----------------+-----------------+-----------------+ -| sourceId | string | No | UUID | -| | | | identifying the | -| | | | entity | -| | | | experiencing | -| | | | the event | -| | | | issue, which | -| | | | may be detected | -| | | | and reported by | -| | | | a separate | -| | | | reporting | -| | | | entity (note: | -| | | | the AT&T | -| | | | internal | -| | | | enrichment | -| | | | process shall | -| | | | ensure that | -| | | | this field is | -| | | | populated). The | -| | | | sourceId is an | -| | | | id for the | -| | | | sourceName. See | -| | | | ‘sourceName’ | -| | | | for more | -| | | | information. | -+-----------------+-----------------+-----------------+-----------------+ -| sourceName | string | Yes | Name of the | -| | | | entity | -| | | | experiencing | -| | | | the event | -| | | | issue, which | -| | | | may be detected | -| | | | and reported by | -| | | | a separate | -| | | | reporting | -| | | | entity. The | -| | | | sourceName | -| | | | identifies the | -| | | | device for | -| | | | which data is | -| | | | collected. A | -| | | | valid | -| | | | sourceName must | -| | | | be inventoried | -| | | | in A&AI. If | -| | | | sourceName is a | -| | | | xNFC or VM, | -| | | | then the event | -| | | | must be | -| | | | reporting data | -| | | | for that | -| | | | particular xNFC | -| | | | or VM. If the | -| | | | sourceName is a | -| | | | xNF, comprised | -| | | | of multiple | -| | | | xNFCs, the data | -| | | | must be | -| | | | reported/aggreg | -| | | | ated | -| | | | at the xNF | -| | | | leveI. Data | -| | | | for individual | -| | | | xNFC must not | -| | | | be included in | -| | | | the xNF | -| | | | sourceName | -| | | | event. | -+-----------------+-----------------+-----------------+-----------------+ -| startEpochMicro | number | Yes | the earliest | -| sec | | | unix time aka | -| | | | epoch time | -| | | | associated with | -| | | | the event from | -| | | | any | -| | | | component--as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds. For | -| | | | measurements | -| | | | and heartbeats, | -| | | | where events | -| | | | are collected | -| | | | over predefined | -| | | | intervals, | -| | | | startEpochMicro | -| | | | sec | -| | | | shall be | -| | | | rounded to the | -| | | | nearest | -| | | | interval | -| | | | boundary (e.g., | -| | | | the epoch | -| | | | equivalent of | -| | | | 3:00PM, 3:10PM, | -| | | | 3:20PM, etc…). | -| | | | For fault | -| | | | events, | -| | | | startEpochMicro | -| | | | sec | -| | | | is the | -| | | | timestamp of | -| | | | the initial | -| | | | alarm; if the | -| | | | same alarm is | -| | | | raised again | -| | | | for changed, | -| | | | acknowledged or | -| | | | cleared cases, | -| | | | startEpoch | -| | | | Microsec must | -| | | | be the same as | -| | | | the initial | -| | | | alarm (along | -| | | | with the same | -| | | | eventId and an | -| | | | incremental | -| | | | sequence | -| | | | number). For | -| | | | devices with no | -| | | | timing source | -| | | | (clock), the | -| | | | default value | -| | | | will be 0 and | -| | | | the VES | -| | | | collector will | -| | | | replace it with | -| | | | Collector time | -| | | | stamp (when the | -| | | | event is | -| | | | received) | -+-----------------+-----------------+-----------------+-----------------+ -| timeZoneOffset | string | No | Offset to GMT | -| | | | to indicate | -| | | | local time zone | -| | | | for device | -| | | | formatted as | -| | | | ‘UTC+/-hh.mm’; | -| | | | see | -| | | | https://en.wiki | -| | | | pedia.org/wiki/ | -| | | | List_of_time_zo | -| | | | ne_abbreviation | -| | | | s | -| | | | for UTC offset | -| | | | examples | -+-----------------+-----------------+-----------------+-----------------+ -| version | string | Yes | Version of the | -| | | | event header as | -| | | | “#.#” where # | -| | | | is a digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| vesEventListene | string | Yes | Version of the | -| rVersion | | | ves event | -| | | | listener api | -| | | | spec that this | -| | | | event is | -| | | | compliant with | -| | | | (as “#” or | -| | | | “#.#” or | -| | | | “#.#.#” where # | -| | | | is a digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use). | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: internalHeaderFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The internalHeaderFields datatype is an undefined object which can -contain arbitrarily complex JSON structures. It is intended to be -defined separately by each service provider (e.g., AT&T) implementing -the VES Event Listener. The fields in internalHeaderFields are not -provided by any event source but instead are added by the VES Event -Listener service itself as part of an event enrichment process necessary -for efficient internal processing of events received by the VES Event -Listener. - -Technology Independent Datatypes --------------------------------- - -‘Fault’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: faultFields -^^^^^^^^^^^^^^^^^^^^^ - -The faultFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| alarmAdditional | hashMap | No | Additional | -| Information | | | alarm | -| | | | information. | -| | | | | -| | | | - Note1: for | -| | | | SNMP mapping | -| | | | to VES, for | -| | | | hash key use | -| | | | OID of | -| | | | varbind, for | -| | | | value use | -| | | | incoming | -| | | | data for | -| | | | that | -| | | | varbind). | -| | | | | -| | | | - Note2: Alarm | -| | | | ID for 3GPP | -| | | | should be | -| | | | included (if | -| | | | applicable) | -| | | | in | -| | | | alarmAdditon | -| | | | alInformation | -| | | | as | -| | | | ‘alarmId’:’a | -| | | | larmIdValue’. | -| | | | | -| | | | Could contain | -| | | | managed object | -| | | | instance as | -| | | | separate | -| | | | key:value; | -| | | | could add | -| | | | probable cause | -| | | | as separate | -| | | | key:value. | -+-----------------+-----------------+-----------------+-----------------+ -| alarmCondition | string | Yes | Short name of | -| | | | the alarm | -| | | | condition/probl | -| | | | em, | -| | | | such as a trap | -| | | | name. Should | -| | | | not have white | -| | | | space (e.g., | -| | | | tpLgCgiNotInCon | -| | | | fig, | -| | | | BfdSessionDown, | -| | | | linkDown, etc…) | -+-----------------+-----------------+-----------------+-----------------+ -| alarmInterfaceA | string | No | Card, port, | -| | | | channel or | -| | | | interface name | -| | | | of the device | -| | | | generating the | -| | | | alarm. This | -| | | | could reflect | -| | | | managed object. | -+-----------------+-----------------+-----------------+-----------------+ -| eventCategory | string | No | Event category, | -| | | | for example: | -| | | | ‘license’, | -| | | | ‘link’, | -| | | | ‘routing’, | -| | | | ‘security’, | -| | | | ‘signaling’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventSeverity | string | Yes | Event severity | -| | | | enumeration: | -| | | | ‘CRITICAL’, | -| | | | ‘MAJOR’, | -| | | | ‘MINOR’, | -| | | | ‘WARNING’, | -| | | | ‘NORMAL’. | -| | | | NORMAL is used | -| | | | to represent | -| | | | clear. | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceType | string | Yes | Examples: | -| | | | ‘card’, ‘host’, | -| | | | ‘other’, | -| | | | ‘port’, | -| | | | ‘portThreshold’ | -| | | | , | -| | | | ‘router’, | -| | | | ‘slotThreshold’ | -| | | | , | -| | | | ‘switch’, | -| | | | ‘virtualMachine | -| | | | ’, | -| | | | ‘virtualNetwork | -| | | | Function’. | -| | | | This could be | -| | | | managed object | -| | | | class. | -+-----------------+-----------------+-----------------+-----------------+ -| faultFieldsVers | string | Yes | Version of the | -| ion | | | faultFields | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| specificProblem | string | Yes | Description of | -| | | | the alarm or | -| | | | problem (e.g., | -| | | | ‘eNodeB 155197 | -| | | | in PLMN 310-410 | -| | | | with eNodeB | -| | | | name KYL05197 | -| | | | is lost’). 3GPP | -| | | | probable cause | -| | | | would be | -| | | | included in | -| | | | this field. | -+-----------------+-----------------+-----------------+-----------------+ -| vfStatus | string | Yes | Virtual | -| | | | function status | -| | | | enumeration: | -| | | | ‘Active’, | -| | | | ‘Idle’, | -| | | | ‘Preparing to | -| | | | terminate’, | -| | | | ‘Ready to | -| | | | terminate’, | -| | | | ‘Requesting | -| | | | Termination’ | -+-----------------+-----------------+-----------------+-----------------+ - -‘Heartbeat’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: heartbeatFields -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The heartbeatFields datatype is an optional field block for fields -specific to heartbeat events; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | expansion | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatFields | string | Yes | Version of the | -| Version | | | heartbeatFields | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatInterv | Integer | Yes | Current | -| al | | | heartbeatInterv | -| | | | al | -| | | | in seconds | -+-----------------+-----------------+-----------------+-----------------+ - - ‘Measurements’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Note: NFs are required to report exactly one Measurement event per -period per sourceName. - -Datatype: codecsInUse -^^^^^^^^^^^^^^^^^^^^^ - -The codecsInUse datatype consists of the following fields describing the -number of times an identified codec was used over the -measurementInterval: - -+----------------+---------+-----------+------------------------------+ -| Field | Type | Required? | Description | -+================+=========+===========+==============================+ -| codecIdentifer | string | Yes | Description of the codec | -+----------------+---------+-----------+------------------------------+ -| numberInUse | integer | Yes | Number of such codecs in use | -+----------------+---------+-----------+------------------------------+ - -Datatype: cpuUsage -^^^^^^^^^^^^^^^^^^ - -The cpuUsage datatype defines the usage of an identifier CPU and -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| cpuCapacityCont | number | No | The amount of | -| ention | | | time the CPU | -| | | | cannot run due | -| | | | to contention, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandAvg | number | No | The total CPU | -| | | | time that the | -| | | | NF/NFC/VM could | -| | | | use if there | -| | | | was no | -| | | | contention, in | -| | | | milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandMhz | number | No | CPU demand in | -| | | | MHz | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandPct | number | No | CPU demand as a | -| | | | percentage of | -| | | | the provisioned | -| | | | capacity | -+-----------------+-----------------+-----------------+-----------------+ -| cpuIdentifier | string | Yes | CPU Identifier | -+-----------------+-----------------+-----------------+-----------------+ -| cpuIdle | number | No | Percentage of | -| | | | CPU time spent | -| | | | in the idle | -| | | | task | -+-----------------+-----------------+-----------------+-----------------+ -| cpuLatencyAvg | number | No | Percentage of | -| | | | time the VM is | -| | | | unable to run | -| | | | because it is | -| | | | contending for | -| | | | access to the | -| | | | physical CPUs | -+-----------------+-----------------+-----------------+-----------------+ -| cpuOverheadAvg | number | No | The overhead | -| | | | demand above | -| | | | available | -| | | | allocations and | -| | | | reservations, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuSwapWaitTime | number | No | Swap wait time, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageInterru | number | No | Percentage of | -| pt | | | time spent | -| | | | servicing | -| | | | interrupts | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageNice | number | No | Percentage of | -| | | | time spent | -| | | | running user | -| | | | space processes | -| | | | that have been | -| | | | niced | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSoftIrq | number | No | Percentage of | -| | | | time spent | -| | | | handling soft | -| | | | irq interrupts | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSteal | number | No | Percentage of | -| | | | time spent in | -| | | | involuntary | -| | | | wait which is | -| | | | neither user, | -| | | | system or idle | -| | | | time and is | -| | | | effectively | -| | | | time that went | -| | | | missing | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSystem | number | No | Percentage of | -| | | | time spent on | -| | | | system tasks | -| | | | running the | -| | | | kernel | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageUser | number | No | Percentage of | -| | | | time spent | -| | | | running | -| | | | un-niced user | -| | | | space processes | -+-----------------+-----------------+-----------------+-----------------+ -| cpuWait | number | No | Percentage of | -| | | | CPU time spent | -| | | | waiting for I/O | -| | | | operations to | -| | | | complete | -+-----------------+-----------------+-----------------+-----------------+ -| percentUsage | number | Yes | Aggregate cpu | -| | | | usage of the | -| | | | virtual machine | -| | | | on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: diskUsage -^^^^^^^^^^^^^^^^^^^ - -The diskUsage datatype defines the usage of a disk and consists of the -following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| diskBusResets | number | No | Number of bus | -| | | | resets over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskCommandsAbo | number | No | Number of disk | -| rted | | | commands | -| | | | aborted over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskCommandsAvg | number | No | Average number | -| | | | of commands per | -| | | | second over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskFlushReques | number | No | Total flush | -| ts | | | requests of the | -| | | | disk cache over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskFlushTime | number | No | Milliseconds | -| | | | spent on disk | -| | | | cache flushing | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIdentifier | string | Yes | Disk Identifier | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeAvg | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the average | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeLast | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeMax | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the maximum | -| | | | value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeMin | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the minimum | -| | | | value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadA | number | No | Number of | -| vg | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadL | number | No | Number of | -| ast | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadM | number | No | Number of | -| ax | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | maximum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadM | number | No | Number of | -| in | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | minimum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Avg | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Last | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Max | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | maximum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Min | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | minimum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Avg | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| | | | octets per | -| Last | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Max | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Min | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Avg | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Last | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Max | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Min | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadAvg | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadLast | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadMax | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadMin | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteAvg | number | No | Number of write | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteLas | number | No | Number of write | -| t | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWrite | number | No | Number of write | -| Max | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteMin | number | No | Number of write | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsAvg | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsLast | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsMax | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsMin | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskReadCommand | number | No | Average number | -| sAvg | | | of read | -| | | | commands issued | -| | | | per second to | -| | | | the disk over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTime | number | No | Nanoseconds | -| | | | spent on disk | -| | | | cache | -| | | | reads/writes | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeReadAvg | number | No | Milliseconds a | -| | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Last | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Max | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Min | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Avg | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Last | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Max | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Min | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTotalReadLa | number | No | Average read | -| tencyAvg | | | time from the | -| | | | perspective of | -| | | | a Guest OS: sum | -| | | | of the Kernel | -| | | | Read Latency | -| | | | and Physical | -| | | | Device Read | -| | | | Latency in | -| | | | milliseconds | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTotalWriteL | number | No | Average write | -| atencyAvg | | | time from the | -| | | | perspective of | -| | | | a Guest OS: sum | -| | | | of the Kernel | -| | | | Write Latency | -| | | | and Physical | -| | | | Device Write | -| | | | Latency in | -| | | | milliseconds | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskWeightedIoT | number | No | Measure in ms | -| imeAvg | | | over 1 sec of | -| | | | both I/O | -| | | | completion time | -| | | | and the backlog | -| | | | that may be | -| | | | accumulating. | -| | | | Value is the | -| | | | average within | -| | | | the collection | -| | | | interval. | -+-----------------+-----------------+-----------------+-----------------+ -| diskWeightedIoT | number | No | Measure in ms | -| imeLast | | | over 1 sec of | -| | | | both I/O | -| | | | completion time | -| | | | and the backlog | -| | | | that may be | -| | | | accumulating. | -| | | | Value is the | -| | | | last within the | -| | | | collection | -| | | | interval. | -+-----------------+-----------------+-----------------+-----------------+ -| diskWeightedIoT | number | No | Measure in ms | -| imeMax | | | over 1 sec of | -| | | | both I/O | -| | | | completion time | -| | | | and the backlog | -| | | | that may be | -| | | | accumulating. | -| | | | Value is the | -| | | | maximum within | -| | | | the collection | -| | | | interval. | -+-----------------+-----------------+-----------------+-----------------+ -| diskWeightedIoT | number | No | Measure in ms | -| imeMin | | | over 1 sec of | -| | | | both I/O | -| | | | completion time | -| | | | and the backlog | -| | | | that may be | -| | | | accumulating. | -| | | | Value is the | -| | | | minimum within | -| | | | the collection | -| | | | interval. | -+-----------------+-----------------+-----------------+-----------------+ -| diskWriteComman | number | No | Average number | -| dsAvg | | | of write | -| | | | commands issued | -| | | | per second to | -| | | | the disk over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: filesystemUsage -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The filesystemUsage datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| filesystemName | string | Yes | File system | -| | | | name | -+-----------------+-----------------+-----------------+-----------------+ -| blockConfigured | number | Yes | Configured | -| | | | block storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| blockIops | number | Yes | Block storage | -| | | | input-output | -| | | | operations per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| blockUsed | number | Yes | Used block | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralConfig | number | Yes | Configured | -| ured | | | ephemeral | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralIops | number | Yes | Ephemeral | -| | | | storage | -| | | | input-output | -| | | | operations per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralUsed | number | Yes | Used ephemeral | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: hugePages -^^^^^^^^^^^^^^^^^^^ - -The hugePages datatype provides metrics on system hugePages; it consists -of the following fields: - -+---------------------+--------+-----------+-------------------------------------+ -| Field | Type | Required? | Description | -+=====================+========+===========+=====================================+ -| bytesFree | number | No | Number of free hugePages in bytes | -+---------------------+--------+-----------+-------------------------------------+ -| bytesUsed | number | No | Number of used hugePages in bytes | -+---------------------+--------+-----------+-------------------------------------+ -| hugePagesIdentifier | string | Yes | HugePages identifier | -+---------------------+--------+-----------+-------------------------------------+ -| percentFree | number | No | Number of free hugePages in percent | -+---------------------+--------+-----------+-------------------------------------+ -| percentUsed | number | No | Number of used hugePages in percent | -+---------------------+--------+-----------+-------------------------------------+ -| vmPageNumberFree | number | No | Number of free vmPages in numbers | -+---------------------+--------+-----------+-------------------------------------+ -| vmPageNumberUsed | number | No | Number of used vmPages in numbers | -+---------------------+--------+-----------+-------------------------------------+ - -Datatype: ipmi (Intelligent Platform Management Interface) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmi datatype provides intelligent platform management interface -metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| exitAirTemperat | number | No | System fan exit | -| ure | | | air flow | -| | | | temperature in | -| | | | Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| frontPanelTempe | number | No | Front panel | -| rature | | | temp in Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| ioModuleTempera | number | No | Io module temp | -| ture | | | in Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBaseboardTe | ipmiBaseboard | No | Array of | -| mperatureArray | Temperature [ ] | | ipmiBaseboard | -| | | | Temperature | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBaseboardVo | ipmiBaseboard | No | Array of | -| ltageRegulator | VoltageRegulato | | ipmiBaseboard | -| Array | r | | VoltageRegulato | -| | [ ] | | r | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBatteryArra | ipmiBattery [ ] | No | Array of | -| y | | | ipmiBattery | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiFanArray | ipmiFan [ ] | No | Array of | -| | | | ipmiFan objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiGlobalAggre | ipmiGlobalAggre | No | ipmi global | -| gateTemperature | gate | | aggregate | -| | | | temperature | -| MarginArray | TemperatureMarg | | margin | -| | in | | | -| | [ ] | | | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiHsbpArray | ipmiHsbp [ ] | No | Array of | -| | | | ipmiHsbp | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiNicArray | ipmiNic [ ] | No | Array of | -| | | | ipmiNic objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiPowerSupply | ipmiPowerSupply | No | Array of | -| Array | [ ] | | ipmiPowerSupply | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiProcessorAr | ipmiProcessor [ | No | Array of | -| ray | ] | | ipmiProcessor | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| systemAirflow | number | No | Airflow in | -| | | | cubic feet per | -| | | | minute (cfm) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBaseboardTemperature -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBaseboardTemperature datatype consists of the following fields -which describe ipmi baseboard temperature metrics: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| baseboardTemper | number | No | Baseboard | -| ature | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ -| baseboardTemper | string | Yes | Identifier for | -| ature | | | the location | -| Identifier | | | where the | -| | | | temperature is | -| | | | taken | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBaseboardVoltageRegulator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBaseboardVoltageRegulator datatype consists of the following -fields which describe ipmi baseboard voltage regulator metrics: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| baseboardVoltag | string | Yes | Identifier for | -| e | | | the baseboard | -| RegulatorIdenti | | | voltage | -| fier | | | regulator | -+-----------------+-----------------+-----------------+-----------------+ -| voltageRegulato | number | No | Voltage | -| r | | | regulator | -| Temperature | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBattery -^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBattery datatype consists of the following fields which describe -ipmi battery metrics: - -+---------------------+--------+-----------+----------------------------+ -| Field | Type | Required? | Description | -+=====================+========+===========+============================+ -| batteryIdentifier | string | Yes | Identifier for the battery | -+---------------------+--------+-----------+----------------------------+ -| batteryType | string | No | Type of battery | -+---------------------+--------+-----------+----------------------------+ -| batteryVoltageLevel | number | No | Battery voltage level | -+---------------------+--------+-----------+----------------------------+ - -Datatype: ipmiFan -^^^^^^^^^^^^^^^^^ - -The ipmiFan datatype consists of the following fields which describe -ipmi fan metrics: - -+---------------+--------+-----------+-------------------------------------------+ -| Field | Type | Required? | Description | -+===============+========+===========+===========================================+ -| fanIdentifier | string | Yes | Identifier for the fan | -+---------------+--------+-----------+-------------------------------------------+ -| fanSpeed | number | No | Fan speed in revolutions per minute (rpm) | -+---------------+--------+-----------+-------------------------------------------+ - -Datatype: ipmiGlobalAggregateTemperatureMargin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiGlobalAggregateTemperatureMargin datatype consists of the -following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| globalAggregate | number | No | Temperature | -| TemperatureMarg | | | margin in | -| in | | | Celsius | -| | | | relative to a | -| | | | throttling | -| | | | thermal trip | -| | | | point | -+-----------------+-----------------+-----------------+-----------------+ -| globalAggregate | string | Yes | Identifier for | -| TemperatureMarg | | | the ipmi global | -| inIdentifier | | | aggregate | -| | | | temperature | -| | | | margin metrics | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiHsbp -^^^^^^^^^^^^^^^^^^ - -The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| hsbpIdentifier | string | Yes | Identifier for | -| | | | the hot swap | -| | | | backplane power | -| | | | unit | -+-----------------+-----------------+-----------------+-----------------+ -| hsbpTemperature | number | No | Hot swap | -| | | | backplane power | -| | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiNic -^^^^^^^^^^^^^^^^^ - -The ipmiNic datatype provides network interface control care metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| nicIdentifier | string | Yes | Identifier for | -| | | | the network | -| | | | interface | -| | | | control card | -+-----------------+-----------------+-----------------+-----------------+ -| nicTemperature | number | No | nic temperature | -| | | | in Celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiPowerSupply -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiPowerSupply datatype provides ipmi power supply metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| powerSupplyCurr | number | No | Current output | -| entOutput | | | voltage as a | -| Percent | | | percentage of | -| | | | the design | -| | | | specified level | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyIden | string | Yes | Identifier for | -| tifier | | | the power | -| | | | supply | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyInpu | number | No | Input power in | -| tPower | | | watts | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyTemp | number | No | Power supply | -| erature | | | temperature in | -| | | | Celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiProcessor -^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiProcessor datatype provides ipmi processor metrics; it consists -of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| processorDimmAg | processorDimm | No | Array of | -| gregate | AggregateTherma | | processorDimmAg | -| ThermalMarginAr | l | | gregate | -| ray | Margin [ ] | | ThermalMargin | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| processorDtsThe | number | No | Front panel | -| rmalMargin | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ -| processorIdenti | string | Yes | Identifier for | -| fier | | | the power | -| | | | supply | -+-----------------+-----------------+-----------------+-----------------+ -| pprocessorTherm | number | No | Io module | -| alControl | | | temperatue in | -| Percent | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: latencyBucketMeasure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The latencyBucketMeasure datatype consists of the following fields which -describe the number of counts falling within a defined latency bucket: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| countsInTheBuck | number | Yes | Number of | -| et | | | counts falling | -| | | | within a | -| | | | defined latency | -| | | | bucket | -+-----------------+-----------------+-----------------+-----------------+ -| highEndOfLatenc | number | No | High end of | -| yBucket | | | bucket range | -| | | | (typically in | -| | | | ms) | -+-----------------+-----------------+-----------------+-----------------+ -| lowEndOfLatency | number | No | Low end of | -| Bucket | | | bucket range | -| | | | (typically in | -| | | | ms) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: load -^^^^^^^^^^^^^^ - -The load datatype provides metrics on system cpu and io utilization -obtained using /proc/loadavg; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| longTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over | -| | | | 15 minutes | -| | | | using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ -| midTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over 5 | -| | | | minutes using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ -| shortTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over 1 | -| | | | minute using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: machineCheckException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The machineCheckException datatype describes machine check exceptions; -it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| correctedMemory | number | No | Total hardware | -| Errors | | | errors that | -| | | | were corrected | -| | | | by the hardware | -| | | | (e.g. data | -| | | | corruption | -| | | | corrected via | -| | | | ECC) over the | -| | | | measurementInte | -| | | | rval. | -| | | | These errors do | -| | | | not require | -| | | | immediate | -| | | | software | -| | | | actions, but | -| | | | are still | -| | | | reported for | -| | | | accounting | -| | | | and predictive | -| | | | failure | -| | | | analysis | -+-----------------+-----------------+-----------------+-----------------+ -| correctedMemory | number | No | Total hardware | -| Errors | | | errors that | -| In1Hr | | | were corrected | -| | | | by the hardware | -| | | | over the last | -| | | | one hour | -+-----------------+-----------------+-----------------+-----------------+ -| processIdentifi | string | Yes | processIdentifi | -| er | | | er | -+-----------------+-----------------+-----------------+-----------------+ -| uncorrectedMemo | number | No | Total | -| ryErrors | | | uncorrected | -| | | | hardware errors | -| | | | that were | -| | | | detected by the | -| | | | hardware (e.g., | -| | | | causing data | -| | | | corruption) | -| | | | over the | -| | | | measurementInte | -| | | | rval. | -| | | | These errors | -| | | | require a | -| | | | software | -| | | | response. | -+-----------------+-----------------+-----------------+-----------------+ -| uncorrectedMemo | number | No | Total | -| ryErrors | | | uncorrected | -| In1Hr | | | hardware errors | -| | | | that were | -| | | | detected by the | -| | | | hardware over | -| | | | the last one | -| | | | hour | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: measurementFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The measurementFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | measurement | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalMeasu | arrayOfNamedHas | No | Array of named | -| rements | hMap | | hashMap if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalObjec | arrayOfJsonObje | No | Array of JSON | -| ts | ct | | objects | -| | | | described by | -| | | | name, schema | -| | | | and other | -| | | | meta-informatio | -| | | | n, | -| | | | if needed | -+-----------------+-----------------+-----------------+-----------------+ -| codecUsageArray | codecsInUse [] | No | Array of codecs | -| | | | in use | -+-----------------+-----------------+-----------------+-----------------+ -| concurrentSessi | integer | No | Peak concurrent | -| ons | | | sessions for | -| | | | the VM or xNF | -| | | | (depending on | -| | | | the context) | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| configuredEntit | integer | No | Depending on | -| ies | | | the context | -| | | | over the | -| | | | measurementInte | -| | | | rval: | -| | | | peak total | -| | | | number of | -| | | | users, | -| | | | subscribers, | -| | | | devices, | -| | | | adjacencies, | -| | | | etc., for the | -| | | | VM, or peak | -| | | | total number of | -| | | | subscribers, | -| | | | devices, etc., | -| | | | for the xNF | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageArray | cpuUsage [] | No | Usage of an | -| | | | array of CPUs | -+-----------------+-----------------+-----------------+-----------------+ -| diskUsageArray | diskUsage [] | No | Usage of an | -| | | | array of disks | -+-----------------+-----------------+-----------------+-----------------+ -| featureUsageArr | hashMap | No | The hashMap key | -| ay | | | should identify | -| | | | the feature, | -| | | | while the value | -| | | | defines the | -| | | | number of times | -| | | | the identified | -| | | | feature was | -| | | | used | -+-----------------+-----------------+-----------------+-----------------+ -| filesystemUsage | filesystemUsage | No | Filesystem | -| Array | [ ] | | usage of the VM | -| | | | on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| hugePagesArray | hugePages [ ] | No | Array of | -| | | | metrics on | -| | | | hugePages | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiArray | ipmi [ ] | No | Array of | -| | | | intelligent | -| | | | platform | -| | | | management | -| | | | interface | -| | | | metrics | -+-----------------+-----------------+-----------------+-----------------+ -| latencyDistribu | latencyBucketMe | No | Array of | -| tion | asure | | integers | -| | [ ] | | representing | -| | | | counts of | -| | | | requests whose | -| | | | latency in | -| | | | milliseconds | -| | | | falls within | -| | | | per-xNF | -| | | | configured | -| | | | ranges; where | -| | | | latency is the | -| | | | duration | -| | | | between a | -| | | | service request | -| | | | and its | -| | | | fulfillment. | -+-----------------+-----------------+-----------------+-----------------+ -| loadArray | load [ ] | No | Array of system | -| | | | load metrics | -+-----------------+-----------------+-----------------+-----------------+ -| machineCheckExc | machineCheckExc | No | Array of | -| eptionArray | eption | | machine check | -| | [ ] | | exceptions | -+-----------------+-----------------+-----------------+-----------------+ -| meanRequestLate | number | No | Mean seconds | -| ncy | | | required to | -| | | | respond to each | -| | | | request for the | -| | | | VM on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| measurementFiel | string | Yes | Version of the | -| dsVersion | | | measurementFiel | -| | | | ds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| measurementInte | number | Yes | Interval over | -| rval | | | which | -| | | | measurements | -| | | | are being | -| | | | reported in | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| memoryUsageArra | memoryUsage [] | No | Memory usage of | -| y | | | an array of VMs | -+-----------------+-----------------+-----------------+-----------------+ -| nfcScalingMetri | integer | No | Represents | -| c | | | busy-ness of | -| | | | the network | -| | | | function from 0 | -| | | | to 100 as | -| | | | reported by the | -| | | | nfc | -+-----------------+-----------------+-----------------+-----------------+ -| nicPerformanceA | nicPerformance | No | Performance | -| rray | [ ] | | metrics of an | -| | | | array of | -| | | | network | -| | | | interface cards | -+-----------------+-----------------+-----------------+-----------------+ -| numberOfMediaPo | integer | No | Number of media | -| rtsInUse | | | ports in use | -+-----------------+-----------------+-----------------+-----------------+ -| processStatsArr | processStats [ | No | Array of | -| ay | ] | | metrics on | -| | | | system | -| | | | processes | -+-----------------+-----------------+-----------------+-----------------+ -| requestRate | number | No | Peak rate of | -| | | | service | -| | | | requests per | -| | | | second to the | -| | | | xNF over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: memoryUsage -^^^^^^^^^^^^^^^^^^^^^ - -The memoryUsage datatype defines the memory usage of a virtual machine -and consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| memoryBuffered | number | No | Kibibytes of | -| | | | temporary | -| | | | storage for raw | -| | | | disk blocks | -+-----------------+-----------------+-----------------+-----------------+ -| memoryCached | number | No | Kibibytes of | -| | | | memory used for | -| | | | cache | -+-----------------+-----------------+-----------------+-----------------+ -| memoryConfigure | number | No | Kibibytes of | -| d | | | memory | -| | | | configured in | -| | | | the virtual | -| | | | machine on | -| | | | which the xNFC | -| | | | reporting the | -| | | | event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| memoryDemand | number | No | Host demand in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memoryFree | number | Yes | Kibibytes of | -| | | | physical RAM | -| | | | left unused by | -| | | | the system | -+-----------------+-----------------+-----------------+-----------------+ -| memoryLatencyAv | number | No | Percentage of | -| g | | | time the VM is | -| | | | waiting to | -| | | | access swapped | -| | | | or compressed | -| | | | memory | -+-----------------+-----------------+-----------------+-----------------+ -| memorySharedAvg | number | No | Shared memory | -| | | | in kilobytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySlabRecl | number | No | The part of the | -| | | | slab that can | -| | | | be reclaimed | -| | | | such as caches | -| | | | measured in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySlabUnrec | number | No | The part of the | -| l | | | slab that | -| | | | cannot be | -| | | | reclaimed even | -| | | | when lacking | -| | | | memory measure | -| | | | in kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapInAvg | number | No | Amount of | -| | | | memory | -| | | | swapped-in from | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapInRat | number | No | Rate at which | -| eAvg | | | memory is | -| | | | swapped from | -| | | | disk into | -| | | | active memory | -| | | | during the | -| | | | interval in | -| | | | kilobytes per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapOutAv | number | No | Amount of | -| g | | | memory | -| | | | swapped-out to | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapOutRa | number | No | Rate at which | -| teAvg | | | memory is being | -| | | | swapped from | -| | | | active memory | -| | | | to disk during | -| | | | the current | -| | | | interval in | -| | | | kilobytes per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapUsedA | number | No | Space used for | -| vg | | | caching swapped | -| | | | pages in the | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memoryUsed | number | Yes | Total memory | -| | | | minus the sum | -| | | | of free, | -| | | | buffered, | -| | | | cached and slab | -| | | | memory measured | -| | | | in kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| percentMemoryUs | number | No | Percentage of | -| age | | | memory usage; | -| | | | value = | -| | | | (memoryUsed / | -| | | | (memoryUsed + | -| | | | memoryFree) x | -| | | | 100 if | -| | | | denomintor is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| vmIdentifier | string | Yes | Virtual Machine | -| | | | identifier | -| | | | associated with | -| | | | the memory | -| | | | metrics | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: nicPerformance -^^^^^^^^^^^^^^^^^^^^^^^^ - -The nicPerformance datatype consists of the following fields which -describe the performance and errors of an of an identified virtual -network interface card: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| administrativeS | string | No | Administrative | -| tate | | | state: enum: | -| | | | ‘inService’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| nicIdentifier | string | Yes | Network | -| | | | interface card | -| | | | identifier | -+-----------------+-----------------+-----------------+-----------------+ -| operationalStat | string | No | Operational | -| e | | | state: enum: | -| | | | ‘inService’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| receivedBroadca | number | No | Cumulative | -| stPacketsAccumu | | | count of | -| lated | | | broadcast | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedBroadca | number | No | Count of | -| stPacketsDelta | | | broadcast | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedDiscard | number | No | Cumulative | -| edPacketsAccumu | | | count of | -| lated | | | discarded | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedDiscard | number | No | Count of | -| edPacketsDelta | | | discarded | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedErrorPa | number | No | Cumulative | -| cketsAccumulate | | | count of error | -| d | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedErrorPa | number | No | Count of error | -| cketsDelta | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedMultica | number | No | Cumulative | -| stPacketsAccumu | | | count of | -| lated | | | multicast | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedMultica | number | No | Count of | -| stPacketsDelta | | | multicast | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedOctetsA | number | No | Cumulative | -| ccumulated | | | count of octets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedOctetsD | number | No | Count of octets | -| elta | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedPercent | number | No | Percentage of | -| Discard | | | discarded | -| | | | packets | -| | | | received; value | -| | | | = | -| | | | (receivedDiscar | -| | | | dedPacketsDelta | -| | | | / | -| | | | receivedTotalPa | -| | | | cketsDelta) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| receivedPercent | number | No | Percentage of | -| Error | | | error packets | -| | | | received; value | -| | | | = | -| | | | (receivedErrorP | -| | | | acketsDelta | -| | | | / | -| | | | receivedTotalPa | -| | | | cketsDelta) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| receivedTotalPa | number | No | Cumulative | -| cketsAccumulate | | | count of all | -| d | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedTotalPa | number | No | Count of all | -| cketsDelta | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedUnicast | number | No | Cumulative | -| PacketsAccumula | | | count of | -| ted | | | unicast packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedUnicast | number | No | Count of | -| PacketsDelta | | | unicast packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedUtiliza | number | No | Percentage of | -| tion | | | utilization | -| | | | received; value | -| | | | = | -| | | | (receivedOctets | -| | | | Delta | -| | | | / (speed x | -| | | | (lastEpochMicro | -| | | | sec | -| | | | - | -| | | | startEpochMicro | -| | | | sec))) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| speed | number | No | Speed | -| | | | configured in | -| | | | mbps. | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedBroa | number | No | Cumulative | -| dcastPacketsAcc | | | count of | -| umulated | | | broadcast | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedBroa | number | No | Count of | -| dcastPacketsDel | | | broadcast | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedDisc | number | No | Cumulative | -| ardedPacketsAcc | | | count of | -| umulated | | | discarded | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedDisc | number | No | Count of | -| ardedPacketsDel | | | discarded | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedErro | number | No | Cumulative | -| rPacketsAccumul | | | count of error | -| ated | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedErro | number | No | Count of error | -| rPacketsDelta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedMult | number | No | Cumulative | -| icastPacketsAcc | | | count of | -| umulated | | | multicast | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedMult | number | No | Count of | -| icastPacketsDel | | | multicast | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedOcte | number | No | Cumulative | -| tsAccumulated | | | count of octets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedOcte | number | No | Count of octets | -| tsDelta | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedPerc | number | No | Percentage of | -| entDiscard | | | discarded | -| | | | packets | -| | | | transmitted; | -| | | | value = | -| | | | (transmittedDis | -| | | | cardedPacketsDe | -| | | | lta | -| | | | / | -| | | | transmittedTota | -| | | | lPacketsDelta) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedPerc | number | No | Percentage of | -| entError | | | error packets | -| | | | received; value | -| | | | = | -| | | | (transmittedErr | -| | | | orPacketsDelta | -| | | | / | -| | | | transmittedTota | -| | | | lPacketsDelta) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedTota | number | No | Cumulative | -| lPacketsAccumul | | | count of all | -| ated | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedTota | number | No | Count of all | -| lPacketsDelta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedUnic | number | No | Cumulative | -| astPacketsAccum | | | count of | -| ulated | | | unicast packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedUnic | number | No | Count of | -| astPacketsDelta | | | unicast packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedUtil | number | No | Percentage of | -| ization | | | utilization | -| | | | transmitted; | -| | | | value = | -| | | | (transmittedOct | -| | | | etsDelta | -| | | | / (speed x | -| | | | (lastEpochMicro | -| | | | sec | -| | | | - | -| | | | startEpochMicro | -| | | | sec))) | -| | | | x 100, if | -| | | | denominator is | -| | | | nonzero, or 0, | -| | | | if otherwise. | -+-----------------+-----------------+-----------------+-----------------+ -| valuesAreSuspec | string | Yes | Enumeration: | -| t | | | ‘true’ or | -| | | | ‘false’. If | -| | | | ‘true’ then the | -| | | | vNicPerformance | -| | | | values are | -| | | | likely | -| | | | inaccurate due | -| | | | to counter | -| | | | overflow or | -| | | | other | -| | | | conditions. | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: processorDimmAggregateThermalMargin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The processorDimmAggregateThermalMargin datatype provides intelligent -platform management interface (ipmi) processor dual inline memory module -aggregate thermal margin metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| processorDimmAg | string | Yes | identifier for | -| gregateThermal | | | the aggregate | -| MarginIdentifie | | | thermal margin | -| r | | | metrics from | -| | | | the processor | -| | | | dual inline | -| | | | memory module | -+-----------------+-----------------+-----------------+-----------------+ -| thermalMargin | number | Yes | the difference | -| | | | between the | -| | | | DIMM's current | -| | | | temperature, in | -| | | | celsius, and | -| | | | the DIMM's | -| | | | throttling | -| | | | thermal trip | -| | | | point | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: processStats -^^^^^^^^^^^^^^^^^^^^^^ - -The processStats datatype provides metrics on system processes; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| forkRate | number | No | The number of | -| | | | threads created | -| | | | since the last | -| | | | reboot | -+-----------------+-----------------+-----------------+-----------------+ -| processIdentifi | string | Yes | processIdentifi | -| er | | | er | -+-----------------+-----------------+-----------------+-----------------+ -| psStateBlocked | number | No | The number of | -| | | | processes in a | -| | | | blocked state | -+-----------------+-----------------+-----------------+-----------------+ -| psStatePaging | number | No | The number of | -| | | | processes in a | -| | | | paging state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateRunning | number | No | The number of | -| | | | processes in a | -| | | | running state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateSleeping | number | No | The number of | -| | | | processes in a | -| | | | sleeping state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateStopped | number | No | The number of | -| | | | processes in a | -| | | | stopped state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateZombie | number | No | The number of | -| | | | processes in a | -| | | | zombie state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Notification’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: notificationFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The notificationFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | notification | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| arrayOfNamedHas | namedHashMap [ | No | Array of named | -| hMap | ] | | hashMaps | -+-----------------+-----------------+-----------------+-----------------+ -| changeContact | string | No | Identifier for | -| | | | a contact | -| | | | related to the | -| | | | change | -+-----------------+-----------------+-----------------+-----------------+ -| changeIdentifie | string | Yes | System or | -| r | | | session | -| | | | identifier | -| | | | associated with | -| | | | the change | -+-----------------+-----------------+-----------------+-----------------+ -| changeType | string | Yes | Describes what | -| | | | has changed for | -| | | | the entity, for | -| | | | example: | -| | | | configuration | -| | | | changed, | -| | | | capability | -| | | | added, | -| | | | capability | -| | | | removed… | -+-----------------+-----------------+-----------------+-----------------+ -| newState | string | No | New state of | -| | | | the entity, for | -| | | | example: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| notificationFie | string | Yes | Version of the | -| ldsVersion | | | notificationFie | -| | | | lds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| oldState | string | No | Previous state | -| | | | of the entity, | -| | | | for example: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| stateInterface | string | No | Card or port | -| | | | name of the | -| | | | entity that | -| | | | changed state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Other’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: otherFields -^^^^^^^^^^^^^^^^^^^^^ - -The otherFields datatype defines fields for events belonging to the -'other' domain of the commonEventHeader domain enumeration; it consists -of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| arrayOfNamedHas | arrayOfNamedHas | No | Array of named | -| hMap | hMap | | hashMaps | -+-----------------+-----------------+-----------------+-----------------+ -| hashMap | hashMap | No | Array of | -| | | | name-value | -| | | | pairs | -+-----------------+-----------------+-----------------+-----------------+ -| jsonObjects | arrayOfJsonObje | No | Array of JSON | -| | ct | | objects | -| | | | described by | -| | | | name, schema | -| | | | and other | -| | | | meta-informatio | -| | | | n | -+-----------------+-----------------+-----------------+-----------------+ -| otherFieldsVers | string | Yes | Version of the | -| ion | | | otherFields | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ - -‘pnfRegistration’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: pnfRegistrationFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The pnfRegistrationFields datatype defines fields for events belonging -to the 'pnfRegistration' domain of the commonEventHeader domain -enumeration; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | pnfRegistration | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| lastServiceDate | string | No | TS 32.692 | -| | | | dateOfLastServi | -| | | | ce | -| | | | = date of last | -| | | | service; e.g. | -| | | | 15022017 | -+-----------------+-----------------+-----------------+-----------------+ -| macAddress | string | No | MAC address of | -| | | | OAM interface | -| | | | of the unit | -+-----------------+-----------------+-----------------+-----------------+ -| manufactureDate | string | No | TS 32.692 | -| | | | dateOfManufactu | -| | | | re | -| | | | = manufacture | -| | | | date of the | -| | | | unit; 24032016 | -+-----------------+-----------------+-----------------+-----------------+ -| modelNumber | string | No | TS 32.692 | -| | | | versionNumber = | -| | | | version of the | -| | | | unit from | -| | | | vendor; e.g. | -| | | | AJ02. Maps to | -| | | | AAI equip-model | -+-----------------+-----------------+-----------------+-----------------+ -| oamV4IpAddress | string | No | IPv4 m-plane IP | -| | | | address to be | -| | | | used by the | -| | | | manager to | -| | | | contact the PNF | -+-----------------+-----------------+-----------------+-----------------+ -| oamV6IpAddress | string | No | IPv6 m-plane IP | -| | | | address to be | -| | | | used by the | -| | | | manager to | -| | | | contact the PNF | -+-----------------+-----------------+-----------------+-----------------+ -| pnfRegistration | string | Yes | Version of the | -| FieldsVersion | | | registrationFie | -| | | | lds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| serialNumber | string | No | TS 32.692 | -| | | | serialNumber = | -| | | | serial number | -| | | | of the unit; | -| | | | e.g. 6061ZW3 | -+-----------------+-----------------+-----------------+-----------------+ -| softwareVersion | string | No | TS 32.692 | -| | | | swName = active | -| | | | SW running on | -| | | | the unit; e.g. | -| | | | 5gDUv18.05.201 | -+-----------------+-----------------+-----------------+-----------------+ -| unitFamily | string | No | TS 32.692 | -| | | | vendorUnitFamil | -| | | | yType | -| | | | = general type | -| | | | of HW unit; | -| | | | e.g. BBU | -+-----------------+-----------------+-----------------+-----------------+ -| unitType | string | No | TS 32.692 | -| | | | vendorUnitTypeN | -| | | | umber | -| | | | = vendor name | -| | | | for the unit; | -| | | | e.g. Airscale | -+-----------------+-----------------+-----------------+-----------------+ -| vendorName | string | No | TS 32.692 | -| | | | vendorName = | -| | | | name of | -| | | | manufacturer; | -| | | | e.g. Nokia. | -| | | | Maps to AAI | -| | | | equip-vendor | -+-----------------+-----------------+-----------------+-----------------+ - - ‘State Change’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: stateChangeFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The stateChangeFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | stateChange | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| newState | string | Yes | New state of | -| | | | the entity: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| oldState | string | Yes | Previous state | -| | | | of the entity: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| stateChangeFiel | string | Yes | Version of the | -| dsVersion | | | stateChangeFiel | -| | | | ds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| stateInterface | string | Yes | Card or port | -| | | | name of the | -| | | | entity that | -| | | | changed state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Syslog’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: syslogFields -^^^^^^^^^^^^^^^^^^^^^^ - -The syslogFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | syslog fields | -| | | | if needed Ex: | -| | | | {“name1”: | -| | | | ”value1”, | -| | | | “name2: | -| | | | “value2” … } | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceHost | string | No | Hostname of the | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceType | string | Yes | Examples: | -| | | | ‘other’, | -| | | | ‘router’, | -| | | | ‘switch’, | -| | | | ‘host’, ‘card’, | -| | | | ‘port’, | -| | | | ‘slotThreshold’ | -| | | | , | -| | | | ‘portThreshold’ | -| | | | , | -| | | | ‘virtualMachine | -| | | | ’, | -| | | | ‘virtualNetwork | -| | | | Function’ | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFacility | integer | No | Numeric code | -| | | | from 0 to 23 | -| | | | for facility: | -| | | | | -| | | | 0 kernel | -| | | | messages | -| | | | | -| | | | 1 user-level | -| | | | messages | -| | | | | -| | | | 2 mail system | -| | | | | -| | | | 3 system | -| | | | daemons | -| | | | | -| | | | 4 | -| | | | security/author | -| | | | ization | -| | | | messages | -| | | | | -| | | | 5 messages | -| | | | generated | -| | | | internally by | -| | | | syslogd | -| | | | | -| | | | 6 line printer | -| | | | subsystem | -| | | | | -| | | | 7 network news | -| | | | subsystem | -| | | | | -| | | | 8 UUCP | -| | | | subsystem | -| | | | | -| | | | 9 clock daemon | -| | | | | -| | | | 10 | -| | | | security/author | -| | | | ization | -| | | | messages | -| | | | | -| | | | 11 FTP daemon | -| | | | | -| | | | 12 NTP | -| | | | subsystem | -| | | | | -| | | | 13 log audit | -| | | | | -| | | | 14 log alert | -| | | | | -| | | | 15 clock daemon | -| | | | (note 2) | -| | | | | -| | | | 16 local use 0 | -| | | | (local0) | -| | | | | -| | | | 17 local use 1 | -| | | | (local1) | -| | | | | -| | | | 18 local use 2 | -| | | | (local2) | -| | | | | -| | | | 19 local use 3 | -| | | | (local3) | -| | | | | -| | | | 20 local use 4 | -| | | | (local4) | -| | | | | -| | | | 21 local use 5 | -| | | | (local5) | -| | | | | -| | | | 22 local use 6 | -| | | | (local6) | -| | | | | -| | | | 23 local use 7 | -| | | | (local7 ) | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFieldsVer | string | Yes | Version of the | -| sion | | | syslogFields | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| syslogMsg | string | Yes | Syslog message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogMsgHost | string | No | Hostname parsed | -| | | | from non-VES | -| | | | syslog message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogPri | integer | No | 0-192 | -| | | | | -| | | | Combined | -| | | | Severity and | -| | | | Facility (see | -| | | | rfc5424) | -+-----------------+-----------------+-----------------+-----------------+ -| syslogProc | string | No | Identifies the | -| | | | application | -| | | | that originated | -| | | | the message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogProcId | number | No | The process | -| | | | number assigned | -| | | | by the OS when | -| | | | the application | -| | | | was started | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSData | string | No | A <space> | -| | | | separated list | -| | | | of key=”value” | -| | | | pairs following | -| | | | the rfc5424 | -| | | | standard for | -| | | | SD-ELEMENT. | -| | | | | -| | | | **Deprecated** | -| | | | | -| | | | The entire | -| | | | rfc5424 | -| | | | syslogSData | -| | | | object, | -| | | | including | -| | | | square brackets | -| | | | [ ], SD-ID and | -| | | | list of | -| | | | SD-PARAMs | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSdId | string | No | 0-32 char in | -| | | | format | -| | | | name@number, | -| | | | | -| | | | i.e., | -| | | | ourSDID@32473 | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSev | string | No | Level-of-severi | -| | | | ty | -| | | | text | -| | | | enumeration | -| | | | defined below: | -| | | | | -| | | | Text Sev | -| | | | Description | -| | | | | -| | | | Emergency 0 | -| | | | system is | -| | | | unusable | -| | | | | -| | | | Alert 1 action | -| | | | must be taken | -| | | | immediately | -| | | | | -| | | | Critical 2 | -| | | | critical | -| | | | conditions | -| | | | | -| | | | Error 3 error | -| | | | conditions | -| | | | | -| | | | Warning 4 | -| | | | warning | -| | | | conditions | -| | | | | -| | | | Notice 5 normal | -| | | | but significant | -| | | | condition | -| | | | | -| | | | Info 6 | -| | | | Informational | -| | | | messages | -| | | | | -| | | | Debug 7 | -| | | | debug-level | -| | | | messages | -+-----------------+-----------------+-----------------+-----------------+ -| syslogTag | string | Yes | Also known as | -| | | | MsgId. Brief | -| | | | non-spaced text | -| | | | indicating the | -| | | | type of message | -| | | | such as | -| | | | ‘TCPOUT’ or | -| | | | ‘BGP_STATUS_CHA | -| | | | NGE’; | -| | | | ‘NILVALUE’ | -| | | | should be used | -| | | | when no other | -| | | | value can be | -| | | | provided | -+-----------------+-----------------+-----------------+-----------------+ -| syslogTs | string | No | Timestamp | -| | | | parsed from | -| | | | non-VES syslog | -| | | | message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogVer | number | No | IANA assigned | -| | | | version of the | -| | | | syslog protocol | -| | | | specification: | -| | | | | -| | | | 0: VES | -| | | | | -| | | | 1: IANA RFC5424 | -+-----------------+-----------------+-----------------+-----------------+ - -Examples of syslogSData : - -Preferred - - ts=”1985-04-12T23:20:50.52Z” tag=”BGP_NEIGHBOR_DOWN” msg=”The BGP - session to neighbor 10.10.10.10 is down” - -Deprecated - - [attinc@1234 ts=”1985-04-12T23:20:50.52Z” tag=”BGP_NEIGHBOR_DOWN” - msg=”The BGP session to neighbor 10.10.10.10 is down”] - -Syslog references: - -https://tools.ietf.org/html/rfc5424#section-6 - - https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml - - ‘Threshold Crossing Alert’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: counter -^^^^^^^^^^^^^^^^^ - -The counter datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| criticality | string | Yes | Enumeration: | -| | | | ‘CRIT’, ‘MAJ’ | -+-----------------+-----------------+-----------------+-----------------+ -| hashMap | hashMap | Yes | Key is the name | -| | | | of the counter | -| | | | and value is | -| | | | the current | -| | | | value of the | -| | | | counter | -+-----------------+-----------------+-----------------+-----------------+ -| threshholdCross | string | Yes | Last threshold | -| ed | | | that was | -| | | | crossed | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: thresholdCrossingAlertFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The thresholdCrossingAlertFields datatype consists of the following -fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | threshold | -| | | | crossing alert | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalParam | counter [ ] | Yes | Array of | -| eters | | | performance | -| | | | counters | -+-----------------+-----------------+-----------------+-----------------+ -| alertAction | string | Yes | Enumeration: | -| | | | ‘SET’, ‘CONT’, | -| | | | ‘CLEAR’ | -+-----------------+-----------------+-----------------+-----------------+ -| alertDescriptio | string | Yes | Unique short | -| n | | | alert | -| | | | description | -| | | | (e.g., | -| | | | NE-CPUMEM) | -+-----------------+-----------------+-----------------+-----------------+ -| alertType | string | Yes | Enumeration: | -| | | | ‘CARD-ANOMALY’, | -| | | | ‘INTERFACE-ANOM | -| | | | ALY’, | -| | | | ELEMENT-ANOMALY | -| | | | ’, | -| | | | ‘SERVICE-ANOMAL | -| | | | Y’ | -+-----------------+-----------------+-----------------+-----------------+ -| alertValue | string | No | Calculated API | -| | | | value (if | -| | | | applicable) | -+-----------------+-----------------+-----------------+-----------------+ -| associatedAlert | string [ ] | No | List of | -| IdList | | | eventIds | -| | | | associated with | -| | | | the event being | -| | | | reported | -+-----------------+-----------------+-----------------+-----------------+ -| collectionTimes | string | Yes | Time when the | -| tamp | | | performance | -| | | | collector | -| | | | picked up the | -| | | | data; with RFC | -| | | | 2822 compliant | -| | | | format: ‘Sat, | -| | | | 13 Mar 2010 | -| | | | 11:29:05 -0800’ | -+-----------------+-----------------+-----------------+-----------------+ -| dataCollector | string | No | Specific | -| | | | performance | -| | | | collector | -| | | | instance used | -+-----------------+-----------------+-----------------+-----------------+ -| elementType | string | No | Type of network | -| | | | element | -| | | | (internal AT&T | -| | | | field) | -+-----------------+-----------------+-----------------+-----------------+ -| eventSeverity | string | Yes | Event severity | -| | | | or priority | -| | | | enumeration: | -| | | | ‘CRITICAL’, | -| | | | ‘MAJOR’, | -| | | | ‘MINOR’, | -| | | | ‘WARNING’, | -| | | | ‘NORMAL’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventStartTimes | string | Yes | Time closest to | -| tamp | | | when the | -| | | | measurement was | -| | | | made; with RFC | -| | | | 2822 compliant | -| | | | format: ‘Sat, | -| | | | 13 Mar 2010 | -| | | | 11:29:05 -0800’ | -+-----------------+-----------------+-----------------+-----------------+ -| interfaceName | string | No | Physical or | -| | | | logical port or | -| | | | card (if | -| | | | applicable) | -+-----------------+-----------------+-----------------+-----------------+ -| networkService | string | No | Network name | -| | | | (internal AT&T | -| | | | field) | -+-----------------+-----------------+-----------------+-----------------+ -| possibleRootCau | string | No | Reserved for | -| se | | | future use | -+-----------------+-----------------+-----------------+-----------------+ -| thresholdCrossi | string | Yes | Version of the | -| ng | | | thresholdCrossi | -| FieldsVersion | | | ngAlertFields | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ - -Technology Specific Datatypes ------------------------------ - - ‘Mobile Flow’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: gtpPerFlowMetrics -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The gtpPerFlowMetrics datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| avgBitErrorRate | number | Yes | Average bit | -| | | | error rate | -+-----------------+-----------------+-----------------+-----------------+ -| avgPacketDelayV | number | Yes | Average packet | -| ariation | | | delay variation | -| | | | or jitter in | -| | | | milliseconds | -| | | | for received | -| | | | packets: | -| | | | Average | -| | | | difference | -| | | | between the | -| | | | packet | -| | | | timestamp and | -| | | | time received | -| | | | for all pairs | -| | | | of consecutive | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| avgPacketLatenc | number | Yes | Average | -| y | | | delivery | -| | | | latency | -+-----------------+-----------------+-----------------+-----------------+ -| avgReceiveThrou | number | Yes | Average receive | -| ghput | | | throughput | -+-----------------+-----------------+-----------------+-----------------+ -| avgTransmitThro | number | Yes | Average | -| ughput | | | transmit | -| | | | throughput | -+-----------------+-----------------+-----------------+-----------------+ -| durConnectionFa | number | No | Duration of | -| iledStatus | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| durTunnelFailed | number | No | Duration of | -| Status | | | errored state, | -| | | | computed as the | -| | | | cumulative time | -| | | | between a | -| | | | tunnel error | -| | | | indicator and | -| | | | the next | -| | | | following | -| | | | non-errored | -| | | | indicator, over | -| | | | this reporting | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivatedBy | string | No | Endpoint | -| | | | activating the | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationE | number | Yes | Time the | -| poch | | | connection is | -| | | | activated in | -| | | | the flow | -| | | | (connection) | -| | | | being reported | -| | | | on, or | -| | | | transmission | -| | | | time of the | -| | | | first packet if | -| | | | activation time | -| | | | is not | -| | | | available | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationM | number | Yes | Integer | -| icrosec | | | microseconds | -| | | | for the start | -| | | | of the flow | -| | | | connection | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationT | string | No | Time the | -| ime | | | 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’ | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivated | string | No | Endpoint | -| By | | | deactivating | -| | | | the flow | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | number | Yes | Time for the | -| nEpoch | | | start of the | -| | | | flow | -| | | | connection, in | -| | | | integer UTC | -| | | | epoch time aka | -| | | | UNIX time | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | number | Yes | Integer | -| nMicrosec | | | microseconds | -| | | | for the start | -| | | | of the flow | -| | | | connection | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | string | Yes | Transmission | -| nTime | | | 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’ | -+-----------------+-----------------+-----------------+-----------------+ -| flowStatus | string | Yes | Connection | -| | | | status at | -| | | | reporting time | -| | | | as a working / | -| | | | inactive / | -| | | | failed | -| | | | indicator value | -+-----------------+-----------------+-----------------+-----------------+ -| gtpConnectionSt | string | No | Current | -| atus | | | connection | -| | | | state at | -| | | | reporting time | -+-----------------+-----------------+-----------------+-----------------+ -| gtpTunnelStatus | string | No | Current tunnel | -| | | | state at | -| | | | reporting time | -+-----------------+-----------------+-----------------+-----------------+ -| ipTosCountList | hashMap | No | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| ipTosList | string | No | Array of unique | -| | | | IP | -| | | | Type-of-Service | -| | | | values observed | -| | | | in the flow | -| | | | where values | -| | | | range from '0' | -| | | | to '255' | -+-----------------+-----------------+-----------------+-----------------+ -| largePacketRtt | number | No | large packet | -| | | | round trip time | -+-----------------+-----------------+-----------------+-----------------+ -| largePacketThre | number | No | large packet | -| shold | | | threshold being | -| | | | applied | -+-----------------+-----------------+-----------------+-----------------+ -| maxPacketDelayV | number | Yes | Maximum packet | -| ariation | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| maxReceiveBitRa | number | No | maximum receive | -| te | | | bit rate" | -+-----------------+-----------------+-----------------+-----------------+ -| maxTransmitBitR | number | No | maximum | -| ate | | | transmit bit | -| | | | rate | -+-----------------+-----------------+-----------------+-----------------+ -| mobileQciCosCou | hashMap | No | array of key: | -| ntList | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| mobileQciCosLis | string | No | Array of unique | -| t | | | LTE QCI or UMTS | -| | | | class-of-servic | -| | | | e | -| | | | values observed | -| | | | in the flow | -+-----------------+-----------------+-----------------+-----------------+ -| numActivationFa | number | Yes | Number of | -| ilures | | | failed | -| | | | activation | -| | | | requests, as | -| | | | observed by the | -| | | | reporting node | -+-----------------+-----------------+-----------------+-----------------+ -| numBitErrors | number | Yes | number of | -| | | | errored bits | -+-----------------+-----------------+-----------------+-----------------+ -| numBytesReceive | number | Yes | number of bytes | -| d | | | received, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numBytesTransmi | number | Yes | number of bytes | -| tted | | | transmitted, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numDroppedPacke | number | Yes | number of | -| ts | | | received | -| | | | packets dropped | -| | | | due to errors | -| | | | per virtual | -| | | | interface | -+-----------------+-----------------+-----------------+-----------------+ -| numGtpEchoFailu | number | No | Number of Echo | -| res | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| numGtpTunnelErr | number | No | Number of | -| ors | | | tunnel error | -| | | | indications | -| | | | where errors | -| | | | are defined in | -| | | | 3GPP TS 29.281 | -| | | | sec 7.3.1 and | -| | | | 3GPP TS 29.060 | -| | | | sec. 11.1 | -+-----------------+-----------------+-----------------+-----------------+ -| numHttpErrors | number | No | Http error | -| | | | count | -+-----------------+-----------------+-----------------+-----------------+ -| numL7BytesRecei | number | Yes | number of | -| ved | | | tunneled layer | -| | | | 7 bytes | -| | | | received, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numL7BytesTrans | number | Yes | number of | -| mitted | | | tunneled layer | -| | | | 7 bytes | -| | | | transmitted, | -| | | | excluding | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numLostPackets | number | Yes | number of lost | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| numOutOfOrderPa | number | Yes | number of | -| ckets | | | out-of-order | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketErrors | number | Yes | number of | -| | | | errored packets | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsRecei | number | Yes | number of | -| vedExclRetrans | | | packets | -| | | | received, | -| | | | excluding | -| | | | retransmission | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsRecei | number | Yes | number of | -| vedInclRetrans | | | packets | -| | | | received, | -| | | | including | -| | | | retransmission | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsTrans | number | Yes | number of | -| mittedInclRetra | | | packets | -| ns | | | transmitted, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numRetries | number | Yes | number of | -| | | | packet retrie | -+-----------------+-----------------+-----------------+-----------------+ -| numTimeouts | number | Yes | number of | -| | | | packet timeouts | -+-----------------+-----------------+-----------------+-----------------+ -| numTunneledL7By | number | Yes | number of | -| tesReceived | | | tunneled layer | -| | | | 7 bytes | -| | | | received, | -| | | | excluding | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| roundTripTime | number | Yes | Round Trip time | -+-----------------+-----------------+-----------------+-----------------+ -| tcpFlagCountLis | hashMap | No | Array of key: | -| t | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| tcpFlagList | string | No | Array of unique | -| | | | TCP Flags | -| | | | observed in the | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ -| timeToFirstByte | number | Yes | Time in | -| | | | milliseconds | -| | | | between the | -| | | | connection | -| | | | activation and | -| | | | first byte | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: mobileFlowFields -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The mobileFlowFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | mobileFlow | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| applicationType | string | No | Application | -| | | | type inferred | -+-----------------+-----------------+-----------------+-----------------+ -| appProtocolType | string | No | Application | -| | | | protocol | -+-----------------+-----------------+-----------------+-----------------+ -| appProtocolVers | string | No | Application | -| ion | | | version | -+-----------------+-----------------+-----------------+-----------------+ -| cid | string | No | Cell Id | -+-----------------+-----------------+-----------------+-----------------+ -| connectionType | string | No | Abbreviation | -| | | | referencing a | -| | | | 3GPP reference | -| | | | point e.g., | -| | | | S1-U, S11, etc | -+-----------------+-----------------+-----------------+-----------------+ -| ecgi | string | No | Evolved Cell | -| | | | Global Id | -+-----------------+-----------------+-----------------+-----------------+ -| flowDirection | string | Yes | Flow direction, | -| | | | indicating if | -| | | | the reporting | -| | | | node is the | -| | | | source of the | -| | | | flow or | -| | | | destination for | -| | | | the flow | -+-----------------+-----------------+-----------------+-----------------+ -| gtpPerFlowMetri | gtpPer | Yes | Mobility GTP | -| cs | FlowMetrics | | Protocol per | -| | | | flow metrics | -+-----------------+-----------------+-----------------+-----------------+ -| gtpProtocolType | string | No | GTP protocol | -+-----------------+-----------------+-----------------+-----------------+ -| gtpVersion | string | No | GTP protocol | -| | | | version | -+-----------------+-----------------+-----------------+-----------------+ -| httpHeader | string | No | HTTP request | -| | | | header, if the | -| | | | flow connects | -| | | | to a node | -| | | | referenced by | -| | | | HTTP | -+-----------------+-----------------+-----------------+-----------------+ -| imei | string | No | IMEI for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| imsi | string | No | IMSI for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| ipProtocolType | string | Yes | IP protocol | -| | | | type e.g., TCP, | -| | | | UDP, RTP... | -+-----------------+-----------------+-----------------+-----------------+ -| ipVersion | string | Yes | IP protocol | -| | | | version e.g., | -| | | | IPv4, IPv6 | -+-----------------+-----------------+-----------------+-----------------+ -| lac | string | No | Location area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mcc | string | No | Mobile country | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mnc | string | No | Mobile network | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mobileFlowField | string | Yes | Version of the | -| sVersion | | | mobileFlowField | -| | | | s | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| msisdn | string | No | MSISDN for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, as an | -| | | | integer, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| otherEndpointIp | string | Yes | IP address for | -| Address | | | the other | -| | | | endpoint, as | -| | | | used for the | -| | | | flow being | -| | | | reported on | -+-----------------+-----------------+-----------------+-----------------+ -| otherEndpointPo | integer | Yes | IP Port for the | -| rt | | | reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| otherFunctional | string | No | Functional role | -| Role | | | of the other | -| | | | endpoint for | -| | | | the flow being | -| | | | reported on | -| | | | e.g., MME, | -| | | | S-GW, P-GW, | -| | | | PCRF... | -+-----------------+-----------------+-----------------+-----------------+ -| rac | string | No | Routing area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| radioAccessTech | string | No | Radio Access | -| nology | | | Technology | -| | | | e.g., 2G, 3G, | -| | | | LTE | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEndpoi | string | Yes | IP address for | -| ntIpAddr | | | the reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEndpoi | integer | Yes | IP port for the | -| ntPort | | | reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| sac | string | No | Service area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| samplingAlgorit | integer | No | Integer | -| hm | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| tac | string | No | Transport area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| tunnelId | string | No | Tunnel | -| | | | identifier | -+-----------------+-----------------+-----------------+-----------------+ -| vlanId | string | No | VLAN identifier | -| | | | used by this | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ - - ‘SipSignaling’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: sipSignalingFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The sipSignalingFields datatype communicates information about sip -signaling messages, parameters and signaling state; it consists of the -following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalInfor | hashMap | No | Additional | -| mation | | | sipSignaling | -| | | | fields | -+-----------------+-----------------+-----------------+-----------------+ -| compressedSip | string | No | The full SIP | -| | | | request/respons | -| | | | e | -| | | | including | -| | | | headers and | -| | | | bodies | -+-----------------+-----------------+-----------------+-----------------+ -| correlator | string | Yes | Constant across | -| | | | all events on | -| | | | this call | -+-----------------+-----------------+-----------------+-----------------+ -| localIpAddress | string | Yes | Ip address on | -| | | | xNF | -+-----------------+-----------------+-----------------+-----------------+ -| localPort | string | Yes | Port on xNF | -+-----------------+-----------------+-----------------+-----------------+ -| remoteIpAddress | string | Yes | IP address of | -| | | | peer endpoint | -+-----------------+-----------------+-----------------+-----------------+ -| remotePort | string | Yes | Port of peer | -| | | | endpoint | -+-----------------+-----------------+-----------------+-----------------+ -| sipSignalingFie | string | Yes | Version of the | -| ldsVersion | | | sipSignalingFie | -| | | | lds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ -| summarySip | string | No | The SIP Method | -| | | | or Response | -| | | | (‘INVITE’, ‘200 | -| | | | OK’, ‘BYE’, | -| | | | etc) | -+-----------------+-----------------+-----------------+-----------------+ -| vendorNfNameFie | vendorNfNameFie | Yes | Vendor, NF and | -| lds | lds | | nfModule names | -+-----------------+-----------------+-----------------+-----------------+ - - ‘Voice Quality’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: endOfCallVqmSummaries -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The endOfCallVqmSummaries datatype provides end of call voice quality -metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| adjacencyName | string | Yes | Adjacency name | -+-----------------+-----------------+-----------------+-----------------+ -| endpointAverage | number | No | Endpoint | -| Jitter | | | average jitter | -+-----------------+-----------------+-----------------+-----------------+ -| endpointDescrip | string | Yes | Enumeration: | -| tion | | | ‘Caller’, | -| | | | ‘Callee’ | -+-----------------+-----------------+-----------------+-----------------+ -| endpointMaxJitt | number | No | Endpoint | -| er | | | maximum jitter | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsDiscarded | | | octets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsLost | | | octets lost | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsReceived | | | octets received | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsSent | | | octets sent | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsDiscarded | | | packets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsLost | | | packets lost | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsReceived | | | packets | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsSent | | | packets sent | -+-----------------+-----------------+-----------------+-----------------+ -| localAverageJit | number | No | Local average | -| ter | | | jitter | -+-----------------+-----------------+-----------------+-----------------+ -| localAverageJit | number | No | Local average | -| terBufferDelay | | | jitter buffer | -| | | | delay | -+-----------------+-----------------+-----------------+-----------------+ -| localMaxJitter | number | No | Local maximum | -| | | | jitter | -+-----------------+-----------------+-----------------+-----------------+ -| localMaxJitterB | number | No | Local max | -| ufferDelay | | | jitter buffer | -| | | | delay | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsD | number | No | Local RTP | -| iscarded | | | octets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsL | number | No | Local RTP | -| ost | | | octets lost | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsR | number | No | Local RTP | -| eceived | | | octets received | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsS | number | No | Local RTP | -| ent | | | octets sent | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Discarded | | | packets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Lost | | | packets lost | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Received | | | packets | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Sent | | | packets sent | -+-----------------+-----------------+-----------------+-----------------+ -| mosCqe | number | No | Decimal range | -| | | | from 1 to 5 (1 | -| | | | decimal place) | -+-----------------+-----------------+-----------------+-----------------+ -| oneWayDelay | number | No | one-way path | -| | | | delay in | -| | | | milliseconds | -+-----------------+-----------------+-----------------+-----------------+ -| packetLossPerce | number | No | Calculated | -| nt | | | percentage | -| | | | packet loss | -| | | | based on | -| | | | endpoint RTP | -| | | | packets lost | -| | | | (as reported in | -| | | | RTCP) and local | -| | | | RTP packets | -| | | | sent. Direction | -| | | | is based on | -| | | | endpoint | -| | | | description | -| | | | (Caller, | -| | | | Callee). | -| | | | Decimal (2 | -| | | | decimal places) | -+-----------------+-----------------+-----------------+-----------------+ -| rFactor | number | No | rFactor from 0 | -| | | | to 100 | -+-----------------+-----------------+-----------------+-----------------+ -| roundTripDelay | number | No | Round trip | -| | | | delay in | -| | | | milliseconds | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: voiceQualityFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The voiceQualityFields datatype provides statistics related to customer -facing voice products; consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalInfor | hashMap | No | Additional | -| mation | | | voice quality | -| | | | fields | -+-----------------+-----------------+-----------------+-----------------+ -| calleeSideCodec | string | Yes | Callee codec | -| | | | for the call | -+-----------------+-----------------+-----------------+-----------------+ -| callerSideCodec | string | Yes | Caller codec | -| | | | for the call | -+-----------------+-----------------+-----------------+-----------------+ -| correlator | string | Yes | Constant across | -| | | | all events on | -| | | | this call | -+-----------------+-----------------+-----------------+-----------------+ -| endOfCallVqmSum | endOfCallVqm | No | End of call | -| maries | Summaries | | voice quality | -| | | | metric | -| | | | summaries | -+-----------------+-----------------+-----------------+-----------------+ -| phoneNumber | string | No | Phone number | -| | | | associated with | -| | | | the correlator | -+-----------------+-----------------+-----------------+-----------------+ -| midCallRtcp | string | Yes | Base64 encoding | -| | | | of the binary | -| | | | RTCP data | -| | | | (excluding | -| | | | Eth/IP/UDP | -| | | | headers) | -+-----------------+-----------------+-----------------+-----------------+ -| vendorNfNameFie | vendorNfNameFie | Yes | Vendor, NF and | -| lds | lds | | nfModule names | -+-----------------+-----------------+-----------------+-----------------+ -| voiceQualityFie | string | Yes | Version of the | -| ldsVersion | | | voiceQualityFie | -| | | | lds | -| | | | block as “#.#” | -| | | | where # is a | -| | | | digit; see | -| | | | section 1 for | -| | | | the correct | -| | | | digits to use. | -+-----------------+-----------------+-----------------+-----------------+ - -Exceptions -========== - -RESTful Web Services Exceptions -------------------------------- - -RESTful services generate and send exceptions to clients in response to -invocation errors. Exceptions send HTTP status codes (specified later in -this document for each operation). HTTP status codes may be followed by -an optional JSON exception structure described below. Two types of -exceptions may be defined: service exceptions and policy exceptions. - -+-----------------+-----------------+-----------------+-----------------+ -| **Field Name** | **Data Type** | **Required?** | **Description** | -+=================+=================+=================+=================+ -| messageId | xs:string | Yes | Unique message | -| | | | identifier of | -| | | | the format | -| | | | ‘ABCnnnn’ where | -| | | | ‘ABC’ is either | -| | | | ‘SVC’ for | -| | | | Service | -| | | | Exceptions or | -| | | | ‘POL’ for | -| | | | Policy | -| | | | Exception. | -| | | | | -| | | | Exception | -| | | | numbers may be | -| | | | in the range of | -| | | | 0001 to 9999 | -| | | | where : | -| | | | | -| | | | - 0001 to 2999 | -| | | | are defined | -| | | | by OMA (see | -| | | | OMA’s | -| | | | `Common | -| | | | definitions | -| | | | for RESTful | -| | | | Network | -| | | | APIs <http:/ | -| | | | /technical.open | -| | | | mobilealliance. | -| | | | org/Technical/r | -| | | | elease_program/ | -| | | | docs/REST_NetAP | -| | | | I_Common/V1_0-2 | -| | | | 0120417-C/OMA-T | -| | | | S-REST_NetAPI_C | -| | | | ommon-V1_0-2012 | -| | | | 0417-C.pdf>`__ | -| | | | for details) | -| | | | | -| | | | - 3000-9999 | -| | | | are | -| | | | available | -| | | | and | -| | | | undefined | -+-----------------+-----------------+-----------------+-----------------+ -| text | xs:string | Yes | Message text, | -| | | | with | -| | | | replacement | -| | | | variables | -| | | | marked with %n, | -| | | | where n is an | -| | | | index into the | -| | | | list of | -| | | | <variables> | -| | | | elements, | -| | | | starting at 1 | -+-----------------+-----------------+-----------------+-----------------+ -| variables | xs:string | No | List of zero or | -| | [0..unbounded] | | more strings | -| | | | that represent | -| | | | the contents of | -| | | | the variables | -| | | | used by the | -| | | | message text. | -+-----------------+-----------------+-----------------+-----------------+ -| url | xs:anyUrl | No | Hyperlink to a | -| | | | detailed error | -| | | | resource (e.g., | -| | | | an HTML page | -| | | | for browser | -| | | | user agents). | -+-----------------+-----------------+-----------------+-----------------+ - -Service Exceptions ------------------- - -When a service is not able to process a request, and retrying the -request with the same information will also result in a failure, and the -issue is not related to a service policy issue, then the service will -issue a fault using the service exception fault message. Examples of -service exceptions include invalid input, lack of availability of a -required resource or a processing error. - -A service exception uses the letters 'SVC' at the beginning of the -message identifier. ‘SVC’ service exceptions used by the VES Event -Listener API are defined below. - -+-------------+-------------+-------------+-------------+-------------+ -| *MessageId* | *Descriptio | *Text* | *Variables* | *Parent | -| | n | | | HTTP Code* | -| | / Comment* | | | | -+=============+=============+=============+=============+=============+ -| SVC0001 | General | <custom | None | 400 | -| | service | error | | | -| | error (see | message> | | | -| | SVC2000) | | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC0002 | Bad | Invalid | %1: message | 400 | -| | parameter | input value | part | | -| | | for message | | | -| | | part %1 | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC1000 | No server | No server | None | 500 | -| | resources | resources | | | -| | | available | | | -| | | to process | | | -| | | the request | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC2000 | More | The | %1: human | 400 | -| | elaborate | following | readable | | -| | version of | service | description | | -| | SVC0001 | error | of the | | -| | | occurred: | error | | -| | | %1. Error | | | -| | | code is %2. | %2: error | | -| | | | code | | -+-------------+-------------+-------------+-------------+-------------+ - -.. - - Table 1 - Service Exceptions - -Policy Exceptions ------------------ - -When a service is not able to complete because the request fails to meet -a policy criteria, then the service will issue a fault using the policy -exception fault message. To clarify how a policy exception differs from -a service exception, consider that all the input to an operation may be -valid as meeting the required input for the operation (thus no service -exception), but using that input in the execution of the service may -result in conditions that require the service not to complete. Examples -of policy exceptions include privacy violations, requests not permitted -under a governing service agreement or input content not acceptable to -the service provider. - -A Policy Exception uses the letters 'POL' at the beginning of the -message identifier. ‘POL’ policy exceptions used by the VES Event -Listener API are defined below. - -+-------------+-------------+-------------+-------------+-------------+ -| *MessageId* | *Descriptio | *Text* | *Variables* | *Parent | -| | n | | | HTTP Code* | -| | / Comment* | | | | -+=============+=============+=============+=============+=============+ -| POL0001 | General | A policy | None | 401 | -| | policy | error | | | -| | error (see | occurred. | | | -| | POL2000) | | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL1009 | User not | User has | None | 401 | -| | provisioned | not been | | | -| | for service | provisioned | | | -| | | for service | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL1010 | User | User has | None | 401 | -| | suspended | been | | | -| | from | suspended | | | -| | service | from | | | -| | | service | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL2000 | More | The | %1: human | 401 | -| | elaborate | following | readable | | -| | version of | policy | description | | -| | POL0001 | error | of the | | -| | | occurred: | error | | -| | | %1. Error | | | -| | | code is %2. | %2: error | | -| | | | code | | -+-------------+-------------+-------------+-------------+-------------+ -| POL9003 | Message | Message | None | 400 | -| | size | content | | | -| | exceeds | size | | | -| | limit | exceeds the | | | -| | | allowable | | | -| | | limit | | | -+-------------+-------------+-------------+-------------+-------------+ - -.. - - Table 2 - Policy Exceptions - -RESTful Web Services Definition -=============================== - -REST Operation Overview ------------------------ - -REST Operation Summary -~~~~~~~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| **Operation Action** | **HTTP** | **Resource URL | -| | | relative to | -| | **Verb** | {ServerRoot}, which | -| | | is defined in | -| | | section** **3** | -+-----------------------+-----------------------+-----------------------+ -| publishAnyEvent | POST | /eventListener/v{apiV | -| | | ersion} | -+-----------------------+-----------------------+-----------------------+ -| publishEventBatch | POST | /eventListener/v{apiV | -| | | ersion}/eventBatch | -+-----------------------+-----------------------+-----------------------+ - -Table 3 - REST Operation Summary - -Api Versioning -~~~~~~~~~~~~~~ - -apiVersion is used to describe the major version number of the event -listener API (which is the same as the major version number of this -specification). When this number changes, the implication is: the new -major version will break clients of older major versions in some way, if -they try to use the new API without modification (e.g., unmodified v1 -clients would not be able to use v2 without error). - -The Event Listener shall provide the following HTTP headers in response -to all requests. Additionally, clients may populate these headers on -requests to indicate the specific version they are interested in. - -- X-MinorVersion: 0 - -- X-PatchVersion: 1 - -- X-LatestVersion: 7.0.1 - -If a client requests major version 5 (per the REST resource URL) and -does not specify the above headers, then they will be provided with the -latest patch version of 5.0.x. If the client wants a particular minor -version of major version 5, then they need to supply the X-MinorVersion -header with their request. For example, if they request major version 5 -with X-MinorVersion: 4, they will get the latest patch version of 5.4, -which is 5.4.1 - -Buffering of Events -~~~~~~~~~~~~~~~~~~~~ - -{ServerRoot} is defined in section 3 of this document, which defines the -REST resource URL. One or more FQDNs may be provisioned in an event -source when it is instantiated or updated. If an event source is unable -to reach any of the provisioned FQDNs, it should buffer the event data -specified below, up to a maximum of 1 hour, until a connection can be -established and the events can be successfully delivered to the VES -Event Listener service. - -xNFs acting as event sources should not send syslog events to the VES -Event Listener during debug mode (which is controlled via the Netconf -management interface), but should store syslog events locally for -access, and possible FTP transfer, via the xNF console (e.g., command -line interface). - -If the internal event source event buffer or local storage should -overflow, then the event source should send a Fault event, and should -discard events in a first-in, first-out (FIFO) manner (i.e., discard -oldest events first). - -Message Size -~~~~~~~~~~~~ - -Message size should be limited to 2 megabytes of uncompressed text sent -as application/json. - -Operation: publishAnyEvent --------------------------- - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish any single event to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -Call Flow -~~~~~~~~~ - -|image3| - -Figure 2 - publishAnyEvent Call Flow - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Accept | string | No | Determines the | -| | | | format of the | -| | | | body of the | -| | | | response. Valid | -| | | | values are: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| Authorization | string | Yes | The username | -| | | | and password | -| | | | are formed into | -| | | | one string as | -| | | | “username:passw | -| | | | ord”. | -| | | | This string is | -| | | | then Base64 | -| | | | encoded to | -| | | | produce the | -| | | | encoded | -| | | | credential | -| | | | which is | -| | | | communicated in | -| | | | the header | -| | | | after the | -| | | | string | -| | | | “Authorization: | -| | | | Basic “. See | -| | | | examples below. | -| | | | If the | -| | | | Authorization | -| | | | header is | -| | | | missing, then | -| | | | an HTTP 400 | -| | | | Invalid Request | -| | | | message shall | -| | | | be returned. If | -| | | | the string | -| | | | supplied is | -| | | | invalid, then | -| | | | an HTTP 401 | -| | | | Unauthorized | -| | | | message shall | -| | | | be returned. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Note that | -| | | | content length | -| | | | is limited to | -| | | | 2Megabyte. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | Yes | Must be set to | -| | | | one of the | -| | | | following | -| | | | values: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | No | The minor | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | No | The patch | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | No | The full | -| | | | version of the | -| | | | API requested | -| | | | by the client | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Event | event | Yes | Contains the | -| | | | JSON structure | -| | | | of the common | -| | | | event format. | -+-----------------+-----------------+-----------------+-----------------+ - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Used only in | -| | | | error | -| | | | conditions. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | No | Used only in | -| | | | error | -| | | | conditions | -+-----------------+-----------------+-----------------+-----------------+ -| Date | datetime | No | Date time of | -| | | | the response in | -| | | | GMT | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | Yes | The minor | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | Yes | The patch | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | Yes | The full | -| | | | version of the | -| | | | API service | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields (for success responses): no content is provided. - -Body Fields (for error responses): - -+---------------+---------------+------------------+--------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+---------------+---------------+------------------+--------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+---------------+---------------+------------------+--------------------------------+ - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| *Code* | *Reason Phrase* | *Description* | -+=======================+=======================+=======================+ -| 202 | Accepted | The request has been | -| | | accepted for | -| | | processing | -+-----------------------+-----------------------+-----------------------+ -| 400 | Bad Request | Many possible reasons | -| | | not specified by the | -| | | other codes (e.g., | -| | | missing required | -| | | parameters or | -| | | incorrect format). | -| | | The response body may | -| | | include a further | -| | | exception code and | -| | | text. HTTP 400 errors | -| | | may be mapped to | -| | | SVC0001 (general | -| | | service error), | -| | | SVC0002 (bad | -| | | parameter), SVC2000 | -| | | (general service | -| | | error with details) | -| | | or PO9003 (message | -| | | content size exceeds | -| | | the allowable limit). | -+-----------------------+-----------------------+-----------------------+ -| 401 | Unauthorized | Authentication failed | -| | | or was not provided. | -| | | HTTP 401 errors may | -| | | be mapped to POL0001 | -| | | (general policy | -| | | error) or POL2000 | -| | | (general policy error | -| | | with details). | -+-----------------------+-----------------------+-----------------------+ -| 404 | Not Found | The server has not | -| | | found anything | -| | | matching the | -| | | Request-URI. No | -| | | indication is given | -| | | of whether the | -| | | condition is | -| | | temporary or | -| | | permanent. | -+-----------------------+-----------------------+-----------------------+ -| 405 | Method Not Allowed | A request was made of | -| | | a resource using a | -| | | request method not | -| | | supported by that | -| | | resource (e.g., using | -| | | PUT on a REST | -| | | resource that only | -| | | supports POST). | -+-----------------------+-----------------------+-----------------------+ -| 500 | Internal Server Error | The server | -| | | encountered an | -| | | internal error or | -| | | timed out; please | -| | | retry (general | -| | | catch-all server-side | -| | | error).HTTP 500 | -| | | errors may be mapped | -| | | to SVC1000 (no server | -| | | resources). | -+-----------------------+-----------------------+-----------------------+ - -.. _sample-request-and-response-1: - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _sample-request-1: - -Sample Request -^^^^^^^^^^^^^^ - -+-----------------------------------------------------------------------+ -| POST /eventListener/v7 HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": "4.0.1", | -| | -| "vesEventListenerVersion": "7.0.1", | -| | -| "domain": "fault", | -| | -| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000245", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam001", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are | -| unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| } | -| | -| } | -+-----------------------------------------------------------------------+ - -.. _sample-success-response-1: - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -+------------------------+ - -Sample Error Responses -^^^^^^^^^^^^^^^^^^^^^^ - -Sample Policy Exception -''''''''''''''''''''''' - -+-------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+-------------------------------------------------------------+ - -Sample Service Exception -'''''''''''''''''''''''' - -+---------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------+ - -Operation: publishEventBatch ----------------------------- - -.. _functional-behavior-1: - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish a batch of events to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -.. _call-flow-1: - -Call Flow -~~~~~~~~~ - -|image4| - -Figure 3 – publishEventBatch Call Flow - -.. _input-parameters-1: - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Accept | string | No | Determines the | -| | | | format of the | -| | | | body of the | -| | | | response. Valid | -| | | | values are: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| Authorization | string | Yes | The username | -| | | | and password | -| | | | are formed into | -| | | | one string as | -| | | | “username:passw | -| | | | ord”. | -| | | | This string is | -| | | | then Base64 | -| | | | encoded to | -| | | | produce the | -| | | | encoded | -| | | | credential | -| | | | which is | -| | | | communicated in | -| | | | the header | -| | | | after the | -| | | | string | -| | | | “Authorization: | -| | | | Basic “. See | -| | | | examples below. | -| | | | If the | -| | | | Authorization | -| | | | header is | -| | | | missing, then | -| | | | an HTTP 400 | -| | | | Invalid Request | -| | | | message shall | -| | | | be returned. If | -| | | | the string | -| | | | supplied is | -| | | | invalid, then | -| | | | an HTTP 401 | -| | | | Unauthorized | -| | | | message shall | -| | | | be returned. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Note that | -| | | | content length | -| | | | is limited to | -| | | | 2Megabyte. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | Yes | Must be set to | -| | | | one of the | -| | | | following | -| | | | values: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | No | The minor | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | No | The patch | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | No | The full | -| | | | version of the | -| | | | API requested | -| | | | by the client | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| eventList | eventList | Yes | Array of events | -| | | | conforming to | -| | | | the common | -| | | | event format. | -+-----------------+-----------------+-----------------+-----------------+ - -.. _output-parameters-1: - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Used only in | -| | | | error | -| | | | conditions. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | No | Used only in | -| | | | error | -| | | | conditions | -+-----------------+-----------------+-----------------+-----------------+ -| Date | datetime | No | Date time of | -| | | | the response in | -| | | | GMT | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | Yes | The minor | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | Yes | The patch | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | Yes | The full | -| | | | version of the | -| | | | API service | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields (for success responses: no content is provided. - -Body Fields (for error responses): - -+---------------+---------------+------------------+--------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+---------------+---------------+------------------+--------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+---------------+---------------+------------------+--------------------------------+ - -.. _http-status-codes-1: - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| *Code* | *Reason Phrase* | *Description* | -+=======================+=======================+=======================+ -| 202 | Accepted | The request has been | -| | | accepted for | -| | | processing | -+-----------------------+-----------------------+-----------------------+ -| 400 | Bad Request | Many possible reasons | -| | | not specified by the | -| | | other codes (e.g., | -| | | missing required | -| | | parameters or | -| | | incorrect format). | -| | | The response body may | -| | | include a further | -| | | exception code and | -| | | text. HTTP 400 errors | -| | | may be mapped to | -| | | SVC0001 (general | -| | | service error), | -| | | SVC0002 (bad | -| | | parameter), SVC2000 | -| | | (general service | -| | | error with details) | -| | | or PO9003 (message | -| | | content size exceeds | -| | | the allowable limit). | -+-----------------------+-----------------------+-----------------------+ -| 401 | Unauthorized | Authentication failed | -| | | or was not provided. | -| | | HTTP 401 errors may | -| | | be mapped to POL0001 | -| | | (general policy | -| | | error) or POL2000 | -| | | (general policy error | -| | | with details). | -+-----------------------+-----------------------+-----------------------+ -| 404 | Not Found | The server has not | -| | | found anything | -| | | matching the | -| | | Request-URI. No | -| | | indication is given | -| | | of whether the | -| | | condition is | -| | | temporary or | -| | | permanent. | -+-----------------------+-----------------------+-----------------------+ -| 405 | Method Not Allowed | A request was made of | -| | | a resource using a | -| | | request method not | -| | | supported by that | -| | | resource (e.g., using | -| | | PUT on a REST | -| | | resource that only | -| | | supports POST). | -+-----------------------+-----------------------+-----------------------+ -| 500 | Internal Server Error | The server | -| | | encountered an | -| | | internal error or | -| | | timed out; please | -| | | retry (general | -| | | catch-all server-side | -| | | error).HTTP 500 | -| | | errors may be mapped | -| | | to SVC1000 (no server | -| | | resources). | -+-----------------------+-----------------------+-----------------------+ - -.. _sample-request-and-response-2: - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _sample-request-2: - -Sample Request -^^^^^^^^^^^^^^ - -+-----------------------------------------------------------------------+ -| POST /eventListener/v7/eventBatch HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | { | -| | -| "eventList": [ | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": "4.0.1", | -| | -| "vesEventListenerVersion": "7.0.1", | -| | -| "domain": "fault", | -| | -| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000250", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam0011234", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are | -| unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| }, | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": "4.0.1", | -| | -| "vesEventListenerVersion": "7.0.1", | -| | -| "domain": "fault", | -| | -| "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable", | -| | -| "eventId": "fault0000251", | -| | -| "sequence": 0, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "ibcx0001vm002oam0011234", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfVendorName": "Ericsson", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000010, | -| | -| "lastEpochMicrosec": 1413378172000010, | -| | -| "timeZoneOffset": "UTC-05:30" | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 4.0, | -| | -| "alarmCondition": "RecordingServerUnreachable", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Recording server unreachable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active" | -| | -| } | -| | -| } | -| | -| ] | -| | -| } | -+-----------------------------------------------------------------------+ - -.. _sample-success-response-2: - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -+------------------------+ - -.. _sample-error-responses-1: - -Sample Error Responses -^^^^^^^^^^^^^^^^^^^^^^ - -.. _sample-policy-exception-1: - -Sample Policy Exception -''''''''''''''''''''''' - -+-------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.1 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+-------------------------------------------------------------+ - -.. _sample-service-exception-1: - -Sample Service Exception -'''''''''''''''''''''''' - -+---------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 1 | -| | -| X-LatestVersion: 7.0.0 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------+ - -Terminology -=========== - -Terminology used in this document is summarized below: - -**A&AI**. Active & Available Inventory is the ONAP component that -provides data views of Customer Subscriptions, Products, Services, -Resources, and their relationships. - -**Alarm Condition**. Short name of the alarm condition/problem, such as -a trap name. - -**APPC (formerly APP-C)**. Application Controller. Handles the life -cycle management of Virtual Network Functions (VNFs). - -**ASDC**. AT&T Service Design and Creation Platform: the original name -for the SDC. Replaced by SDC. - -**Common Event Format**. A JSON schema describing events sent to the VES -Event Listener. - -**Common Event Header**. A component of the Common Event Format JSON -structure. This datatype consists of fields common to all events. - -**DCAE**. Data Collection Analysis and Events. DCAE is the ONAP -subsystem that supports closed loop control and higher-level correlation -for business and operations activities. DCAE collects performance, -usage, and configuration data, provides computation of analytics, aids -in trouble-shooting and management, and publishes event, data, and -analytics to the rest of the ONAP system for FCAPS functionality. - -**DMaaP.** Data Movement as a Platform. A set of common services -provided by ONAP, including a Message Router, Data Router, and a Data -Bus Controller. - -**Domain**. In VES, an event ‘domain’ identifies a broad category of -events (e.g., ‘fault’ or ‘measurement’), each of which is associated -with a VES domain field block, which is sent with the commonEventHeader -when events of that category are generated. - -**ECOMP**. Enhanced Control, Orchestration, Management and Policy -preceded ONAP and is the name given to AT&T’s instance of the ONAP -platform. - -**Epoch**. The number of seconds that have elapsed since -00:00:00 \ `Coordinated Universal -Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC), -Thursday, 1 January 1970. Every day is treated as if it contains exactly -86400 seconds, so \ `leap -seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied -to seconds since the Epoch. In VES Epoch times are measured in -microseconds. - -**Event.** A well-structured packet of network management information -identified by an eventName which is asynchronously communicated to one -or more instances of an Event Listener service to subscribers interested -in that eventName. Events can convey measurements, faults, syslogs, -threshold crossing alerts, and others types of information. - -**Event Id**. Event key that is unique to the event source. The key must -be unique within notification life cycle similar to EventID from 3GPP. -It could be a sequential number, or a composite key formed from the -event fields, such as sourceName_alarmCondition_startEpoch. The eventId -should not include whitespace. For fault events, eventId is the eventId -of the initial alarm; if the same alarm is raised again for changed, -acknowledged or cleared cases, eventId must be the same as the initial -alarm (along with the same startEpochMicrosec and an incremental -sequence number. - -**Event Name**. Identifier for specific types of events. Specific -eventNames registered by the YAML may require that certain fields, which -are optional in the Common Event Format, be present when events with -that eventName are published. - -**Event Streaming**. The delivery of network management event -information in real time. - -**Extensible Data Structures**. Data structures (e.g., hashMap) that -allow event sources to send information not specifically identified in -the VES schema. - -**Hash Map**. A hash table, or data structure, used to implement an -associative array, a structure than can map keys to values. In VES 6.0, -all name-value pair structures were changed to hash maps (i.e., {‘name’: -‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’: -‘keyValue’}). - -**ICE**. Incubation and Certification Environment. Facilitates vendors -and third-party in developing virtual network functions using ONAP and a -network cloud. - -**IPMI**. The `Intelligent Platform Management -Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__. - -**JSON**. Java Script Object Notation. JSON is an -`open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file -format <https://en.wikipedia.org/wiki/File_format>`__ that uses -`human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__ -text to transmit data objects consisting of `attribute–value -pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__ -and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__ -(or any other -`serializable <https://en.wikipedia.org/wiki/Serialization>`__ value). -It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format -used for -`asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__ -browser–server communication. - -**NF**. Network Function. Generalized name for a VNF or PNF. - -**NFC**. Network Function Component. Generalized name for a VNFC or a -component of a PNF. - -**ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__. - -**PNF**. Physical Network Function. - -**Policy**. Course of action for the management of the network. The ONAP -Policy Framework is a comprehensive policy design, deployment, and -execution environment. The Policy Framework is the **decision making** -component in `an ONAP -system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__. -It allows you to specify, deploy, and execute the governance of the -features and functions in your ONAP system, be they closed loop, -orchestration, or more traditional open loop use case implementations. -The Policy Framework is the component that is the source of truth for -all policy decisions. - -**Reporting Entity Name**. Name of the entity reporting the event or -detecting a problem in another vnf/vm or pnf which is experiencing the -problem. May be the same as the sourceName. Not used for performance -measurements currently. - -**SDC**. Service Design and Creation Platform: The ONAP visual modeling -and design tool. It creates internal metadata that describes assets used -by all ONAP components, both at design time and run time. The SDC -manages the content of a catalog, and assemblies of selected catalog to -define how and when VNFs are realized in a target environment. - -**Source Name**: Name of the entity experiencing the event issue, which -may be detected and reported by a separate reporting entity. The -sourceName identifies the device for which data is collected. A valid -sourceName must be inventoried in A&AI. - -**Specific Problem**. Description of the alarm or problem. - -**VES**. Virtual Function Event Stream. In 6.0, the definition of VES -was expanded to include event streaming for VNF, PNF and infrastructure. -The VES Event Listener can receive any event sent in the VES Common -Event Format. - -**VES Event Listener**. A RESTful connectionless push event listener -capable of receiving single events or batches of events sent in the -Common Event Format. - -**VM**. Virtual Machine. - -**VNF**. Virtual Network Function. A VNF is a virtualized task formerly -carried out by proprietary, dedicated network hardware. (Examples: -virtual firewall, virtual DNS). A VNF can also be defined as a specific -kind of Vendor Software Product. - -**YAML**. A `data serialization -language <https://en.wikipedia.org/wiki/Data_serialization_language>`__ -and superset of JSON. - -**VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF. -It is a stand-alone executable that is loosely-coupled, granular, -re-usable, and responsible for a single capability. - -Appendix: Historical Change Log -=============================== - -For the latest changes, see the Change Block just before the Table of -Contents. - -+-----------------------+-----------------------+-----------------------+ -| Date | Revision | Description | -+-----------------------+-----------------------+-----------------------+ -| 5/22/2015 | 0.1 | Initial Release - | -| | | Draft | -+-----------------------+-----------------------+-----------------------+ -| 5/29/2015 | 0.2 | - Introduction: | -| | | removed all | -| | | system names | -| | | and references | -| | | to internal | -| | | AT&T components | -| | | | -| | | - Security: changed | -| | | ‘event | -| | | publisher’ to | -| | | ‘event source’ | -| | | | -| | | - Generic Event | -| | | Format: updated | -| | | the JSON schema | -| | | per the below: | -| | | | -| | | - eventHeader: | -| | | clarified the | -| | | description of | -| | | id, made | -| | | sourceId a | -| | | required field, | -| | | changed the | -| | | datatype of | -| | | timestamps to | -| | | timestamp [ ] | -| | | | -| | | - performanceFields: | -| | | removed | -| | | overflowFields | -| | | | -| | | - tmestamp: added a | -| | | description of | -| | | this datatype | -| | | | -| | | - Exceptions: fixed | -| | | indentation of | -| | | sections | -| | | | -| | | - Approvers: updated | -| | | the list of | -| | | approvers and | -| | | added attuids | -+-----------------------+-----------------------+-----------------------+ -| 6/3/2015 | 0.3 | - Updated the | -| | | security | -| | | section to use | -| | | HTTP Basic | -| | | Authentication | -| | | per AT&T REST | -| | | standards. | -| | | Updated the | -| | | input | -| | | parameters and | -| | | messaging | -| | | examples to use | -| | | the new | -| | | security | -| | | scheme. | -+-----------------------+-----------------------+-----------------------+ -| 6/5/2015 | 0.4 | - Added otherFields | -| | | sub section to | -| | | the defined | -| | | datatypes | -| | | | -| | | - Added locale field | -| | | to the | -| | | eventHeader. | -+-----------------------+-----------------------+-----------------------+ -| 6/5/2015 | 0.5 | - Updated the | -| | | embedded event | -| | | format json | -| | | schema to match | -| | | the changes | -| | | made in v0.4 | -+-----------------------+-----------------------+-----------------------+ -| 6/10/2015 | 0.6 | - Updated the | -| | | {ServerRoot} | -| | | format to | -| | | contain an | -| | | optional | -| | | routing path | -| | | (for D2 service | -| | | modules). | -+-----------------------+-----------------------+-----------------------+ -| 7/7/2015 | 0.7 | Common Event | -| | | Format updates: | -| | | | -| | | - EventHeader: added | -| | | ‘measurement’ | -| | | to the ‘domain’ | -| | | enumeration; | -| | | changed | -| | | ‘locale’ to | -| | | ‘location’ and | -| | | clarified in | -| | | the description | -| | | that this | -| | | should be a | -| | | clli code | -| | | | -| | | - Added a | -| | | MeasurementFiel | -| | | ds | -| | | datatype, which | -| | | required the | -| | | addition of the | -| | | following | -| | | datatypes: | -| | | codecsInUse, | -| | | cpuUsage, | -| | | diskUsage, | -| | | featuresInUse, | -| | | memoryUsage | -+-----------------------+-----------------------+-----------------------+ -| 7/15/2015 | 1.0 | - Changed | -| | | sourceInstance in | -| | | the eventHeader to | -| | | be an array of | -| | | name value pairs | -| | | | -| | | - Changed the | -| | | performanceFields | -| | | block to | -| | | thresholdCrossingA | -| | | lertFields. | -| | | Updated the domain | -| | | field of the | -| | | eventHeader to | -| | | match. | -+-----------------------+-----------------------+-----------------------+ -| 7/23/2015 | v1.1 | Changes to | -| | | eventHeader data | -| | | format: | -| | | | -| | | - moved | -| | | sourceInstance | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved | -| | | serviceInstance | -| | | Id | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved productId to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved subscriberId | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved location to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - added the | -| | | following new | -| | | fields in | -| | | internalHeaderF | -| | | ields: | -| | | policyType, | -| | | policyName, | -| | | correlationEven | -| | | tType, | -| | | correlationType | -| | | , | -| | | correlationName | -| | | , | -| | | correlationRoot | -| | | EventId | -| | | | -| | | - Changes to | -| | | faultFields | -| | | data format: | -| | | | -| | | - moved the | -| | | eventSourceDevi | -| | | ceDescription | -| | | to | -| | | internalFaultFi | -| | | elds | -| | | and renamed it | -| | | equipmentVendor | -| | | Model | -| | | | -| | | - moved | -| | | eventSourceHost | -| | | name | -| | | to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - changed | -| | | alarmObjectInte | -| | | rface | -| | | to | -| | | alarmInterfaceA | -| | | | -| | | - changed | -| | | alarmRemoteObje | -| | | ct | -| | | to | -| | | alarmRemoteObje | -| | | ctZ | -| | | and moved it to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - changed | -| | | alarmRemoteObje | -| | | ctInterface | -| | | to | -| | | alarmInterfaceZ | -| | | and moved it to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - Changes to | -| | | thresholdCrossi | -| | | ngFields | -| | | data format: | -| | | | -| | | - changed several | -| | | references from | -| | | the old | -| | | ‘performanceFie | -| | | lds’ | -| | | block to the | -| | | new | -| | | ‘thresholdCross | -| | | ingFields’ | -| | | block | -| | | | -| | | - Other: | -| | | | -| | | - Fixed several | -| | | comma and colon | -| | | syntax errors | -| | | in the JSON | -| | | schema as | -| | | detected by a | -| | | JSON schema | -| | | syntax checker. | -+-----------------------+-----------------------+-----------------------+ -| 8/11/2015 | v1.2 | Timestamp format: | -| | | | -| | | - Section 4.18: | -| | | added a note in | -| | | the datetime | -| | | field of the | -| | | Timestamp | -| | | datatype | -| | | specifying the | -| | | (GMT) format | -| | | required | -| | | | -| | | - Updated the JSON | -| | | schema with the | -| | | same | -| | | information | -| | | | -| | | .. | -| | | | -| | | Event Header | -| | | Severity | -| | | Enumeration: | -| | | | -| | | - Section 4.8: | -| | | modified the | -| | | severity | -| | | enumeration to | -| | | remove the | -| | | numbers in | -| | | parentheses | -| | | that followed | -| | | the names. The | -| | | names were not | -| | | changed. | -| | | | -| | | - Updated the JSON | -| | | schema with the | -| | | same | -| | | information. | -+-----------------------+-----------------------+-----------------------+ -| 8/20/2015 | v1.3 | JSON Schema rev’d to | -| | | v9: | -| | | | -| | | - Alphabetized all | -| | | fields in the | -| | | JSON schema | -| | | | -| | | - Fixed the way | -| | | arrays were | -| | | specified (JSON | -| | | schema syntax | -| | | issue) | -| | | | -| | | Sample Responses: | -| | | | -| | | - 2.1.1.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.2.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.3.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.4.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed eventList | -| | | array | -| | | depection, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -+-----------------------+-----------------------+-----------------------+ -| 9/16/2015 | v1.4 | JSON Schema rev’d to | -| | | v10: | -| | | | -| | | - Fixed an error in | -| | | the way that | -| | | the top level | -| | | “event” object | -| | | was specified | -| | | in the v9 json | -| | | schema. This | -| | | was discovered | -| | | when validating | -| | | examples | -| | | against the | -| | | schema using | -| | | this site: | -| | | http://json-sch | -| | | ema-validator.herokua | -| | | pp.com/index.jsp. | -| | | | -| | | - Changed the | -| | | embedded json | -| | | file in section | -| | | 4 | -| | | | -| | | Sample Responses: | -| | | | -| | | - Removed an extra | -| | | comma after the | -| | | timestamp brace | -| | | in section | -| | | 6.2.6 and | -| | | 6.3.6. | -+-----------------------+-----------------------+-----------------------+ -| 11/11/2015 | v1.5 | Section 4 was the | -| | | only section changed: | -| | | JSON Schema rev’d to | -| | | v11 and Datatype | -| | | tables were updated | -| | | to match. Numerous | -| | | data structure | -| | | changes were made | -| | | based on VNF vendor | -| | | proof of concept | -| | | feedback. Modified | -| | | sample requests and | -| | | responses to match. | -+-----------------------+-----------------------+-----------------------+ -| 11/12/2015 | v1.6 | - The | -| | | internalFaultFi | -| | | elds | -| | | were merged | -| | | into the | -| | | internalHeaderF | -| | | ields; | -| | | then the | -| | | internalFaultFi | -| | | elds | -| | | datatype was | -| | | deleted. | -| | | | -| | | - Updated the JSON | -| | | schema to v12. | -| | | | -| | | - Also corrected | -| | | some background | -| | | color issues in | -| | | the sample | -| | | requests and | -| | | responses. | -+-----------------------+-----------------------+-----------------------+ -| 1/18/2016 | v1.7 | - Section 2 changes: | -| | | updated the | -| | | sample request | -| | | to conform with | -| | | the changes | -| | | below | -| | | | -| | | - Section 4 datatype | -| | | changes: | -| | | | -| | | - Changed | -| | | 'eventHeader' | -| | | to | -| | | 'commonEventHea | -| | | der' | -| | | | -| | | - Moved | -| | | 'eventSeverity' | -| | | from the | -| | | 'commonEventHea | -| | | der' | -| | | to | -| | | 'faultFields' | -| | | | -| | | - Added 'priority' | -| | | to | -| | | 'commonEventHea | -| | | der' | -| | | | -| | | - moved 'vFstatus' | -| | | to | -| | | 'faultFields' | -| | | | -| | | - removed | -| | | 'firstDateTime' | -| | | and | -| | | 'lastDateTime' | -| | | and changed | -| | | 'firstEpoch' to | -| | | 'startEpochMicr | -| | | osec' | -| | | and changed | -| | | 'lastEpoch' to | -| | | 'lastEpochMicro | -| | | sec'. | -| | | | -| | | - Added | -| | | 'functionalRole | -| | | ' | -| | | to the | -| | | commonEventHead | -| | | er | -| | | | -| | | - In the | -| | | commonEventHead | -| | | er, | -| | | changed the | -| | | 'eventDomain' | -| | | enumeration to | -| | | remove | -| | | 'measurements' | -| | | and add | -| | | 'measurementsFo | -| | | rVfScaling'. | -| | | | -| | | - Changed the | -| | | 'measurementFie | -| | | lds' | -| | | to | -| | | 'measurementsFo | -| | | rVfScalingFields' | -| | | | -| | | - In the | -| | | commonEventHead | -| | | er, | -| | | changed the | -| | | following | -| | | fields: | -| | | | -| | | - 'eventDomain' to | -| | | 'domain' | -| | | | -| | | - 'eventSequence' to | -| | | 'sequence' | -| | | | -| | | - 'eventSourceId' to | -| | | 'sourceId' | -| | | | -| | | - 'eventSounceName' | -| | | to 'sourceName' | -| | | | -| | | - Updated the JSON | -| | | schema to v13 | -| | | | -| | | - Section 6 changes: | -| | | updated the | -| | | input | -| | | parameters and | -| | | sample requests | -| | | to conform to | -| | | the changes | -| | | above. | -| | | | -| | | - Section 7: changed | -| | | the section | -| | | from Approvers | -| | | to | -| | | Contributors. | -+-----------------------+-----------------------+-----------------------+ -| 1/22/2016 | v1.8 | - Section 4: Added | -| | | support for | -| | | ‘mobileFlow’ in | -| | | the | -| | | commonEventHead | -| | | er | -| | | ‘domain’ | -| | | enumeration. | -| | | Added the | -| | | mobileFlowField | -| | | s | -| | | datatype and | -| | | the | -| | | gtpPerFlowMetri | -| | | cs | -| | | datatype | -| | | referenced by | -| | | that datatype. | -| | | | -| | | - Section 7: | -| | | alphabetized | -| | | the | -| | | contributors | -+-----------------------+-----------------------+-----------------------+ -| 2/11/2016 | v1.9 | - Added section 1.3: | -| | | Naming Standard | -| | | for Event Types | -+-----------------------+-----------------------+-----------------------+ -| 2/12/2016 | v2.0 | - Updated request – | -| | | response | -| | | examples to | -| | | reflect the | -| | | naming | -| | | standards for | -| | | event types | -| | | introduced in | -| | | v1.9. | -| | | | -| | | - Added a paragraph | -| | | on use of Avro | -| | | as a transport | -| | | in section 1.4 | -+-----------------------+-----------------------+-----------------------+ -| 3/11/2016 | v2.1 | - Updated the | -| | | embedded JSON | -| | | schema to v15 | -| | | to fix a typo | -| | | in the required | -| | | fields for the | -| | | measurementsFor | -| | | VfScalingFields, | -| | | namely, changed | -| | | ‘configuredEnti | -| | | tes’ | -| | | to | -| | | ‘configuredEnti | -| | | ties’. | -| | | Additionally, | -| | | added an ‘Event | -| | | Listener’ title | -| | | block at the | -| | | bottom of the | -| | | file with a | -| | | single required | -| | | event object. | -+-----------------------+-----------------------+-----------------------+ -| 3/15/2016 | v2.2 | - Added | -| | | mobileFlowField | -| | | s | -| | | to the event | -| | | datatype | -| | | definition in | -| | | section 4.7 and | -| | | updated the | -| | | embedded json | -| | | schema at the | -| | | top of section | -| | | 4 to v16. | -+-----------------------+-----------------------+-----------------------+ -| 4/26/2016 | v2.3 | - Generic Event | -| | | Format updates: | -| | | 1) made | -| | | ‘priority’ | -| | | lowercase in | -| | | the Word doc | -| | | table for | -| | | commonEventHead | -| | | er; | -| | | 2) added | -| | | ‘requestError’ | -| | | data structure | -| | | to the Word doc | -| | | and JSON schema | -| | | (which is now | -| | | at v17) | -+-----------------------+-----------------------+-----------------------+ -| 4/27/2016 | v2.4 | - JSON Schema: In | -| | | the 'event' | -| | | data structure, | -| | | changed | -| | | 'thresholdCross | -| | | ingFields' | -| | | to | -| | | 'thresholdCross | -| | | ingAlertFields' | -| | | to product v18 | -| | | of the schema. | -| | | | -| | | - 'codecsInUse' data | -| | | structure: | -| | | changed | -| | | 'numberInUse' | -| | | to | -| | | 'codecUtilizati | -| | | on’ | -+-----------------------+-----------------------+-----------------------+ -| 5/26/2016 | v2.5 | - Changed responses | -| | | from ‘204 No | -| | | Content’ to | -| | | ‘202 Accepted’ | -| | | and added a | -| | | body to the | -| | | response that | -| | | enable AT&T to | -| | | throttle the | -| | | events being | -| | | sent and/or to | -| | | request the | -| | | current state | -| | | of throttling | -| | | at the event | -| | | source. | -| | | | -| | | - Added new | -| | | datatypes to | -| | | support the | -| | | above: | -| | | eventDomainThro | -| | | ttleSpecification, | -| | | eventDomainThro | -| | | ttleSpecificationList | -| | | , | -| | | eventThrottling | -| | | State, | -| | | suppressedNvPai | -| | | rs | -| | | | -| | | - Modifed the | -| | | commonEventForm | -| | | at | -| | | json schema to | -| | | v19 | -| | | | -| | | - Note: for the | -| | | VendorEventList | -| | | ener: | -| | | added new | -| | | licensing | -| | | language on the | -| | | back of the | -| | | title page; | -| | | added an | -| | | “attCopyrightNo | -| | | tice” | -| | | definition at | -| | | the top of the | -| | | commonEventForm | -| | | at_Vendors.json | -| | | file; also | -| | | removed all | -| | | references to | -| | | internalHeaderF | -| | | ields | -| | | from this file | -| | | and from the | -| | | VendorEventList | -| | | ener | -| | | spec. | -+-----------------------+-----------------------+-----------------------+ -| 8/9/2016 | v2.6 | - commonHeader: | -| | | added a note on | -| | | the description | -| | | of sourceId and | -| | | sourceName in | -| | | the | -| | | commonHeader: | -| | | "use | -| | | reportingEntity | -| | | for domains | -| | | that provide | -| | | more detailed | -| | | source info" | -| | | | -| | | - commonHeader: | -| | | deleted the | -| | | capacity, | -| | | measurementsFor | -| | | VfScaling | -| | | and usage | -| | | domains in the | -| | | domain | -| | | enumeration | -| | | | -| | | - commonHeader: | -| | | added the | -| | | following | -| | | domains to the | -| | | domain | -| | | enumeration: | -| | | licensingKci, | -| | | scalingKpi, | -| | | stateChange | -| | | | -| | | - event: removed | -| | | references to | -| | | capacityFields, | -| | | measurementsFor | -| | | VfScalingFields | -| | | and usageFields | -| | | and added | -| | | references to | -| | | licensingKciFie | -| | | lds, | -| | | scalingKpiField | -| | | s, | -| | | stateChangeFiel | -| | | ds | -| | | | -| | | - licensingKciFields | -| | | : | -| | | added this | -| | | section along | -| | | with | -| | | 'additionalMeas | -| | | urements', | -| | | which is an | -| | | optional list | -| | | of | -| | | measurementGrou | -| | | p | -| | | structures. | -| | | Changed the | -| | | name of | -| | | kciFieldsVersio | -| | | n | -| | | to | -| | | licensingKciFie | -| | | ldsVersion. | -| | | | -| | | - scalingKpiFields: | -| | | added this | -| | | section but | -| | | changed | -| | | measurementFiel | -| | | dsVersion | -| | | to | -| | | scalingKpiField | -| | | sVersion | -| | | | -| | | - stateChangeFields: | -| | | added this | -| | | section along | -| | | with | -| | | 'additionalFiel | -| | | ds', | -| | | which is an | -| | | optional list | -| | | of name-value | -| | | pairs. Other | -| | | fields included | -| | | newState and | -| | | oldState which | -| | | were | -| | | enumerations of | -| | | the following | -| | | possible | -| | | states: | -| | | 'inService', | -| | | 'maintenance', | -| | | 'outOfService' | -| | | | -| | | - sysLogFields: | -| | | added | -| | | 'additionalFiel | -| | | ds', | -| | | which is an | -| | | optional list | -| | | of name-value | -| | | pairs | -| | | | -| | | - vNicUsage: added | -| | | two required | -| | | fields to the | -| | | vNicUsage data | -| | | structure: | -| | | packetsIn and | -| | | packetsOut | -+-----------------------+-----------------------+-----------------------+ -| 8/10/2016 | v2.7 | - commonHeader: | -| | | removed the | -| | | note on the | -| | | description of | -| | | sourceId and | -| | | sourceName in | -| | | the | -| | | commonHeader: | -| | | "use | -| | | reportingEntity | -| | | for domains | -| | | that provide | -| | | more detailed | -| | | source info" | -| | | | -| | | - commonHeader: | -| | | added | -| | | measurementsFor | -| | | VfScaling | -| | | domain back and | -| | | removed the | -| | | licensingKci | -| | | and scalingKpi | -| | | domains | -| | | | -| | | - event: removed | -| | | references to | -| | | licensingKciFie | -| | | lds | -| | | and | -| | | scalingKpiField | -| | | s; | -| | | added | -| | | references to | -| | | measurementsFor | -| | | VfScalingFields | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | combined the | -| | | kciDetail and | -| | | kpiDetail | -| | | structures into | -| | | the | -| | | measurementsFor | -| | | VfScalingFields | -| | | structure; | -| | | referenced the | -| | | errors | -| | | structure | -| | | | -| | | - errors: added a | -| | | new structure | -| | | to capture the | -| | | receive and | -| | | transmit errors | -| | | for the | -| | | measurements | -| | | domain | -| | | | -| | | - removed the | -| | | following | -| | | structures: | -| | | kci, kpi, | -| | | scalingKpiField | -| | | s | -| | | and | -| | | licensingKciFie | -| | | lds | -| | | | -| | | - eventDomainThrottl | -| | | eSpecification: | -| | | updated the | -| | | reference to | -| | | commonEventHead | -| | | er | -| | | domain field | -| | | | -| | | - faultFields: | -| | | removed the | -| | | numbers from | -| | | the enumerated | -| | | strings for | -| | | eventSourceType | -| | | | -| | | - vNicUsage: made | -| | | the broadcast, | -| | | multicast and | -| | | unicast fields | -| | | optional | -| | | | -| | | - contributors: | -| | | updated Alok’s | -| | | organizational | -| | | area | -+-----------------------+-----------------------+-----------------------+ -| 8/12/2016 | v2.8 | - commonHeader: | -| | | copied the | -| | | descriptions of | -| | | sourceId and | -| | | sourceName from | -| | | the JSON schema | -| | | into the word | -| | | document | -| | | tables. | -| | | | -| | | - sample request | -| | | examples: moved | -| | | the | -| | | reportingEntity | -| | | Id | -| | | and | -| | | reportingEntity | -| | | Names | -| | | to the same | -| | | relative place | -| | | in all sample | -| | | requests in the | -| | | document | -| | | | -| | | - Fixed the sample | -| | | request shown | -| | | for | -| | | publishEventBat | -| | | ch | -| | | to take an | -| | | eventList as | -| | | input. | -| | | | -| | | - Fixed the sample | -| | | request shown | -| | | for | -| | | publishSpecific | -| | | Topic | -| | | to put the | -| | | topic in the | -| | | URL | -| | | | -| | | - errors: changed | -| | | the | -| | | receiveErrors | -| | | and | -| | | transmitErrors | -| | | fields to be | -| | | datatype number | -| | | | -| | | - codesInUse: | -| | | changed | -| | | 'codecUtilizati | -| | | on' | -| | | to | -| | | 'numberinUse' | -| | | | -| | | - vNicUsage: updated | -| | | the description | -| | | of the fields | -+-----------------------+-----------------------+-----------------------+ -| 8/27/2016 | v2.9 | - Added a note | -| | | "(currently: | -| | | 1.1)" in the | -| | | descriptions of | -| | | the following | -| | | fields: | -| | | commonEventHead | -| | | er:version, | -| | | faultFields:fau | -| | | ltFieldsVersion, | -| | | measurementsFor | -| | | VfScalingFields:measu | -| | | rementsForVfScalingFi | -| | | eldsVersion, | -| | | stateChangeFiel | -| | | ds:stateChangeFieldsV | -| | | ersion, | -| | | sysLogFields:sy | -| | | slogFieldsVersion, | -| | | thresholdCrossi | -| | | ngAlertFields:thresho | -| | | ldCrossingFieldsVersi | -| | | on | -| | | | -| | | - stateChangeFields: | -| | | made | -| | | stateInterface | -| | | mandatory | -| | | | -| | | - changed 'enum' to | -| | | 'enumeration' | -| | | throughout | -| | | section 4 of | -| | | the document | -| | | (note: this | -| | | can't be done | -| | | in the JSON | -| | | schema). | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | made the | -| | | following | -| | | fields | -| | | optional: | -| | | conurrentSessio | -| | | ns, | -| | | configuredEntit | -| | | ites, | -| | | cpuUsageArray, | -| | | fileSystemUsage | -| | | Array, | -| | | memoryConfigure | -| | | d, | -| | | memoryUsed, | -| | | requestRate, | -| | | vNicUsageArray | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | concurrentSessi | -| | | ons | -| | | and | -| | | configuredEntit | -| | | ies: | -| | | changed the | -| | | description to | -| | | support both | -| | | VMs and VNFs | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | : | -| | | clarified the | -| | | descriptions of | -| | | latencyDistribu | -| | | tion, | -| | | measurementInve | -| | | rval | -| | | and requestRate | -| | | | -| | | - syslogFields: | -| | | clarified the | -| | | descriptions of | -| | | syslogSData, | -| | | syslogTag, | -| | | syslogVer | -| | | | -| | | - thresholdCrossingA | -| | | lertFields: | -| | | made the | -| | | following | -| | | fields optional | -| | | and clarified | -| | | their | -| | | descriptions: | -| | | elementType, | -| | | networkService | -| | | | -| | | - command and | -| | | commandList: | -| | | created a list | -| | | of command | -| | | structures to | -| | | enable the | -| | | event collector | -| | | to request | -| | | changes of | -| | | event sources. | -| | | Commands | -| | | consist of a | -| | | commandType | -| | | along with | -| | | optional fields | -| | | (whose presence | -| | | is indicated by | -| | | the | -| | | commandType). | -| | | Three command | -| | | types are | -| | | currently | -| | | supported: | -| | | 'measurementInt | -| | | evalChange', | -| | | ‘provideThrottl | -| | | ingState’ | -| | | and | -| | | 'throttlingSpec | -| | | ification'. | -| | | | -| | | - eventDomainThrottl | -| | | eSpecificationList: | -| | | removed this | -| | | and replaced it | -| | | with | -| | | commandList. | -| | | | -| | | - Operations and | -| | | Sample | -| | | Requests: | -| | | modified the | -| | | operations and | -| | | samples to | -| | | support the new | -| | | command and | -| | | commandList | -| | | structures. | -+-----------------------+-----------------------+-----------------------+ -| 9/1/2016 | v2.10 | - measurementsForVfS | -| | | caling | -| | | block: made the | -| | | following | -| | | fields | -| | | optional: | -| | | latencyDistribu | -| | | tion | -| | | (which is an | -| | | array of | -| | | latencyBucketMe | -| | | asure | -| | | structures) and | -| | | meanRequestLate | -| | | ncy. | -| | | Updated the | -| | | JSON schemas | -| | | (now v24) to | -| | | match. | -+-----------------------+-----------------------+-----------------------+ -| 9/16/2016 | v2.11 | - 1 Introduction: | -| | | updated the | -| | | introduction to | -| | | clarify the | -| | | usage of | -| | | eventTypes and | -| | | the possibility | -| | | of support for | -| | | other | -| | | protocols. | -| | | | -| | | - 6.1 REST Operation | -| | | Overview: added | -| | | two new | -| | | subsections | -| | | (6.1.2 and | -| | | 6.1.3) | -| | | discussing Api | -| | | Version and | -| | | Commands Toward | -| | | Event Source | -| | | Clients. | -| | | | -| | | - 6.2 | -| | | publishAnyEvent | -| | | : | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.3 | -| | | publishSpecific | -| | | Topic: | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.4 | -| | | publishEventBat | -| | | ch: | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.5 | -| | | provideThrottli | -| | | ngState | -| | | operation: | -| | | added the Input | -| | | Parameters | -| | | section heading | -| | | back and fixed | -| | | the sample | -| | | request to | -| | | provide | -| | | eventThrottling | -| | | State | -| | | (instead of | -| | | eventThrottling | -| | | ClientState). | -| | | | -| | | - The remaining | -| | | bullets | -| | | describe | -| | | changes made to | -| | | section 4 | -| | | datatypes in | -| | | alphabetical | -| | | order: | -| | | | -| | | - command datatype: | -| | | referenced the | -| | | new section | -| | | 6.1.3 which | -| | | provides an | -| | | explanation of | -| | | command state | -| | | expectations | -| | | and | -| | | requirements | -| | | for a given | -| | | eventSource: | -| | | | -| | | - commonEventHeader | -| | | datatype: | -| | | | -| | | - made sourceId | -| | | and | -| | | reportingEnt | -| | | ityId | -| | | fields | -| | | optional | -| | | (although | -| | | the internal | -| | | Generic | -| | | Event | -| | | Listener | -| | | spec | -| | | indicates, | -| | | in the field | -| | | descriptions | -| | | , | -| | | that the | -| | | AT&T | -| | | enrichment | -| | | process | -| | | shall ensure | -| | | that these | -| | | fields are | -| | | populated) | -| | | | -| | | - domain | -| | | enumeration: | -| | | changed | -| | | measurements | -| | | ForVfScalingFields | -| | | to | -| | | measurements | -| | | ForVfScaling | -| | | | -| | | - eventDomainThrottl | -| | | eSpecificationList: | -| | | added this | -| | | array of | -| | | eventDomainThro | -| | | ttleSpecification | -| | | stuctures back | -| | | to the schema | -| | | because it is | -| | | used by the | -| | | provideThrottli | -| | | ngState | -| | | operation. | -| | | | -| | | - eventList: added | -| | | eventList back | -| | | to the vendor | -| | | version of the | -| | | commonEventForm | -| | | at. | -| | | This is used by | -| | | the | -| | | publishEventBat | -| | | ch | -| | | operation. | -| | | | -| | | - faultFields | -| | | datatype: | -| | | | -| | | - eventSourceType | -| | | : | -| | | made this a | -| | | string (and | -| | | provided the | -| | | previous | -| | | enumerated | -| | | values as | -| | | examples) | -| | | | -| | | - filesystemUsage | -| | | datatype: | -| | | | -| | | - changed | -| | | vmIdentifier | -| | | to | -| | | filesystemNa | -| | | me | -| | | | -| | | - gtpPerFlowMetrics | -| | | datatype: | -| | | | -| | | - flowActivationT | -| | | ime: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - flowDeactivatio | -| | | nTime: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - internalHeaderFiel | -| | | ds | -| | | datatype: | -| | | | -| | | - Added the | -| | | following | -| | | optional | -| | | fields: | -| | | firstDateTim | -| | | e, | -| | | lastDateTime | -| | | compliant | -| | | with RFC | -| | | 2822. Noted | -| | | in the | -| | | description | -| | | that these | -| | | fields must | -| | | be supplied | -| | | for events | -| | | in the | -| | | following | -| | | domains: | -| | | fault, | -| | | thresholdCro | -| | | ssingAlerts | -| | | and | -| | | measurements | -| | | ForVfScaling. | -| | | | -| | | - ticketingTimest | -| | | amp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - syslogFields | -| | | datatype: | -| | | | -| | | - eventSourceType | -| | | : | -| | | made this a | -| | | string (and | -| | | provided the | -| | | previous | -| | | enumerated | -| | | values, | -| | | without the | -| | | numbers, as | -| | | examples) | -| | | | -| | | - thresholdCrossingA | -| | | lerts | -| | | dataypte: | -| | | | -| | | - collectionTimes | -| | | tamp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - eventStartTimes | -| | | tamp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - added the same | -| | | eventSeverit | -| | | y | -| | | field as | -| | | from the | -| | | faultFields | -| | | and made it | -| | | required | -+-----------------------+-----------------------+-----------------------+ -| 9/23/2016 | v2.12 | - Section 4 | -| | | Datatypes: | -| | | commonEventHead | -| | | er: | -| | | made | -| | | reportingEntity | -| | | Name | -| | | a required | -| | | field (note: | -| | | the JSON schema | -| | | already had | -| | | this field as | -| | | required) | -+-----------------------+-----------------------+-----------------------+ -| 11/29/2016 | v3.0 | - Introduction: | -| | | | -| | | - Introductory | -| | | paragraph: | -| | | changed | -| | | '...Common | -| | | Event Header | -| | | Block | -| | | followed by | -| | | zero or more | -| | | event domain | -| | | blocks' to | -| | | '...Common | -| | | Event Header | -| | | Block | -| | | accompanied | -| | | by zero or | -| | | more event | -| | | domain | -| | | blocks' | -| | | since the | -| | | order of the | -| | | blocks on | -| | | the wire is | -| | | not | -| | | guaranteed. | -| | | | -| | | - Added Section | -| | | 1.5 | -| | | Versioning | -| | | | -| | | - Section 4: codec | -| | | processing: | -| | | | -| | | - CommonEventForm | -| | | at_Vendors | -| | | schema only: | -| | | codesInUse: | -| | | changed | -| | | required | -| | | field from | -| | | "codecUtiliz | -| | | ation" | -| | | which was | -| | | removed | -| | | previously | -| | | to | -| | | "numberInUse | -| | | " | -| | | which is the | -| | | new field | -| | | name. | -| | | | -| | | - added | -| | | ‘codecSelect | -| | | ed’ | -| | | datatype | -| | | | -| | | - added | -| | | ‘codecSelect | -| | | edTranscoding’ | -| | | datatype | -| | | | -| | | - Section 4 and | -| | | section 6: | -| | | command | -| | | processing: | -| | | | -| | | - Added | -| | | commandListE | -| | | ntry | -| | | which is an | -| | | object that | -| | | references | -| | | the command | -| | | object. | -| | | | -| | | - commandList: | -| | | changed | -| | | commandList | -| | | to contain | -| | | an array of | -| | | commandListE | -| | | ntry | -| | | objects. | -| | | | -| | | - Updated sample | -| | | responses in | -| | | section 6 | -| | | where | -| | | commands are | -| | | used | -| | | | -| | | - Section 4: | -| | | commonEventHead | -| | | er: | -| | | | -| | | - Incremented | -| | | version to | -| | | 1.2 | -| | | | -| | | - added two new | -| | | values to | -| | | the ‘domain’ | -| | | enumeration: | -| | | ‘serviceEven | -| | | ts’ | -| | | and | -| | | ‘signaling | -| | | | -| | | - Section 4: added | -| | | endOfCallVqmSum | -| | | maries | -| | | datatype | -| | | | -| | | - Section 4: | -| | | ‘event’: added | -| | | two fields: | -| | | ‘serviceEventsF | -| | | ields’ | -| | | and | -| | | ‘signalingField | -| | | s’ | -| | | | -| | | - Section 4: added | -| | | ‘eventInstanceI | -| | | dentifier’datatype | -| | | | -| | | - Section 4: | -| | | CommonEventList | -| | | ener | -| | | only: | -| | | internalHeaderF | -| | | ields: | -| | | | -| | | - added | -| | | ‘internalHea | -| | | derFieldsVersion’(ini | -| | | tially | -| | | set to 1.1) | -| | | | -| | | - added | -| | | ‘correlation | -| | | FirstEpoch’ | -| | | | -| | | - added | -| | | 'closedLoopC | -| | | ontrolName' | -| | | | -| | | - added | -| | | 'closedLoopF | -| | | lag' | -| | | | -| | | - added | -| | | 'collectorTi | -| | | meStamp' | -| | | | -| | | - added | -| | | 'eventTag' | -| | | | -| | | - added | -| | | ‘tenantName’ | -| | | | -| | | - changed | -| | | 'operational | -| | | Status' | -| | | to 'inMaint' | -| | | | -| | | - added required | -| | | fields in | -| | | the schema | -| | | to match the | -| | | word doc: | -| | | 'equipmentNa | -| | | meCode', | -| | | 'equipmentTy | -| | | pe', | -| | | 'equipmentVe | -| | | ndor', | -| | | 'inMaint', | -| | | 'provStatus' | -| | | | -| | | - Section 4: added | -| | | ‘marker’datatyp | -| | | e | -| | | | -| | | - Section 4: added | -| | | ‘midCallRtcp’ | -| | | datatype | -| | | | -| | | - Section 4: | -| | | mobileFlowField | -| | | s: | -| | | | -| | | - added | -| | | ‘mobileFlowF | -| | | ieldsVersion’(initial | -| | | ly | -| | | set to 1.1) | -| | | | -| | | - Section 4: added | -| | | ‘serviceEventsF | -| | | ields’datatype | -| | | | -| | | - Section 4: added | -| | | ‘signalingField | -| | | s’ | -| | | datatype | -| | | | -| | | - Section 4: | -| | | syslogFields: | -| | | | -| | | - Incremented | -| | | syslogFields | -| | | Version | -| | | to 1.2 | -| | | | -| | | - added | -| | | 'syslogPri' | -| | | | -| | | - added | -| | | 'syslogSev' | -| | | | -| | | - added | -| | | ‘syslogSdId’ | -| | | | -| | | - Section 4: | -| | | thresholdCrossi | -| | | ngAlertFields: | -| | | | -| | | - Incremented | -| | | thresholdCro | -| | | ssingFieldsVersion | -| | | to 1.2 | -| | | | -| | | - added | -| | | 'additionalF | -| | | ields' | -| | | which is an | -| | | optional | -| | | list of name | -| | | value pairs. | -| | | | -| | | - Section 4: schema | -| | | v26.0 embedded | -| | | reflecting the | -| | | above changes. | -| | | | -| | | - Section 6 and | -| | | Section 2: | -| | | changed all | -| | | sample requests | -| | | to use /v3 in | -| | | the REST | -| | | Resource URL. | -+-----------------------+-----------------------+-----------------------+ -| 12/1/2016 | v3.1 | - Section 6: Updated | -| | | the call flow | -| | | diagrams to | -| | | show ‘v3’ | -+-----------------------+-----------------------+-----------------------+ -| 1/5/2017 | v4.0 | - Combined the | -| | | Generic Event | -| | | Listener and | -| | | Vendor Event | -| | | Listener into a | -| | | single API | -| | | service | -| | | specification | -| | | with version | -| | | 4.0. | -| | | | -| | | - Changed the title | -| | | to VES (Virtual | -| | | Function Event | -| | | Streaming) | -| | | Listener. | -| | | | -| | | - Changed references | -| | | to 'generic | -| | | event' to | -| | | 'common event' | -| | | or 'VES event' | -| | | (depending on | -| | | the context) | -| | | throughout the | -| | | document. | -| | | | -| | | - Used the Legal | -| | | Disclaimer from | -| | | the Vendor | -| | | Event Listener | -| | | on the back of | -| | | the title page. | -| | | | -| | | - Section 1: | -| | | Introduction | -| | | changes: | -| | | | -| | | - modified | -| | | wording to | -| | | reference | -| | | 'VES' | -| | | | -| | | - removed the | -| | | 'Audience' | -| | | section, | -| | | which | -| | | described | -| | | various AT&T | -| | | groups the | -| | | documented | -| | | was intended | -| | | for | -| | | | -| | | - tweaked the | -| | | naming | -| | | standards | -| | | for event | -| | | types to | -| | | clarify the | -| | | purpose of | -| | | the naming | -| | | conventions | -| | | | -| | | - Section 3: | -| | | Resource | -| | | Structure: | -| | | added a | -| | | sentence | -| | | describing the | -| | | FQDN and port | -| | | used in the | -| | | resource URL. | -| | | | -| | | - Section 4: Common | -| | | Event Format | -| | | changes: | -| | | | -| | | - renamed the | -| | | section to | -| | | 'Common | -| | | Event | -| | | Format' from | -| | | 'Generic | -| | | Event | -| | | Format' | -| | | | -| | | - reorganized the | -| | | datatypes | -| | | into | -| | | separate | -| | | sections; | -| | | sections | -| | | were defined | -| | | for each of | -| | | the domains | -| | | as well as | -| | | for common | -| | | event, | -| | | common event | -| | | header and | -| | | command list | -| | | processing | -| | | | -| | | - codecSelected | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - codecSelectedTr | -| | | anscoding | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - command | -| | | datatype: | -| | | added an | -| | | enumerated | -| | | value to | -| | | commandType: | -| | | 'heartbeatIn | -| | | tervalChange' | -| | | | -| | | - commonEventHead | -| | | er: | -| | | added | -| | | internalHead | -| | | erFields | -| | | to the | -| | | commonEventH | -| | | eader, | -| | | defined as | -| | | "Fields (not | -| | | supplied by | -| | | event | -| | | sources) | -| | | that the VES | -| | | Event | -| | | Listener | -| | | service can | -| | | use to | -| | | enrich the | -| | | event if | -| | | needed for | -| | | efficient | -| | | internal | -| | | processing. | -| | | This is an | -| | | empty object | -| | | which is | -| | | intended to | -| | | be defined | -| | | separately | -| | | by each | -| | | provider | -| | | implementing | -| | | the VES | -| | | Event | -| | | Listener." | -| | | | -| | | - commonEventHead | -| | | er: | -| | | removed two | -| | | enumerated | -| | | values, | -| | | 'serviceEven | -| | | ts' | -| | | and | -| | | 'signaling' | -| | | from the | -| | | domain | -| | | enumeration | -| | | | -| | | - commonEventHead | -| | | er | -| | | version: | -| | | incremented | -| | | the version | -| | | to 2.0 | -| | | | -| | | - endOfCallVqmSum | -| | | maries | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - event: changed | -| | | the | -| | | description | -| | | of the event | -| | | datatype to: | -| | | "fields | -| | | which | -| | | constitute | -| | | the ‘root | -| | | level’ of | -| | | the common | -| | | event | -| | | format" | -| | | | -| | | - event: removed | -| | | 'serviceEven | -| | | tFields' | -| | | and | -| | | 'signalingFi | -| | | elds' | -| | | from the | -| | | definition | -| | | | -| | | - event: fixed a | -| | | misspelling | -| | | of | -| | | ‘thresholdCr | -| | | ossingAlertFields’, | -| | | which was | -| | | only present | -| | | in the Word | -| | | document | -| | | | -| | | - eventInstanceId | -| | | entifier | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - internalHeaderF | -| | | Ields | -| | | datatype: | -| | | defined this | -| | | as follows: | -| | | "The | -| | | internalHead | -| | | erFields | -| | | datatype is | -| | | an undefined | -| | | object which | -| | | can contain | -| | | arbitrarily | -| | | complex JSON | -| | | structures. | -| | | It is | -| | | intended to | -| | | be defined | -| | | separately | -| | | by each | -| | | provider | -| | | implementing | -| | | the VES | -| | | Event | -| | | Listener. | -| | | The fields | -| | | in | -| | | internalHead | -| | | erFields | -| | | are not | -| | | provided by | -| | | any event | -| | | source but | -| | | instead are | -| | | added by the | -| | | VES Event | -| | | Listener | -| | | service | -| | | itself as | -| | | part of an | -| | | event | -| | | enrichment | -| | | process | -| | | necessary | -| | | for | -| | | efficient | -| | | internal | -| | | processing | -| | | of events | -| | | received by | -| | | the VES | -| | | Event | -| | | Listener" | -| | | | -| | | - marker | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | datatype: | -| | | clarified | -| | | that | -| | | memoryConfig | -| | | ured | -| | | and | -| | | memoryUsed | -| | | are measured | -| | | in MB | -| | | | -| | | - midCallRtcp | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - mobileFlowField | -| | | s | -| | | datatype: | -| | | added | -| | | ‘additionalF | -| | | ields’ | -| | | | -| | | - mobileFlowField | -| | | s | -| | | datatype: | -| | | incremented | -| | | the version | -| | | number for | -| | | this field | -| | | block to 1.2 | -| | | | -| | | - serviceEventsFi | -| | | elds | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - signalingFields | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - syslogFields: | -| | | added three | -| | | fields to | -| | | the schema | -| | | that were | -| | | previously | -| | | described in | -| | | the document | -| | | but not | -| | | incorporated | -| | | into the | -| | | schema: | -| | | syslogPri, | -| | | syslogSev, | -| | | syslogSdId | -| | | | -| | | - syslogFields | -| | | version: | -| | | incremented | -| | | the version | -| | | to 2.0 | -| | | | -| | | - Modified the | -| | | Common Event | -| | | Format JSON | -| | | schema to v27.0 | -| | | to incorporate | -| | | the above | -| | | changes. Also, | -| | | added the AT&T | -| | | Copyright | -| | | Notice from the | -| | | top of the | -| | | retired | -| | | CommonEventForm | -| | | at_Vendors | -| | | schema. | -| | | | -| | | - Section 6 and 2: | -| | | changed all | -| | | sample requests | -| | | to use /v4 in | -| | | the REST | -| | | Resource URL | -| | | and call flow | -| | | diagrams. | -| | | | -| | | - Section 6.1.3: | -| | | added a row to the | -| | | table in this | -| | | section describing | -| | | the | -| | | ‘heartbeatInterval | -| | | Change’ | -| | | command. | -| | | | -| | | - Section 6.1.4: | -| | | added this new | -| | | section describing | -| | | expectations for | -| | | buffering of | -| | | events should all | -| | | REST resource URL | -| | | FQDNs be | -| | | unreachable. | -| | | | -| | | - Section 6 Sample | -| | | Requests: modified | -| | | all sample | -| | | requests showing | -| | | the return of a | -| | | commandList toward | -| | | the event source | -| | | to incorporate a | -| | | heartbeatIntervalC | -| | | hange | -| | | command; also | -| | | corrected the | -| | | spelling in the | -| | | samples for the | -| | | measurementInterva | -| | | lChange | -| | | command. | -| | | | -| | | - Section 7: | -| | | Contributors: | -| | | removed this | -| | | section | -+-----------------------+-----------------------+-----------------------+ -| 3/21/2017 | v4.1 | - JSON Schema | -| | | changes to produce | -| | | v27.2 (note: an | -| | | earlier draft | -| | | version of v27.1 | -| | | had been | -| | | distributed to a | -| | | few individuals): | -| | | | -| | | - To support use | -| | | of the schema | -| | | with event | -| | | batches, | -| | | removed the | -| | | following | -| | | statement near | -| | | the end of the | -| | | schema file: | -| | | | -| | | .. | -| | | | -| | | “required”: [ | -| | | “event” ] | -| | | | -| | | - Fixed the | -| | | characters used in | -| | | some of the quotes | -| | | | -| | | - Fixed some typos | -| | | in the | -| | | descriptions. | -| | | | -| | | - Removed the | -| | | booleans, which | -| | | were non-essential | -| | | and which were | -| | | causing problems | -| | | across different | -| | | implementations. | -| | | | -| | | - Section 4.5.7 | -| | | measurementsFor | -| | | VfScalingFields: | -| | | | -| | | - Fixed the | -| | | spelling of | -| | | measurements | -| | | ForVfScalingFields | -| | | in the Word | -| | | document | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses: | -| | | | -| | | - Removed quotes | -| | | from | -| | | numbers: | -| | | sequence, | -| | | and | -| | | first/lastEp | -| | | ochMicrosec. | -| | | | -| | | - Fixed all quote | -| | | characters, | -| | | some of | -| | | which were | -| | | using | -| | | unusual | -| | | symbols that | -| | | wouldn’t | -| | | validate | -| | | with the | -| | | json-schema | -| | | Python | -| | | package. | -| | | | -| | | - Section 6.2.6.1, | -| | | 6.3.6.1, | -| | | 6.4.6.1 sample | -| | | requests: | -| | | | -| | | - Added an | -| | | alarmAdditio | -| | | nalInformation | -| | | field array | -| | | to the | -| | | sample | -| | | requests. | -| | | | -| | | - Added missing | -| | | commas. | -| | | | -| | | - Section 6.5.6.1 | -| | | provideThrottli | -| | | ngState | -| | | sample | -| | | requests: | -| | | | -| | | - Fixed the | -| | | eventDomainT | -| | | hrottleSpecificationL | -| | | ist | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | eventDomainT | -| | | hrottleSpecification | -| | | objects. | -| | | | -| | | - Added missing | -| | | quotes. | -| | | | -| | | - Fixed the | -| | | suppressedNvPai | -| | | rsList | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | suppressedNvPai | -| | | rs | -| | | objects. | -+-----------------------+-----------------------+-----------------------+ -| 4/14/2017 | v5.0 | - Section 1 | -| | | Introduction: | -| | | | -| | | - Clarified the | -| | | Introduction | -| | | (Section 1). | -| | | | -| | | - Changed Section | -| | | 1.1 title from | -| | | ‘Terminology’ | -| | | to 'Event | -| | | Registration' | -| | | and referenced | -| | | the YAML event | -| | | registration | -| | | format, defined | -| | | in a separate | -| | | document. | -| | | | -| | | - Clarified | -| | | naming | -| | | standards for | -| | | eventName. | -| | | | -| | | - Section 3: updated | -| | | the REST | -| | | resource | -| | | structure | -| | | | -| | | - Section 4.1 | -| | | command list | -| | | processing | -| | | datatypes: | -| | | | -| | | - Got rid of | -| | | commandListE | -| | | ntry | -| | | and returned | -| | | commandList | -| | | to a simple | -| | | array of | -| | | commands. | -| | | | -| | | - Added | -| | | heartbeatInt | -| | | erval | -| | | to the | -| | | command | -| | | datatype. | -| | | | -| | | - Changed the | -| | | datatype of | -| | | measurementI | -| | | nterval | -| | | from number | -| | | to integer. | -| | | | -| | | - Section 4.2 common | -| | | event | -| | | datatypes: | -| | | | -| | | - event dataType: | -| | | Added | -| | | heartbeatFie | -| | | lds, | -| | | sipSignaling | -| | | Fields | -| | | and | -| | | voiceQuality | -| | | Fields | -| | | to the event | -| | | datatype as | -| | | optional | -| | | field blocks | -| | | | -| | | - Added | -| | | jsonObject | -| | | which | -| | | provides a | -| | | json object | -| | | schema, name | -| | | and other | -| | | meta-informa | -| | | tion | -| | | along with | -| | | one or more | -| | | object | -| | | instances. | -| | | | -| | | - Added | -| | | jsonObjectIn | -| | | stance | -| | | which | -| | | provides | -| | | meta-informa | -| | | tion | -| | | about an | -| | | instance of | -| | | a jsonObject | -| | | along with | -| | | the actual | -| | | object | -| | | instance | -| | | | -| | | - Added the ‘key’ | -| | | datatype | -| | | | -| | | - Added the | -| | | namedArrayOf | -| | | Fields | -| | | datatype | -| | | | -| | | - Added | -| | | vendorVnfNam | -| | | eFields | -| | | | -| | | - Section 4.3 common | -| | | event header | -| | | fields: | -| | | | -| | | - Add two new | -| | | enumerations | -| | | to domain: | -| | | ‘sipSignalin | -| | | g’ | -| | | and | -| | | ‘voiceQualit | -| | | y’ | -| | | | -| | | - Renamed | -| | | eventType to | -| | | eventName. | -| | | Note that | -| | | the original | -| | | usage of | -| | | eventType | -| | | was formally | -| | | described in | -| | | the | -| | | Introduction | -| | | back on | -| | | 2/11/2016 | -| | | with v1.9. | -| | | | -| | | - Made eventName | -| | | a required | -| | | field | -| | | | -| | | - Created a new | -| | | field called | -| | | eventType | -| | | with a | -| | | meaning that | -| | | is different | -| | | than the old | -| | | eventType. | -| | | | -| | | - Removed | -| | | functionalRo | -| | | le, | -| | | which was | -| | | replaced by | -| | | the | -| | | following | -| | | two fields. | -| | | | -| | | - Added | -| | | nfNamingCode | -| | | | -| | | - Added | -| | | nfcNamingCod | -| | | e | -| | | | -| | | - Changed version | -| | | to 3.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field | -| | | | -| | | - Section 4.4: | -| | | faultFields: | -| | | | -| | | - added one | -| | | optional | -| | | field: | -| | | eventCategor | -| | | y | -| | | | -| | | - made | -| | | faultFieldsV | -| | | ersion | -| | | a required | -| | | field | -| | | | -| | | - changed | -| | | faultFieldsV | -| | | ersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change) | -| | | | -| | | - fixed a typo on | -| | | the spelling | -| | | of | -| | | alarmInterfa | -| | | ceA | -| | | | -| | | - clarified field | -| | | descriptions | -| | | | -| | | - Section 4.5: added | -| | | heartbeatFields | -| | | datatype which | -| | | can be used to | -| | | communicate | -| | | heartbeatInterv | -| | | al. | -| | | Note: this | -| | | change was | -| | | previously made | -| | | in v4.2 | -| | | | -| | | - Section 4.6 | -| | | measurements | -| | | for vf scaling | -| | | datatypes: | -| | | changed the | -| | | following | -| | | datatypes from | -| | | number to | -| | | integer: | -| | | | -| | | - In | -| | | measurements | -| | | ForVfScalingFields: | -| | | concurrentSe | -| | | ssions, | -| | | configuredEn | -| | | tities, | -| | | numberOfMedi | -| | | aPortsInUse, | -| | | vnfcScalingM | -| | | etric | -| | | | -| | | - In codecsInUse: | -| | | numberInUse | -| | | | -| | | - In | -| | | featuresInUs | -| | | e: | -| | | featureUtili | -| | | zation | -| | | | -| | | - Section 4.6.2 | -| | | modified | -| | | cpuUsage | -| | | | -| | | - Section 4.6.3 | -| | | added diskUsage | -| | | | -| | | - Section 4.6.7 | -| | | measurementsFor | -| | | VfScalingFields: | -| | | | -| | | - fixed the | -| | | spelling of | -| | | the | -| | | measurements | -| | | ForVfScalingFields | -| | | in the Word | -| | | document | -| | | | -| | | - added | -| | | additionalFi | -| | | elds, | -| | | which is an | -| | | array of | -| | | fields | -| | | (i.e., | -| | | name-value | -| | | pairs) | -| | | | -| | | - changed | -| | | additionalMe | -| | | asurements | -| | | to reference | -| | | the common | -| | | datatype | -| | | namedArrayOf | -| | | Fields | -| | | (instead of | -| | | referencing | -| | | measurementG | -| | | roup) | -| | | | -| | | - added | -| | | additionalOb | -| | | jects | -| | | which is an | -| | | array of | -| | | jsonObjects | -| | | described by | -| | | name, keys | -| | | and schema | -| | | | -| | | - deleted | -| | | aggregateCpu | -| | | Usage | -| | | | -| | | - added | -| | | diskUsageArr | -| | | ay | -| | | | -| | | - deleted | -| | | measurementG | -| | | roup | -| | | (which was | -| | | replaced by | -| | | the common | -| | | datatype: | -| | | namedArrayOf | -| | | Fields | -| | | | -| | | - added | -| | | memoryUsageA | -| | | rray | -| | | | -| | | - deleted | -| | | memoryConfig | -| | | ured | -| | | and | -| | | memoryUsed | -| | | | -| | | - deleted errors | -| | | and | -| | | vNicUsageArr | -| | | ay | -| | | | -| | | - added | -| | | vNicPerforma | -| | | nceArray | -| | | | -| | | - changed the | -| | | measurements | -| | | ForVfScalingVersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field. Also | -| | | changed the | -| | | name of this | -| | | version | -| | | field in the | -| | | Word | -| | | document to | -| | | match that | -| | | in the JSON | -| | | schema. | -| | | | -| | | - Section 4.6.8 | -| | | added | -| | | memoryUsage | -| | | | -| | | - Section 4.6.9 | -| | | vNicPerformance | -| | | : | -| | | replaced | -| | | vNicUsage and | -| | | errors with | -| | | vNicPerformance | -| | | | -| | | - Section 4.7 mobile | -| | | flow fields | -| | | changes: | -| | | | -| | | - Made | -| | | mobileFlowFi | -| | | eldsVersion | -| | | a required | -| | | field and | -| | | changed the | -| | | mobileFlowFi | -| | | eldsVersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change). | -| | | | -| | | - Changed the | -| | | datatype of | -| | | flowActivati | -| | | onTime | -| | | and | -| | | flowDeactiva | -| | | tionTime | -| | | in the Word | -| | | doc to | -| | | string. | -| | | | -| | | - changed the | -| | | following | -| | | datatypes | -| | | from number | -| | | to integer: | -| | | otherEndpoin | -| | | tPort, | -| | | reportingEnd | -| | | pointPort, | -| | | samplingAlgo | -| | | rithm | -| | | | -| | | - Section 4.8: | -| | | otherFields: | -| | | | -| | | - Added | -| | | otherFieldsV | -| | | ersion | -| | | (set at 1.1) | -| | | | -| | | - Added | -| | | hashOfNameVa | -| | | luePairArrays | -| | | | -| | | - Added | -| | | jsonObjects | -| | | | -| | | - Added | -| | | nameValuePai | -| | | rs | -| | | | -| | | - Section 4.9: added | -| | | sipSignaling | -| | | domain | -| | | datatypes with | -| | | 4.8.1 | -| | | sipSignalingFie | -| | | lds. | -| | | sipSignalingFie | -| | | ldsVersion | -| | | is set at 1.0 | -| | | | -| | | - Section 4.10 | -| | | stateChangeFiel | -| | | ds: | -| | | made | -| | | stateChangeFiel | -| | | dsVersion | -| | | a required | -| | | field and set | -| | | it to 2.0 | -| | | (major version | -| | | change). | -| | | | -| | | - Section 4.11 | -| | | syslogFields: | -| | | | -| | | - Changed the | -| | | following | -| | | datatypes | -| | | from number | -| | | to integer: | -| | | syslogFacili | -| | | ty, | -| | | syslogPri | -| | | | -| | | - Changed | -| | | additionalFi | -| | | elds | -| | | from a field | -| | | [ ] to a | -| | | string which | -| | | takes | -| | | name=value | -| | | pairs | -| | | delimited by | -| | | a pipe | -| | | symbol. | -| | | | -| | | - Changed | -| | | syslogFields | -| | | Version | -| | | to 3.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field | -| | | | -| | | - Made syslogSev | -| | | an | -| | | enumerated | -| | | string | -| | | (previously | -| | | just a | -| | | string) | -| | | | -| | | - Section 4.12 | -| | | thresholdCrossi | -| | | ngAlertFields: | -| | | made | -| | | thresholdCrossi | -| | | ngFieldsVersion | -| | | a required | -| | | field and set | -| | | it to 2.0 | -| | | (major version | -| | | change). | -| | | | -| | | - Section 4.132: | -| | | added voice | -| | | quality domain | -| | | datatypes with | -| | | 4.13.1 | -| | | endOfCallVqmSum | -| | | maries | -| | | and 4.13.2 | -| | | voiceQualityFie | -| | | lds. | -| | | voiceQualityFie | -| | | ldsVersion | -| | | is set at 1.0 | -| | | | -| | | - JSON Schema: | -| | | changed the schema | -| | | to v28.0 and | -| | | incorporated all | -| | | of the changes | -| | | above. | -| | | | -| | | - Additional JSON | -| | | Schema changes | -| | | that are part of | -| | | v28: Note: The | -| | | following changes | -| | | are provided | -| | | relative to API | -| | | Spec v4.0 (which | -| | | embedded JSON | -| | | schema v27.0), but | -| | | they were also | -| | | made in an interim | -| | | release v4.1 | -| | | (which embedded | -| | | JSON schema | -| | | v27.2): | -| | | | -| | | - To support use | -| | | of the schema | -| | | with event | -| | | batches, | -| | | removed the | -| | | following | -| | | statement near | -| | | the end of the | -| | | schema file: | -| | | | -| | | .. | -| | | | -| | | “required”: [ | -| | | “event” ] | -| | | | -| | | - Fixed the | -| | | characters used in | -| | | some of the quotes | -| | | | -| | | - Fixed some typos | -| | | in the | -| | | descriptions. | -| | | | -| | | - Removed the | -| | | booleans, which | -| | | were non-essential | -| | | and which were | -| | | causing problems | -| | | across different | -| | | implementations. | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses | -| | | (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Removed quotes | -| | | from | -| | | numbers: | -| | | sequence, | -| | | and | -| | | first/lastEp | -| | | ochMicrosec. | -| | | | -| | | - Fixed all quote | -| | | characters, | -| | | some of | -| | | which were | -| | | using | -| | | unusual | -| | | symbols that | -| | | wouldn’t | -| | | validate | -| | | with the | -| | | json-schema | -| | | Python | -| | | package. | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses | -| | | (only in v5.0): | -| | | | -| | | - Changed the | -| | | version | -| | | numbers in | -| | | the URL | -| | | string. | -| | | | -| | | - Added | -| | | nfNamingCode | -| | | and | -| | | nfcNamingCod | -| | | e | -| | | and removed | -| | | functionalRo | -| | | le | -| | | | -| | | - Section 6 call | -| | | flows: updated | -| | | the version | -| | | number (only in | -| | | v5.0). | -| | | | -| | | - Section 6: removed | -| | | the | -| | | publishSpecific | -| | | Topic | -| | | operation | -| | | | -| | | - Section 6.1.4: | -| | | Buffering: | -| | | clarified event | -| | | source | -| | | expectations | -| | | for buffering | -| | | (only in v5.0). | -| | | | -| | | - Section 6.2.6.1, | -| | | 6.3.6.1 sample | -| | | requests (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Added an | -| | | alarmAdditio | -| | | nalInformation | -| | | field array | -| | | to the | -| | | sample | -| | | requests. | -| | | | -| | | - Added missing | -| | | commas. | -| | | | -| | | - Section 6.2.6.3, | -| | | 6.3.6.3 | -| | | commandList | -| | | sample | -| | | responses (only | -| | | in v5.0): | -| | | | -| | | - Fixed the | -| | | commandList | -| | | sample | -| | | responses to | -| | | pass an | -| | | array of | -| | | anonymous | -| | | command | -| | | objects | -| | | (rather than | -| | | an array of | -| | | commandListE | -| | | ntry | -| | | objects). | -| | | | -| | | - Fixed the | -| | | heartbeatInt | -| | | ervalChange | -| | | commandType | -| | | to pass a | -| | | heartbeatInt | -| | | erval | -| | | value | -| | | instead of a | -| | | measurementI | -| | | nterval | -| | | value. | -| | | | -| | | - Removed quotes | -| | | from the | -| | | measurementI | -| | | nterval | -| | | and | -| | | heartbeatInt | -| | | erval | -| | | values since | -| | | they are | -| | | numbers. | -| | | | -| | | - Section 6.4.6.1 | -| | | provideThrottli | -| | | ngState | -| | | sample requests | -| | | (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Fixed the | -| | | eventDomainT | -| | | hrottleSpecificationL | -| | | ist | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | eventDomainT | -| | | hrottleSpecification | -| | | objects. | -| | | | -| | | - Added missing | -| | | quotes. | -| | | | -| | | - Fixed the | -| | | suppressedNvPai | -| | | rsList | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | suppressedNvPai | -| | | rs | -| | | objects (also | -| | | incorporated in | -| | | interim release | -| | | 4.1). | -+-----------------------+-----------------------+-----------------------+ -| 5/22/2017 | v5.1 | - Footers: removed | -| | | proprietary | -| | | markings and | -| | | updated copyrights | -| | | to 2017 | -| | | | -| | | - Section 4.2.3: | -| | | field: | -| | | | -| | | - Changed the API | -| | | spec to make | -| | | ‘name’ and | -| | | ‘value’ start | -| | | with lowercase | -| | | letters. Note: | -| | | this did not | -| | | affect the | -| | | schema, which | -| | | already had | -| | | them as | -| | | lowercase. | -| | | | -| | | - JSON Schema: | -| | | | -| | | - measurementGrou | -| | | p: | -| | | deleted this | -| | | object since it | -| | | was replaced | -| | | with | -| | | ‘namedArrayOfFi | -| | | elds’ | -| | | in v28.0 and | -| | | was no longer | -| | | being used. | -| | | | -| | | - namedArrayOfFie | -| | | lds: | -| | | Fixed an error | -| | | in the | -| | | specification | -| | | of required | -| | | fields: from | -| | | ‘measurements’ | -| | | to | -| | | ‘arrayOfFields’ | -| | | . | -| | | | -| | | - Changed the | -| | | version of the | -| | | JSON schema to | -| | | 28.1 | -+-----------------------+-----------------------+-----------------------+ -| 6/14/2017 | v5.2 | - JSON Schema: | -| | | created v28.2 by | -| | | changing the field | -| | | descriptions in | -| | | the memoryUsage | -| | | object to refer to | -| | | ‘kibibytes’ | -| | | instead of | -| | | ‘kilobytes’. There | -| | | were no changes to | -| | | the 28.1 | -| | | structure. | -| | | | -| | | - Word Document: | -| | | measurementsForVfS | -| | | caling | -| | | Domain: | -| | | memoryUsage | -| | | object: changed | -| | | the field | -| | | descriptions in | -| | | this object to | -| | | refer to | -| | | ‘kibibytes’ | -| | | instead of | -| | | ‘kilobytes’. There | -| | | were no changes to | -| | | the memoryUsage | -| | | structure. | -| | | | -| | | - Reorganized the | -| | | Word document to | -| | | group the data | -| | | structures in | -| | | Section 4 into | -| | | three broad | -| | | categories to | -| | | better align with | -| | | the VNF Guidelines | -| | | documentation that | -| | | has been prepared | -| | | for vendors: | -| | | | -| | | - Common Event | -| | | Datatypes: | -| | | | -| | | - Command List | -| | | Processing | -| | | Datatypes | -| | | | -| | | - Common Event | -| | | Datatypes | -| | | | -| | | - Common Event | -| | | Header | -| | | Datatypes | -| | | | -| | | - Technology | -| | | Independent | -| | | Datatypes: | -| | | | -| | | - ‘Fault | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Heartbeat’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Measurement | -| | | s | -| | | For Vf | -| | | Scaling’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Other’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘State | -| | | Change’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Syslog’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Threshold | -| | | Crossing | -| | | Alert’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - Technology | -| | | Specify | -| | | Datatypes: | -| | | | -| | | - ‘Mobile | -| | | Flow’ Domain | -| | | Datatypes | -| | | | -| | | - ‘Sip | -| | | Signaling’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Voice | -| | | Quality’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - Section 6.1.3: | -| | | Commands Toward | -| | | Event Source | -| | | Clients: Added a | -| | | statement: “Note: | -| | | Vendors are not | -| | | currently required | -| | | to implement | -| | | support for | -| | | command | -| | | processing; in | -| | | addition, command | -| | | processing may be | -| | | supported by an | -| | | App-C interface in | -| | | future.” | -+-----------------------+-----------------------+-----------------------+ -| 6/22/2017 | v5.3 | - JSON Schema: | -| | | created v28.3 by | -| | | correcting an | -| | | error in the | -| | | sipSignalingFields | -| | | : | -| | | changed | -| | | vnfVendorNameField | -| | | s | -| | | to | -| | | vendorVnfNameField | -| | | s. | -| | | Embedded the new | -| | | schema at the top | -| | | of section 4. | -+-----------------------+-----------------------+-----------------------+ -| 9/12/2017 | v5.4 | - Note: There no | -| | | changes to any | -| | | data structures or | -| | | operations in this | -| | | version. | -| | | | -| | | - JSON Schema: | -| | | created v28.4 | -| | | embedded at the | -| | | top of section 4: | -| | | | -| | | - Added a | -| | | reference to | -| | | eventList in | -| | | the properties | -| | | defined under | -| | | the schema | -| | | title. This | -| | | enables the | -| | | schema to | -| | | correctly | -| | | validate event | -| | | batches in | -| | | addition to | -| | | just events. | -| | | | -| | | - Moved the | -| | | schema title to | -| | | the top of the | -| | | schema and | -| | | changed the | -| | | text from | -| | | “Event | -| | | Listener” to | -| | | “VES Event | -| | | Listener” | -| | | | -| | | - Added a schema | -| | | header block | -| | | under the title | -| | | to clearly | -| | | communicate the | -| | | schema version, | -| | | associated API | -| | | and | -| | | last-modified | -| | | information | -| | | | -| | | - Changed the date | -| | | in the copyright | -| | | notice to 2017 | -+-----------------------+-----------------------+-----------------------+ -| 9/19/2017 | v5.4.1 | - Note: There no | -| | | changes to any | -| | | data structures or | -| | | operations in this | -| | | version. | -| | | | -| | | - Back of Cover | -| | | Page: updated the | -| | | license and | -| | | copyright notice | -| | | to comply with | -| | | ONAP guidelines | -| | | | -| | | - JSON Schema: | -| | | updated the JSON | -| | | schema to v28.4.1: | -| | | updated the | -| | | copyright notice | -| | | and license to | -| | | comply with ONAP | -| | | guidelines | -+-----------------------+-----------------------+-----------------------+ -| 6/28/2018 | v6.0 | - Added contributors | -| | | to the title page. | -| | | | -| | | - Updated references | -| | | to ‘vnf’ ‘vnfc’ to | -| | | either ‘nf’ and | -| | | ‘nfc’ or ‘xNf’ and | -| | | ‘xNfc’ to | -| | | generalize support | -| | | across both vnfs | -| | | and pnfs. | -| | | | -| | | - Section 1: | -| | | | -| | | - clarified the | -| | | meaning of the | -| | | VES acronym | -| | | | -| | | - changed | -| | | references from | -| | | ASDC to SDC and | -| | | from MSO to SO | -| | | | -| | | - clarified the | -| | | requirements | -| | | for eventNames. | -| | | | -| | | - Added a section | -| | | of EventId use | -| | | case examples | -| | | | -| | | - Added a new | -| | | section on | -| | | measurement | -| | | expansion | -| | | fields | -| | | | -| | | - Added a new | -| | | section of | -| | | syslogs | -| | | | -| | | - clarified the | -| | | versioning | -| | | section and | -| | | referenced the | -| | | new API | -| | | Versioning | -| | | section in | -| | | section 6. | -| | | | -| | | - Added a list of | -| | | all the latest | -| | | field block | -| | | version numbers | -| | | in this version | -| | | of the API | -| | | spec. | -| | | | -| | | - Section 2: updated | -| | | the sample to show | -| | | use of new HTTP | -| | | versioning | -| | | headers. Added a | -| | | note indicating | -| | | that support for | -| | | mutual SSL would | -| | | be provided in | -| | | future. | -| | | | -| | | - Section 3: updated | -| | | the resource | -| | | structure remove | -| | | the | -| | | clientThrottlingSt | -| | | ate | -| | | resource. | -| | | | -| | | - Section 4: | -| | | hashMaps. Changed | -| | | all name-value | -| | | pair structures to | -| | | hashMaps causing | -| | | the following data | -| | | model and JSON | -| | | schema (to v29.0) | -| | | changes: | -| | | | -| | | - 4.1.1: Common | -| | | Event | -| | | Datatypes: | -| | | | -| | | - removed | -| | | "field" and | -| | | added | -| | | “hashMap” | -| | | | -| | | - removed | -| | | “namedArrayO | -| | | fFields” | -| | | and added | -| | | “namedHashMa | -| | | p” | -| | | | -| | | - added | -| | | arrayOfNamed | -| | | HashMap | -| | | | -| | | - added | -| | | arrayOfJsonO | -| | | bject | -| | | | -| | | - 4.2.1: Fault | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | faultFields | -| | | version to | -| | | 3.0 (major | -| | | change) | -| | | | -| | | - changed | -| | | faultFields. | -| | | alarmAdditionalInform | -| | | ation | -| | | to reference | -| | | a hashMap | -| | | | -| | | - 4.2.2: | -| | | Heartbeat | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | heartbeatFie | -| | | ldsVersion | -| | | to 2.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | heartbeatFie | -| | | lds.additionalFields | -| | | to reference | -| | | a hashMap | -| | | | -| | | - 4.2.3: | -| | | Measurement | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | measurementF | -| | | ieldsVersion | -| | | to 3.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | measurementF | -| | | ields.additionalField | -| | | s | -| | | to reference | -| | | a hashMap | -| | | | -| | | - changed | -| | | measurement. | -| | | additionalMesurements | -| | | to reference | -| | | a | -| | | namedHashMap | -| | | [ ] | -| | | | -| | | - modified | -| | | measurementF | -| | | ields.featureUsageArr | -| | | ay | -| | | to reference | -| | | a hashmap | -| | | and removed | -| | | ‘featuresInU | -| | | se’ | -| | | | -| | | - added the | -| | | following | -| | | datatypes | -| | | which are | -| | | now | -| | | referenced | -| | | as items in | -| | | arrays | -| | | within | -| | | measurementF | -| | | ields: | -| | | hugePages, | -| | | load, | -| | | machineCheck | -| | | Exception, | -| | | processStats | -| | | | -| | | - 4.2.5: Other | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - Change the | -| | | otherFieldsV | -| | | ersion | -| | | to 2.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | otherFields. | -| | | nameValuePairs | -| | | to reference | -| | | a hashMap | -| | | and renamed | -| | | it hashMap | -| | | | -| | | - changed | -| | | otherFields. | -| | | hashOfNameValuePairAr | -| | | rrays | -| | | to reference | -| | | a | -| | | namedHashMap | -| | | and renamed | -| | | it | -| | | arrayOfNamed | -| | | HashMap | -| | | | -| | | - 4.2.7: State | -| | | Change Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | stateChangeF | -| | | iledsVersion | -| | | to 3.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | stateChangeF | -| | | ields.additionalField | -| | | s | -| | | to reference | -| | | a hashMap | -| | | | -| | | - 4.2.9: | -| | | Threshold | -| | | Crossing Alert | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | thresholdCro | -| | | ssingAlertFieldsVersi | -| | | on | -| | | to 3.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | thresholdCro | -| | | ssingAlertFields.addi | -| | | tionalFields | -| | | to reference | -| | | a hashMap | -| | | | -| | | - counter: | -| | | removed name | -| | | and value | -| | | elements and | -| | | replaced | -| | | with a | -| | | hashMap | -| | | | -| | | - 4.3.1: Mobile | -| | | Flow Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | mobileFlowFi | -| | | eldsVersion | -| | | to 3.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | mobileFlowFi | -| | | elds.additionalFields | -| | | to reference | -| | | a hashMap | -| | | | -| | | - gtpPerFlowMe | -| | | trics: | -| | | modified | -| | | ipTosCountLi | -| | | st | -| | | to reference | -| | | hashmap | -| | | | -| | | - gtpPerFlowMe | -| | | trics: | -| | | modified | -| | | mobileQciCos | -| | | CountList | -| | | to reference | -| | | hashmap | -| | | | -| | | - gtpPerFlowMe | -| | | trics: | -| | | modified | -| | | tcpFlagCount | -| | | List | -| | | to reference | -| | | hashmap | -| | | | -| | | - 4.3.2: Sip | -| | | Signaling | -| | | Domain | -| | | Datatypes: | -| | | | -| | | - changed the | -| | | sigSignaling | -| | | FieldsVersion | -| | | to 2.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | sipSignaling | -| | | Fields.additionalInfo | -| | | rmation | -| | | to reference | -| | | a hashMap | -| | | | -| | | - 4.3.3: Voice | -| | | Quality Domain | -| | | Datatypes: | -| | | | -| | | - change the | -| | | voiceQuality | -| | | FieldsVersion | -| | | to 2.0 | -| | | (major | -| | | change) | -| | | | -| | | - changed | -| | | voiceQuality | -| | | Fields.additionalInfo | -| | | rmation | -| | | to reference | -| | | a hashMap | -| | | | -| | | - Section 4: added | -| | | notes at the top | -| | | of section 4 | -| | | clarifying | -| | | expectations and | -| | | requirements for | -| | | optional fields, | -| | | extensible fields | -| | | and keys sent | -| | | through extensible | -| | | fields. | -| | | | -| | | - Common Event Data | -| | | Types: Section | -| | | 4.1.1.9 Changed | -| | | vendorVnfNameField | -| | | s | -| | | to | -| | | vendorNfNameFields | -| | | ; | -| | | updated Section | -| | | 4.3.2 SipSignaling | -| | | and 4.3.3 Voice | -| | | Quality to refer | -| | | to the renamed | -| | | object | -| | | | -| | | - Common Event | -| | | Header Section | -| | | 4.1.2: | -| | | | -| | | - clarified the | -| | | descriptions of | -| | | eventId, | -| | | reportingEntity | -| | | Name, | -| | | sourceName and | -| | | startEpochMicro | -| | | seconds. | -| | | | -| | | - Added | -| | | ‘notification’ | -| | | and | -| | | ‘pngRegistratio | -| | | n’ | -| | | to the domain | -| | | enumeration. | -| | | | -| | | - added a new | -| | | timeZoneOffsest | -| | | field | -| | | | -| | | - Fault Domain | -| | | Section 4.2.1: | -| | | clarified the | -| | | definitions of | -| | | alarmCondition, | -| | | eventSeverity and | -| | | specificProblem | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3: changed the | -| | | name of this | -| | | domain from | -| | | ‘measurementsForVf | -| | | Scaling’ | -| | | to ‘measurement’ | -| | | | -| | | - measurementsFor | -| | | VfScaling | -| | | measurement | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | measurementFiel | -| | | ds | -| | | | -| | | - measurementsFor | -| | | VfScalingVersion | -| | | measurementFiel | -| | | dsVersion | -| | | | -| | | - the ‘mfvs’ | -| | | abbreviation | -| | | measurement | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3 cpuUsage: | -| | | added seven | -| | | optional fields to | -| | | this structure: | -| | | cpuCapacityContent | -| | | ion, | -| | | cpuDemandAvg, | -| | | cpuDemandMhz, | -| | | cpuDemandPct, | -| | | cpuLatencyAverage, | -| | | cpuOverheadAvg, | -| | | cpuSwapWaitTime | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3 diskUsage: | -| | | added ten optional | -| | | fields to this | -| | | structure: | -| | | diskBusResets, | -| | | diskCommandsAborte | -| | | d, | -| | | diskCommandsAvg, | -| | | diskFlushRequests, | -| | | diskFlushTime, | -| | | diskReadCommandsAv | -| | | g, | -| | | diskTime, | -| | | diskTotalReadLaten | -| | | cyAvg, | -| | | diskTotalWriteLate | -| | | ncyAvg, | -| | | diskWriteCommandsA | -| | | vg | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3: added a new | -| | | ‘ipmi’ datatype | -| | | along with | -| | | following | -| | | ‘supporting’ | -| | | datatypes: | -| | | ipmiBaseboardTempe | -| | | rature, | -| | | ipmiBaseboardVolta | -| | | geRegulator, | -| | | ipmiBattery, | -| | | ipmiFan, | -| | | ipmiGlobalAggregat | -| | | eTemperatureMargin, | -| | | ipmiHsbp, ipmiNic, | -| | | ipmiPowerSupply, | -| | | ipmiProcessor, | -| | | processorDimmAggre | -| | | gateThermalMargin | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3: added a new | -| | | ‘load’ datatype | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3 memoryUsage: | -| | | added eight | -| | | optional fields to | -| | | this structure: | -| | | memoryDemand, | -| | | memoryLatencyAvg, | -| | | memorySharedAvg, | -| | | memorySwapInAvg, | -| | | memorySwapInRateAv | -| | | g, | -| | | memorySwapOutAvg, | -| | | memorySwapOutRateA | -| | | vg, | -| | | memorySwapUsedAvg | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3: modified | -| | | measurementFields | -| | | to include the | -| | | following new | -| | | fields: | -| | | hugePagesArray, | -| | | ipmi, loadArray, | -| | | memoryErrors, | -| | | processStatusArray | -| | | , | -| | | rdtArray | -| | | | -| | | - Measurements | -| | | Domain Section | -| | | 4.2.3 renamed | -| | | vNicPerformance to | -| | | nicPerformance and | -| | | changed | -| | | vNicIdentifer to | -| | | nicIdentifier | -| | | | -| | | - Notification | -| | | Domain Section | -| | | 4.2.4: added | -| | | notificationFields | -| | | to support a new | -| | | notification | -| | | domain. | -| | | | -| | | - pnfRegistration | -| | | Domain Section | -| | | 4.2.7: added | -| | | pnfRegistrationFie | -| | | lds | -| | | to support a new | -| | | registration | -| | | domain. | -| | | | -| | | - sysLog Domain | -| | | Section 4.2.8: | -| | | added two new | -| | | fields: | -| | | syslogMsgHost and | -| | | syslogTs. | -| | | Clarified field | -| | | descriptions. | -| | | Clarified | -| | | syslogSData | -| | | example. | -| | | | -| | | - endOfCallVqmSummar | -| | | ies | -| | | Section 4.3.3.1: | -| | | | -| | | - converted | -| | | endpointJitter | -| | | into two | -| | | fields: | -| | | endpointAverage | -| | | Jitter | -| | | and | -| | | endpointMaxJitt | -| | | er | -| | | | -| | | - converted | -| | | localJitter | -| | | into two | -| | | fields: | -| | | localAverageJit | -| | | ter | -| | | and | -| | | localMaxJitter | -| | | | -| | | - added two | -| | | fields: | -| | | localAverageJit | -| | | terBufferDelay | -| | | and | -| | | localMaxJitterB | -| | | ufferDelay | -| | | | -| | | - added | -| | | endpointRtpOcte | -| | | tsLost | -| | | and | -| | | endpointRtpPack | -| | | etsLost | -| | | | -| | | - added | -| | | localRtpOctetsL | -| | | ost | -| | | and | -| | | localRtpPackets | -| | | Lost | -| | | | -| | | - converted | -| | | packetsLost | -| | | into | -| | | oneWayDelay | -| | | | -| | | - API Versioning: | -| | | | -| | | - Section 1.4: | -| | | clarified the | -| | | versioning | -| | | section and | -| | | linked it to | -| | | the following | -| | | new section | -| | | 6.1.2 | -| | | | -| | | - Section 6.1.2: | -| | | Added | -| | | requirements | -| | | for HTTP | -| | | headers | -| | | communicating | -| | | minor, patch | -| | | and latest | -| | | version | -| | | information. | -| | | | -| | | - Section 2 and 6 | -| | | sample | -| | | messages: | -| | | clarified | -| | | examples to use | -| | | the new HTTP | -| | | headers | -| | | | -| | | - Section 6.1.4: | -| | | Added a section | -| | | specifying message | -| | | size limits. | -| | | | -| | | - Section2 6.2.6.1 | -| | | and 6.3.6.1: | -| | | corrected | -| | | additionalInformat | -| | | ion | -| | | examples to use | -| | | hashMap instead of | -| | | name-value pair | -| | | fields. | -| | | | -| | | - Section 7: Added a | -| | | section on | -| | | Terminology. | -| | | | -| | | - Command List | -| | | Processing: | -| | | removed command | -| | | list processing | -| | | from the document | -| | | and schema: | -| | | | -| | | - Modified the | -| | | Section 3 | -| | | resource | -| | | structure to | -| | | align with | -| | | these changes. | -| | | | -| | | - Removed Section | -| | | 4 Datatypes: | -| | | command, | -| | | commandList, | -| | | eventDomainThro | -| | | ttleSpecification, | -| | | eventDomainThro | -| | | ttleSpecificationList | -| | | , | -| | | eventThrottling | -| | | State, | -| | | suppressedNvPai | -| | | rs | -| | | | -| | | - Removed Section | -| | | 6.1 description | -| | | of commands | -| | | toward event | -| | | source clients | -| | | | -| | | - Removed Section | -| | | 6.4 operation: | -| | | provideThrottlingS | -| | | tate | -+-----------------------+-----------------------+-----------------------+ -| 7/30/2018 | v7.0 | - General: | -| | | | -| | | - Fixed typos | -| | | throughout | -| | | | -| | | - Changed example | -| | | versions to v7 | -| | | | -| | | - Section1: | -| | | | -| | | - Clarified | -| | | casing and use | -| | | of dashes | -| | | versus colons | -| | | in eventName | -| | | examples | -| | | | -| | | - Updated all | -| | | field block | -| | | versions | -| | | | -| | | - Section 2: added a | -| | | note clarifying | -| | | that TLS 1.2 or | -| | | higher must be | -| | | used for HTTPS | -| | | connections. | -| | | | -| | | - Section 4 embedded | -| | | schema changed to | -| | | v30: | -| | | | -| | | - Added “ | -| | | ‘additionalProp | -| | | erties’: | -| | | false ” to | -| | | objects to | -| | | reject events | -| | | that attempt to | -| | | send properties | -| | | that are not | -| | | listed in the | -| | | ‘properties’ | -| | | keyword. Note: | -| | | does not affect | -| | | hashmap | -| | | extensible | -| | | fields. | -| | | | -| | | - Changed all | -| | | versions in all | -| | | field blocks | -| | | from number to | -| | | string enum | -| | | with the | -| | | version number | -| | | fixed by the | -| | | enum so the | -| | | schema can | -| | | validate events | -| | | that attempt to | -| | | send | -| | | non-standard | -| | | field blocks. | -| | | | -| | | - Changed syslog | -| | | additionalField | -| | | s | -| | | to a hashMap | -| | | | -| | | - Section 4: | -| | | | -| | | - Fixed section | -| | | heading numbers | -| | | that were the | -| | | same. | -| | | | -| | | - 4.1.1: | -| | | jsonObjectInsta | -| | | nce: | -| | | added an | -| | | optional | -| | | recursive | -| | | jsonObject and | -| | | removed all | -| | | required fields | -| | | from this | -| | | object | -| | | | -| | | - 4.1.2: | -| | | commonEventHead | -| | | er: | -| | | | -| | | - nfVendorName | -| | | : | -| | | added this | -| | | optional | -| | | field | -| | | | -| | | - timeZoneOffs | -| | | et: | -| | | changed from | -| | | number to | -| | | string with | -| | | a particular | -| | | format | -| | | specified | -| | | | -| | | - version was | -| | | changed from | -| | | number to | -| | | string (as | -| | | were all the | -| | | version | -| | | fields of | -| | | all the | -| | | field | -| | | blocks) | -| | | | -| | | - vesCommonEve | -| | | ntListenerVersion: | -| | | added this | -| | | required | -| | | field as a | -| | | string | -| | | enumeration | -| | | | -| | | - 4.2.3: | -| | | Measurements | -| | | Domain: | -| | | | -| | | - Added a note | -| | | clarifying | -| | | that NFs are | -| | | required to | -| | | report | -| | | exactly one | -| | | Measurement | -| | | event per | -| | | period per | -| | | sourceName | -| | | | -| | | - diskUsage: | -| | | added four | -| | | new optional | -| | | fields: | -| | | diskWeighted | -| | | IoTimeAve, | -| | | diskWeighted | -| | | IoTimeLast, | -| | | diskWeighted | -| | | IoTimeMax, | -| | | diskWeighted | -| | | IoTimeMin | -| | | | -| | | - memoryUsage: | -| | | add one new | -| | | optional | -| | | field: | -| | | percentMemor | -| | | yUsage | -| | | | -| | | - nicPerforman | -| | | ce: | -| | | added nine | -| | | new optional | -| | | fields: | -| | | administrati | -| | | veState, | -| | | operationalS | -| | | tate, | -| | | receivedPerc | -| | | entDiscard, | -| | | receivedPerc | -| | | entError, | -| | | receivedUtil | -| | | ization, | -| | | speed, | -| | | transmittedP | -| | | ercentDiscard, | -| | | transmittedP | -| | | ercentError, | -| | | transmittedU | -| | | tilization | -| | | | -| | | - processorDim | -| | | mAggregateThermalMarg | -| | | in: | -| | | make the | -| | | thermalMargi | -| | | n | -| | | field | -| | | required | -| | | | -| | | - 4.2.8: Syslog | -| | | Domain: | -| | | | -| | | - Corrected the | -| | | example at the end | -| | | of the section | -+-----------------------+-----------------------+-----------------------+ - -.. |image0| image:: media/image1.png - :width: 6.48926in - :height: 4.86694in -.. |image1| image:: media/image2.png - :width: 6.5in - :height: 4.8745in -.. |image2| image:: media/image3.png - :width: 3.76033in - :height: 1.16677in -.. |image3| image:: media/image5.png - :width: 4.75347in - :height: 2.57361in -.. |image4| image:: media/image6.png - :width: 4.74722in - :height: 2.56667in diff --git a/docs/files/VESEventRegistration.rst b/docs/files/VESEventRegistration.rst deleted file mode 100644 index ab5df84..0000000 --- a/docs/files/VESEventRegistration.rst +++ /dev/null @@ -1,1047 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -========================== -VES Event Registration 1.6 -========================== - -.. contents:: Table of Contents - -Introduction -============ - -This document specifies a YAML format for the registration of VES -Events. The YAML format enables both human designers and applications to -parse and understand the fields that will be sent by event sources in -conjunction with specific types of events, which are identified by their -eventNames. - -The semantics of the YAML format are easily extensible to accommodate -processing needs that may arise in the future. Among the types of -information specified in the YAML are field optionality, restrictions on -field values, and event handling recommendations and requirements. - -This document should be read in conjunction with the VES Event Listener -service specification, which defines the Common Event Format and -introduces the concept of specific types of events, identified by -eventNames. - -Audience --------- - -This document is intended to support the following groups: - -- VNF Vendors - -- Service Provider (e.g., AT&T) Teams responsible for deploying VNFs - within their infrastructure - -VNF vendors will provide a YAML file to the Service Provider that -describes the events that their VNFs generate. Using the semantics and -syntax supported by YAML, vendors will indicate specific conditions that -may arise, and recommend actions that should be taken at specific -thresholds, or if specific conditions repeat within a specified time -interval. - -Based on the vendor’s recommendations, the Service Provider may create -another YAML, which finalizes their engineering rules for the processing -of the vendor’s events. The Service Provider may alter the threshold -levels recommended by the vendor, and may modify and more clearly -specify actions that should be taken when specified conditions arise. -The Service Provided-created version of the YAML will be distributed to -Service Provider applications at design time. - -Goal ----- - -The goal of the YAML is to completely describe the processing of VNF -events in a way that can be compiled or interpreted by applications -across a Service Provider’s infrastructure, so that no additional human -configuration or development is required beyond the creation of the YAML -itself. - -Relation to the Common Event Format ------------------------------------ - -The Common Event Format described in the VES Event Listener service -specification defines the structure of VES events including optional -fields that may be provided. - -Specific eventNames registered by the YAML (e.g., an InvalidLicense -fault), may require that certain fields, which are optional in the -Common Event Format, be present when events with that eventName are -published. For example, a fault eventName which communicates an -‘InvalidLicense’ condition, may be registered to require that the -configured ‘licenseKey’ be provided as a name-value pair in the Common -Event Format’s ‘additionalFields’ structure, within the ‘faultFields’ -block. Anytime an ‘InvalidLicense’ fault event is detected, designers, -applications and microservices across the Service Provider’s -infrastructure can count on that name-value pair being present. - -The YAML registration may also restrict ranges or enumerations defined -in the Common Event Format. For example, eventSeverity is an enumerated -string within the Common Event Format with several values ranging from -‘NORMAL’ to ‘CRITICAL’. The YAML registration for a particular eventName -may require that it always be sent with eventSeverity set to a single -value (e.g., ‘MINOR’), or to a subset of the possible enumerated values -allowed by the Common Event Format (e.g., ‘MINOR’ or ‘NORMAL’). - -Relation to Service Design and Creation ---------------------------------------- - -Event registration for a VNF (or other event source) is provided to the -Service Provider’s Service Creation and Design Environment (e.g., SDC) -as a set of two YAML files consisting of the vendor recommendation YAML -and (optionally) the final Service Provider YAML. These YAML files -describe all the eventNames that that VNF (or other event source) -generates. - -Once their events are registered, the Service Creation and Design -Environment can then list the registered eventNames (e.g., as a drop -down list), for each VNF or other event source (e.g., a service), and -enable designers to study the YAML registrations for specific -eventNames. The YAMLs provide the information that the designers need to -develop and understand policies, work flows and microservices that are -triggered by those events. YAML registrations are both human readable -and machine readable. - -The final Service Provider YAML is a type of Service Design and Creation -‘artifact’, which is distributed to Service Provider applications at -design time: notably, to applications involved in the collection and -processing of VNF events. It is parsed by those applications so they can -automatically support the receipt and processing of VNF events, without -the need for any manual, VNF-specific development. - -YAML Files -========== - -YAML Specification Conformance ------------------------------- - -YAML files should conform to version 1.2 of the YAML specification -available at: http://yaml.org/spec/1.2/spec.html. - -Filename --------- - -YAML file names should conform to the following naming convention: - - {sdcModel}\_{sdcModelType}\_{v#}.yml - -The ‘#’ should be replaced with the current numbered version of the -file. - -‘SDC’ is a reference to the Service Provider’s Service Design and -Creation environment. The sdcModelType is an enumeration with several -values of which the following three are potentially relevant: - -- Service - -- VNF - -- VfModule - -The sdcModel is the modelName of the specific modelType whose events -are being registered (e.g., the name of the specific VNF or service as -it appears in the the Service Design and Creation Environment). - -For example: - -- vMRF\_Vnf\_v1.yml - -- vMRF\_Service\_v1.yml - -- vIsbcSsc\_VfModule\_v1.yml - -File Structure --------------- - -Each eventType is registered as a distinct YAML ‘document’. - -YAML files consist of a series of YAML documents delimited by ‘---‘ and -‘…’ for example: - -:: - - --- - - # Event Registration for eventName ‘name1’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name2’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name3’ - - # details omitted - - ... - -YAML Syntax and Semantics -========================= - -YAML registration documents show each relevant VES Common Event Model -object and field (i.e., each element) for the eventName being -registered, including any extensible fields (e.g., specific name-value -pairs). - -Qualifiers ----------- - -Each object or field name in the eventName being registered is followed -by a ‘qualifier’, which consists of a colon and two curly braces, for -example: - - “objectOrFieldName: { }” - -The curly braces contain meta-information about that object or field -name (also known as the ‘element’), such as whether it is required to be -present, what values it may have, what handling it should trigger, etc… - -Semantics have been defined for the following types of meta-information -within the curly braces: - -Action -~~~~~~ - -The ‘action’ keyword may be applied to field values or to the event as a -whole. The ‘action’ keyword specifies a set of actions that should be -taken if a specified trigger occurs. For example, the ‘action’ keyword -may specify that a threshold crossing alert (i.e., tca) be generated, -and/or that a specific microservice handler be invoked, and/or that a -specific named-condition be asserted. In the Rules section of the YAML -file, tca’s and microservices may be defined on individual -named-conditions or on logical combinations of named-conditions. - -The ‘action:’ keyword is followed by five values in square brackets. The -first two values communicate the trigger, and the last three values -communicate the actions to be taken if that trigger occurs: - -1. The first value conveys the trigger level. If the field on which the - action is defined reaches or passes through that level, then the - trigger fires. If a specific level is not important to the - recommended action, the ‘any’ keyword may be used as the first value. - (Note: ‘any’ is often used when an action is defined on the ‘event’ - structure as a whole). - -2. The second value indicates the direction of traversal of the level - specified in the first value. The second value may be ‘up’, ‘down’, - ‘at’ or ‘any’. ‘any’ is used if the direction of traversal is not - important. ‘at’ implies that it traversed (or exactly attained) the - trigger level but it doesn’t matter if the traversal was in the up - direction or down direction. Note: If ‘up’, ‘down’ or ‘at’ are used, - the implication is that the microservices processing the events - within the service provider are maintaining state (e.g., to know that - a measurement field traversed a trigger level in an ‘up’ direction, - the microservice would have to know that the field was previously - below the trigger level). When initially implementing support for - YAML actions, a service provider may choose to use and interpret - these keywords in a simpler way to eliminate the need to handle - state. Specifically, they may choose to define and interpret all ‘up’ - guidance to mean ‘at the indicated trigger level or greater’, and - they may choose to define and interpret all ‘down’ guidance to mean - ‘at the indicated trigger level or lower’. - -3. The third value optionally names the condition that has been attained - when the triggers fires (e.g., ‘invalidLicence’ or - ‘capacityExhaustion’). Named-conditions should be expressed in upper - camel case with no underscores, hyphens or spaces. In the Rules - section of the YAML file, named-conditions may be used to specify - tca’s that should be generated and/or microservices that should be - invoked. If it is not important to name a condition, then the keyword - ‘null’ may be used as the third value. - -4. The fourth value recommends a specific microservice (e.g., ‘rebootVm’ - or ‘rebuildVnf’) supported by the Service Provider, be invoked if the - trigger is attained. Design time processing of the YAML by the - service provider can use these directives to automatically establish - policies and configure flows that need to be in place to support the - recommended runtime behavior. - - If a vendor wants to recommend an action, it can either work with - the service provider to identify and specify microservices that the - service provider support, or, the vendor may simply indicate and - recommend a generic microservice function by prefixing ‘RECO-’ in - front of the microservice name, which should be expressed in upper - camel case with no underscores, hyphens or spaces. - - The fourth value may also be set to ‘null’. - -1. The fifth value third value indicates a specific threshold crossing - alert (i.e., tca) that should be generated if the trigger occurs. - This field may be omitted or provided as ‘null’. - - Tca’s should be indicated by their eventNames. - - When a tca is specified, a YAML registration for that tca eventName - should be added to the event registrations within the YAML file. - -Examples: - -- event: { action: [ any, any, null, rebootVm ] } - - # whenever the above event occurs, the VM should be rebooted - -- fieldname: { action: [ 80, up, null, null, tcaUpEventName ], action: - [ 60, down, overcapacity, null ] } - - # when the value of fieldname crosses 80 in an up direction, - tcaUpEventName - - should be published; if the fieldname crosses 60 in a down direction - an - - ‘overCapacity’ named-condition is asserted. - -Array -~~~~~ - -The ‘array’ keyword indicates that the element is an array; ‘array:’ is -following by square brackets which contain the elements of the array. -Note that unlike JSON itself, the YAML registration will explicitly -declare the array elements and will not communicate them anonymously. - -Examples: - -- element: { array: [ - - firstArrayElement: { }, - - secondArrayElement: { } - - ] } - -Default -~~~~~~~ - -The ‘default’ keyword specifies a default field value. Note: the default -value must be within the range or enumeration of acceptable values. - -Examples: - -- fieldname: { range: [ 1, unbounded ], default: 5 } - -- fieldname: { value: [ red, white, blue ], default: blue } - -HeartbeatAction -~~~~~~~~~~~~~~~ - -The ‘heartbeatAction’ keyword is provided on the ‘event’ objectName for -heartbeat events only. It provides design time guidance to the service -provider’s heartbeat processing applications (i.e., their watchdog -timers). The syntax and semantics of the ‘heartbeatAction’ keyword are -similar to the ‘action’ keyword except the trigger is specified by the -first field only instead of the first two fields. When the -‘heartbeatAction’ keyword is indicated, the first field is an integer -indicating the number of successively missed heartbeat events. Should -that trigger occur, the remaining fields have the same order, meaning -and optionality as those described for the ‘action’ keyword. - -Examples: - -- event: { heartbeatAction: [ 3, vnfDown, RECO-rebootVnf, tcaEventName - ] } - - # whenever the above event occurs, a vnfDown condition is asserted - and the VNF should be rebooted, plus the indicated tca should be - generated. - -Presence -~~~~~~~~ - -The ‘presence’ keyword may be defined as ‘required’ or ‘optional’. If -not provided, the element is assumed to be ‘optional’. - -Examples - -- element: { presence: required } # element must be present - -- element: { presence: optional } # element is optional - -- element: { value: blue } # by omitting a presence definition, the element is assumed to be optional - -Range -~~~~~ - -The ‘range’ keyword applies to fields (i.e., simpleTypes); indicates the -value of the field is a number within a specified range of values from -low to high (inclusive of the indicated values). . ‘range:’ is followed -by two parameters in square brackets: - -- the first parameter conveys the minimum value - -- the second parameter conveys the maximum value or ‘unbounded’ - -The keyword ‘unbounded’ is supported to convey an unbounded upper limit. -Note that the range cannot override any restrictions defined in the VES -Common Event Format. - -Examples: - -- fieldname: { range: [ 1, unbounded ] } - -- fieldname: { range: [ 0, 3.14 ] } - -Structure -~~~~~~~~~ - -The ‘structure’ keyword indicates that the element is a complexType -(i.e., an object) and is followed by curly braces containing that -object. - -Example: - -- objectName: { structure: { - element1: { }, - element2: { }, - anotherObject: { structure: { - element3: { }, - element4: { } - } } - } } - -Units -~~~~~ - -The ‘units’ qualifier may be applied to values provided in VES Common -Event Format extensible field structures. The ‘units’ qualifier -communicates the units (e.g., megabytes, seconds, Hz) that the value is -expressed in. Note: the ‘units’ should not contain any space characters -(e.g., use ‘numberOfPorts’ or ‘number\_of\_ports’ but not ‘number of -ports’). - -Example: - -- field: { structure: { - - name: { value: pilotNumberPoolSize }, - - value: { units: megabytes } # the value will be expressed in - megabytes - - } } - -Value -~~~~~ - -The ‘value’ keyword applies to fields (i.e., simpleTypes); indicates a -single value or an enumeration of possible values. If not provided, it -is assumed the value will be determined at runtime. Note that the -declared value cannot be inconsistent with restrictions defined in the -VES Common Event Format (e.g., it cannot add an enumerated value to an -enumeration defined in the Common Event Format, but it can subset the -defined enumerations in the Common Event Format). - -Values that are strings containing spaces should always be indicated in -single quotes. - -Examples: - -- fieldname: { value: x } # the value is ‘x’ - -- fieldname: { value: [ x, y, z ] } # the value is either ‘x’, ‘y’, or - ‘z’ - -- fieldname: { presence: required } # the value will be provided at - runtime - -- fieldname: { value: ‘error state’ } # the value is the string within - the single quotes - -Rules ------ - -Rules Document -~~~~~~~~~~~~~~ - -After all events have been defined, the YAML file may conclude with a -final YAML document delimited by ‘---‘ and ‘…’, which defines rules -based on the named ‘conditions’ asserted in action qualifiers in the -preceding event definitions. For example: - -:: - - --- - - # Event Registration for eventName ‘name1’ - - event: {presence: required, action: [any, any, A, null], structure: - { - - # details omitted - - }} - - ... - - --- - - # Event Registration for eventName ‘name2’ - event: {presence: required, structure: { - commonEventHeader: {presence: required, structure: { - # details omitted - }} - - measurementsForVfScalingFields: {presence: required, structure: { - cpuUsageArray: {presence: required, array: { - cpuUsage: {presence: required, structure: { - cpuIdentifier: {presence: required}, - percentUsage: {presence: required, action: [90, up, B, null]} - }} - }}, - # details omitted - }} - }} - ... - - --- - - # Rules - rules: [ - - # defined based on conditions ‘A’ and ‘B’ - details omitted - - ] - - ... - -Rules Syntax and Semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a -colon and square brackets. Each rule is then defined within the square -brackets. Commas are used to separate rules. - -Each rule is expressed as follows:: - - rule: { - trigger: *logical expression in terms of conditions*, - microservices: [ *microservice1, microservice2, microservice3…* ] - alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ], - } - -Notes: - -- All referenced tcaEventNames should be defined within the YAML. - -- For information about microservices, see section 3.1.1 bullet number - 4. - -- At least one microservice or alert should be specified, and both - microservices and alerts may be specified. - -Simple Triggers -~~~~~~~~~~~~~~~ - -The trigger is based on the named ‘conditions’ asserted in the action -qualifiers within the event definitions earlier in the YAML file. The -following logical operators are supported: - -- &: which is a logical AND - -- \|\|, which is a logical OR - -In addition parentheses may be used to group expressions. - -Example logical expression: - - (A & B) \|\| (C & D) - -Where A, B, C and D are named conditions expressed earlier in the YAML -file. - -Example rules definition:: - - rules: [ - rule: { - trigger: A, - alerts: [tcaEventName1], - microservices: [rebootVm] - }, - rule: { - trigger: B \|\| (C & D), - microservices: [scaleOut] - } - ] - -Note: when microservices are defined in terms of multiple event -conditions, the designer should take care to consider whether the target -of the microservice is clear (e.g., which VNF or VM instance to perform -the action on). Future versions of this document may provide more -clarity. - -Time Based Qualifiers -~~~~~~~~~~~~~~~~~~~~~ - -Time based rules may be established by following any named condition -with a colon and curly braces. The time based rule is placed in the -curly braces as follows: - -:: - - trigger: B:{3 times in 300 seconds} - -This means that if condition B occurs 3 (or more) times in 300 seconds -(e.g., 5 minutes), the trigger fires. - -More complex triggers can be created as follows: - -:: - - trigger: B:{3 times in 300 seconds} \|\| (C & D:{2 times in 600 seconds}), - -This means that the trigger fires if condition B occurs 3 (or more) -times in 5 minutes, OR, if condition D occurs 2 (or more) times in 10 -minutes AND condition C is in effect. - -YAML Examples -============= - -An example YAML file is provided below which registers some events for a -vMRF VNF. Note: some of the lines have been manually wrapped/indented to -make it easier to read. - -:: - - --- - # registration for Fault\_vMrf\_alarm003 - # Constants: the values of domain, eventName, priority, vfstatus - # , version, alarmCondition, eventSeverity, eventSourceType, - # faultFieldsVersion, specificProblem, - # Variables (to be supplied at runtime) include: eventId, - lastEpochMicrosec, - - # reportingEntityId, reportingEntityName, sequence, sourceId, sourceName, - # startEpochMicrosec - - event: {presence: required, action: [ any, any, alarm003,RECO-rebuildVnf ], - structure: { - commonEventHeader: {presence: required, structure: { - domain: {presence: required, value: fault}, - eventName: {presence: required, value: Fault\_vMrf\_alarm003}, - eventId: {presence: required}, - nfNamingCode: {value: mrfx}, - priority: {presence: required, value: Medium}, - reportingEntityId: {presence: required}, - reportingEntityName: {presence: required}, - sequence: {presence: required}, - sourceId: {presence: required}, - sourceName: {presence: required}, - startEpochMicrosec: {presence: required}, - lastEpochMicrosec: {presence: required}, - version: {presence: required, value: 3.0} - }}, - faultFields: {presence: required, structure: { - alarmCondition: {presence: required, value: alarm003}, - eventSeverity: {presence: required, value: MAJOR}, - eventSourceType: {presence: required, value: virtualNetworkFunction}, - faultFieldsVersion: {presence: required, value: 2.0}, - specificProblem: {presence: required, value: "Configuration file was - corrupt or not present"}, - vfStatus: {presence: required, value: "Requesting Termination"} - }} - }} - - ... - - --- - # registration for clearing Fault\_vMrf\_alarm003Cleared - # Constants: the values of domain, eventName, priority, - # , version, alarmCondition, eventSeverity, eventSourceType, - # faultFieldsVersion, specificProblem, - # Variables (to be supplied at runtime) include: eventId,lastEpochMicrosec, - # reportingEntityId, reportingEntityName, sequence, sourceId, - # sourceName, startEpochMicrosec, vfStatus - event: {presence: required, action: [ any, any, alarm003, Clear ], structure: { - commonEventHeader: {presence: required, structure: { - domain: {presence: required, value: fault}, - eventName: {presence: required, value: Fault\_vMrf\_alarm003Cleared}, - eventId: {presence: required}, - nfNamingCode: {value: mrfx}, - priority: {presence: required, value: Medium}, - reportingEntityId: {presence: required}, - reportingEntityName: {presence: required}, - sequence: {presence: required}, - sourceId: {presence: required}, - sourceName: {presence: required}, - startEpochMicrosec: {presence: required}, - lastEpochMicrosec: {presence: required}, - version: {presence: required, value: 3.0} - }}, - faultFields: {presence: required, structure: { - alarmCondition: {presence: required, value: alarm003}, - eventSeverity: {presence: required, value: NORMAL}, - eventSourceType: {presence: required, value: virtualNetworkFunction}, - faultFieldsVersion: {presence: required, value: 2.0}, - specificProblem: {presence: required, value: "Valid configuration file found"}, - vfStatus: {presence: required, value: "Requesting Termination"} - }} - }} - - ... - - --- - # registration for Heartbeat_vMRF - # Constants: the values of domain, eventName, priority, version - # Variables (to be supplied at runtime) include: eventId, lastEpochMicrosec, - # reportingEntityId, reportingEntityName, sequence, sourceId, sourceName, - # startEpochMicrosec - event: {presence: required, heartbeatAction: [3, vnfDown,RECO-rebuildVnf], - structure: { - commonEventHeader: {presence: required, structure: { - domain: {presence: required, value: heartbeat}, - eventName: {presence: required, value: Heartbeat\_vMrf}, - eventId: {presence: required}, - nfNamingCode: {value: mrfx}, - priority: {presence: required, value: Normal}, - reportingEntityId: {presence: required}, - reportingEntityName: {presence: required}, - sequence: {presence: required}, - sourceId: {presence: required}, - sourceName: {presence: required}, - startEpochMicrosec: {presence: required}, - lastEpochMicrosec: {presence: required}, - version: {presence: required, value: 3.0} - }}, - heartbeatFields: {presence: optional, structure:{ - heartbeatFieldsVersion: {presence: required, value: 1.0}, - heartbeatInterval: {presence: required, range: [ 15, 300 ], default: 60 } - }} - }} - - ... - - --- - # registration for Mfvs\_vMRF - # Constants: the values of domain, eventName, priority, version, - # measurementFieldsVersion, additionalMeasurements.namedArrayOfFields.name, - # Variables (to be supplied at runtime) include: eventId, reportingEntityName, sequence, - # sourceName, start/lastEpochMicrosec, measurementInterval, - # concurrentSessions, requestRate, numberOfMediaPortsInUse, - # cpuUsageArray.cpuUsage,cpuUsage.cpuIdentifier, cpuUsage.percentUsage, - # additionalMeasurements.namedArrayOfFields.arrayOfFields, - # vNicPerformance.receivedOctetsAccumulated, - # vNicPerformance.transmittedOctetsAccumulated, - # vNicPerformance.receivedTotalPacketsAccumulated, - # vNicPerformance.transmittedTotalPacketsAccumulated, - # vNicPerformance.vNicIdentifier, vNicPerformance.receivedOctetsDelta, - # vNicPerformance.receivedTotalPacketsDelta, - # vNicPerformance.transmittedOctetsDelta, - # vNicPerformance.transmittedTotalPacketsDelta, - # vNicPerformance.valuesAreSuspect, memoryUsageArray.memoryUsage, - # memoryUsage.memoryConfigured, memoryUsage.vmIdentifier, - # memoryUsage.memoryUsed, memoryUsage.memoryFree - event: {presence: required, structure: { - commonEventHeader: {presence: required, structure: { - domain: {presence: required, value: measurementsForVfScaling}, - eventName: {presence: required, value: Mfvs\_vMrf}, - eventId: {presence: required}, - nfNamingCode: {value: mrfx}, - priority: {presence: required, value: Normal}, - reportingEntityId: {presence: required}, - reportingEntityName: {presence: required}, - sequence: {presence: required}, - sourceId: {presence: required}, - sourceName: {presence: required}, - startEpochMicrosec: {presence: required}, - lastEpochMicrosec: {presence: required}, - version: {presence: required, value: 3.0} - }}, - measurementsForVfScalingFields: {presence: required, structure: { - measurementFieldsVersion: {presence: required, value: 2.0}, - measurementInterval: {presence: required, range: [ 60, 3600 ], default:300}, - concurrentSessions: {presence: required, range: [ 0, 100000 ]}, - requestRate: {presence: required, range: [ 0, 100000 ]}, - numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]}, - cpuUsageArray: {presence: required, array: [ - cpuUsage: {presence: required, structure: { - cpuIdentifier: {presence: required}, - percentUsage: {presence: required, range: [ 0, 100 ], - action: [80, up, CpuUsageHigh, RECO-scaleOut], - action: [10, down, CpuUsageLow, RECO-scaleIn]} - }} - ]}, - memoryUsageArray: {presence: required, array: [ - memoryUsage: {presence: required, structure: { - memoryConfigured: {presence: required, value: 33554432}, - memoryFree: {presence: required, range: [ 0, 33554432 ], - action: [100, down, FreeMemLow, RECO-scaleOut], - action: [30198989, up, FreeMemHigh, RECO-scaleIn]}, - memoryUsed: {presence: required, range: [ 0, 33554432 ]}, - vmIdentifier: {presence: required} - }} - ]}, - additionalMeasurements: {presence: required, array: [ - namedArrayOfFields: {presence: required, structure: { - name: {presence: required, value: licenseUsage}, - arrayOfFields: {presence: required, array: [ - field: {presence: required, structure: { - name: {presence: required, value: G711AudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: G729AudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: G722AudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: AMRAudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: AMRWBAudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: OpusAudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: H263VideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: H264NonHCVideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: H264HCVideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: MPEG4VideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: VP8NonHCVideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: VP8HCVideoPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: PLC}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: AEC}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: NR}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: NG}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: NLD}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: G711FaxPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: T38FaxPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: RFactor}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: T140TextPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }}, - field: {presence: required, structure: { - name: {presence: required, value: EVSAudioPort}, - value: {presence: required, range: [ 0, 100000 ], - units: numberOfPorts } - }} - ]} - }}, - namedArrayOfFields: {presence: required, structure: { - name: {presence: required, value: mediaCoreUtilization}, - arrayOfFields: {presence: required, array: [ - field: {presence: required, structure: { - name: {presence: required, value: actualAvgAudio}, - value: {presence: required, range: [ 0, 255 ], - action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelAvgAudio}, - value: {presence: required, range: [ 0, 100 ], - action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: actualMaxAudio}, - value: {presence: required, range: [ 0, 255 ]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelMaxAudio}, - value: {presence: required, range: [ 0, 100 ]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: actualAvgVideo}, - value: {presence: required, range: [ 0, 255 ], - action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelAvgVideo}, - value: {presence: required, range: [ 0, 100 ], - action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: actualMaxVideo}, - value: {presence: required, range: [ 0, 255 ]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelMaxVideo}, - value: {presence: required, range: [ 0, 100 ]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: actualAvgHcVideo}, - value: {presence: required, range: [ 0, 255 ], - action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelAvgHcVideo}, - value: {presence: required, range: [ 0, 100 ], - action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: actualMaxHcVideo}, - value: {presence: required, range: [ 0, 255 ]} - }}, - field: {presence: required, structure: { - name: {presence: required, value: modelMaxHcVideo}, - value: {presence: required, range: [ 0, 100 ]} - }} - ]} - }} - ]}, - vNicPerformanceArray: {presence: required, array: [ - vNicPerformance: {presence: required, structure: { - receivedOctetsAccumulated: {presence: required, - range: [ 0, 18446744073709551615 ]}, - receivedTotalPacketsAccumulated: {presence: required, - range: [ 0, 18446744073709551615 ]}, - receivedOctetsDelta: {presence: required}, - range: [ 0, 18446744073709551615 ], - receivedTotalPacketsDelta: {presence: required, - range: [ 0, 18446744073709551615 ]}, - transmittedOctetsDelta: {presence: required, - range: [ 0, 18446744073709551615 ]}, - transmittedOctetsAccumulated: {presence: required, - range: [ 0, 18446744073709551615 ]}, - transmittedTotalPacketsAccumulated: {presence: required, - range: [ 0, 18446744073709551615 ]}, - transmittedTotalPacketsDelta: {presence: required, - range: [ 0, 18446744073709551615 ]}, - valuesAreSuspect: {presence: required, value: [ true, false ]}, - vNicIdentifier: {presence: required} - }} - ]} - }} - }} - - ... - - --- - # registration for Syslog\_vMRF - # Constants: the values of domain, eventName, priority, lastEpochMicrosec, version, - # syslogFields.syslogFieldsVersion, syslogFields.syslogTag - # Variables include: eventId, lastEpochMicrosec, reportingEntityId, reportingEntityName, - # sequence, sourceId, sourceName, startEpochMicrosec, - # syslogFields.eventSourceHost, syslogFields.eventSourceType, - # syslogFields.syslogFacility, syslogFields.syslogMsg - event: {presence: required, structure: { - commonEventHeader: {presence: required, structure: { - domain: {presence: required, value: syslog}, - eventName: {presence: required, value: Syslog\_vMrf}, - eventId: {presence: required}, - nfNamingCode: {value: mrfx}, - priority: {presence: required, value: Normal}, - reportingEntityId: {presence: required}, - reportingEntityName: {presence: required}, - sequence: {presence: required}, - sourceId: {presence: required}, - sourceName: {presence: required}, - startEpochMicrosec: {presence: required}, - lastEpochMicrosec: {presence: required}, - version: {presence: required, value: 3.0}, - }}, - syslogFields: {presence: required, structure: { - eventSourceHost: {presence: required}, - eventSourceType: {presence: required, value: virtualNetworkFunction}, - syslogFacility: {presence: required, range: [16, 23]}, - syslogSev: {presence: required, value: [ 0, 1, 2, 3, 4 ]}, - syslogFieldsVersion: {presence: required, value: 3.0}, - syslogMsg: {presence: required}, - syslogTag: {presence: required, value: vMRF}, - }} - }} - - ... - - --- - #Rules - Rules: [ - rule: { - trigger: CpuUsageHigh \|\| FreeMemLow \|\| AudioCoreUsageHigh \|\| - VideoCoreUsageHigh \|\| HcVideoCoreUsageHigh, - microservices: [scaleOut] - }, - rule: { - trigger: CpuUsageLow && FreeMemHigh && AudioCoreUsageLow && - VideoCoreUsageLow && HcVideoCoreUsageLow, - microservices: [scaleIn] - } - ] - - diff --git a/docs/files/VESEventRegistration_3_0.rst b/docs/files/VESEventRegistration_3_0.rst deleted file mode 100644 index 35a017c..0000000 --- a/docs/files/VESEventRegistration_3_0.rst +++ /dev/null @@ -1,3131 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -=================================== -Addendum: *VES Event Registration* -=================================== - -.. contents:: Table of Contents - - -Introduction -============ - -This document specifies a YAML format for the registration of VES -Events. The YAML format enables both human designers and applications to -parse and understand the fields that will be sent by event sources in -conjunction with specific types of events, which are identified by their -eventNames. - -The semantics of the YAML format are easily extensible to accommodate -processing needs that may arise in the future. Among the types of -information specified in the YAML are field optionality, restrictions on -field values, and event handling recommendations and requirements. - -This document should be read in conjunction with the VES Event Listener -service specification, which defines the Common Event Format and -introduces the concept of specific types of events, identified by -eventNames. - -Audience --------- - -This document is intended to support the following groups: - -- VNF Vendors - -- Service Provider (e.g., AT&T) Teams responsible for deploying VNFs - within their infrastructure - -VNF vendors will provide a YAML file to the Service Provider that -describes the events that their VNFs generate. Using the semantics and -syntax supported by YAML, vendors will indicate specific conditions that -may arise, and recommend actions that should be taken at specific -thresholds, or if specific conditions repeat within a specified time -interval. - -Based on the vendor’s recommendations, the Service Provider may create -another YAML, which finalizes their engineering rules for the processing -of the vendor’s events. The Service Provider may alter the threshold -levels recommended by the vendor, and may modify and more clearly -specify actions that should be taken when specified conditions arise. -The Service Provided-created version of the YAML will be distributed to -Service Provider applications at design time. - -Goal ----- - -The goal of the YAML is to completely describe the processing of VNF -events in a way that can be compiled or interpreted by applications -across a Service Provider’s infrastructure. - -Relation to the Common Event Format ------------------------------------ - -The Common Event Format described in the VES Event Listener service -specification defines the structure of VES events including optional -fields that may be provided. - -Specific eventNames registered by the YAML (e.g., an InvalidLicense -fault), may require that certain fields, which are optional in the -Common Event Format, be present when events with that eventName are -published. For example, a fault eventName which communicates an -‘InvalidLicense’ condition, may be registered to require that the -configured ‘licenseKey’ be provided as a name-value pair in the Common -Event Format’s ‘additionalFields’ structure, within the ‘faultFields’ -block. Anytime an ‘InvalidLicense’ fault event is detected, designers, -applications and microservices across the Service Provider’s -infrastructure can count on that name-value pair being present. - -The YAML registration may also restrict ranges or enumerations defined -in the Common Event Format. For example, eventSeverity is an enumerated -string within the Common Event Format with several values ranging from -‘NORMAL’ to ‘CRITICAL’. The YAML registration for a particular eventName -may require that it always be sent with eventSeverity set to a single -value (e.g., ‘MINOR’), or to a subset of the possible enumerated values -allowed by the Common Event Format (e.g., ‘MINOR’ or ‘NORMAL’). - -Relation to Service Design and Creation ---------------------------------------- - -Event registration for a VNF (or other event source) is provided to the -Service Provider’s Service Creation and Design Environment (e.g., SDC) -as a set of two YAML files consisting of the vendor recommendation YAML -and (optionally) the final Service Provider YAML. These YAML files -describe all the eventNames that that VNF (or other event source) -generates. - -Once their events are registered, the Service Creation and Design -Environment can then list the registered eventNames (e.g., as a drop -down list), for each VNF or other event source (e.g., a service), and -enable designers to study the YAML registrations for specific -eventNames. YAML registrations are both human readable and machine -readable. - -The final Service Provider YAML is a type of Service Design and Creation -‘artifact’, which can be distributed to Service Provider applications at -design time: notably, to applications involved in the collection and -processing of VNF events. It can be parsed by those applications so they -can support the receipt and processing of VNF events, without the need -for any manual, VNF-specific development. - -YAML Files -========== - -YAML Specification Conformance ------------------------------- - -YAML files should conform to version 1.2 of the YAML specification -available at: http://yaml.org/spec/1.2/spec.html. - -Filename --------- - -YAML file names should conform to the following naming convention: - - {NamingCode}_{ModelType}_{v#}_{AdditionalInfo}.yml - -The NamingCode identifies the entity, whose events are being registered -in the yaml, with a naming code that was established in the Service -Providers’ Service Design and Creation Environment (SDC). Example Naming -codes are: - -- tbcx - -- sgsn-mme - -The ModelType describes the type of entity whose events are being -registered. It consists of values like: - -- service - -- vfModule - -- vnf - -- vnfc - -The ‘#’ should be replaced with the current numbered version of the -file. Note that ‘#’ can be an integer or a number of the form x.y or -x.y.z (where x is the major number, y is the minor number and z is the -patch number) - -Additional descriptive info may be added after the version information - -Example file name: - -- vIsbcSsc_vnfc_v1.yml - -File Structure --------------- - -Each eventType is registered as a distinct YAML ‘document’. - -YAML files consist of a series of YAML documents delimited by ‘---‘ and -‘…’ for example: - - --- - - # Event Registration for eventName ‘name1’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name2’ - - # details omitted - - ... - - --- - - # Event Registration for eventName ‘name3’ - - # details omitted - - ... - -YAML Syntax and Semantics -========================= - -YAML registration documents show each relevant VES Common Event Model -object and field (i.e., each element) for the eventName being -registered, including any extensible fields (e.g., specific name-value -pairs). - -Qualifiers ----------- - -Each object or field name in the eventName being registered is followed -by a ‘qualifier’, which consists of a colon and two curly braces, for -example: - - “objectOrFieldName: { }” - -The curly braces contain meta-information about that object or field -name (also known as the ‘element’), such as whether it is required to be -present, what values it may have, what handling it should trigger, etc… - -Semantics have been defined for the following types of meta-information -within the curly braces: - -Action -~~~~~~ - -The ‘action’ keyword may be applied to field values or to the event as a -whole. The ‘action’ keyword specifies a set of actions that should be -taken if a specified trigger occurs. For example, the ‘action’ keyword -may specify that a threshold crossing alert (i.e., tca) be generated, -and/or that a specific microservice handler be invoked, and/or that a -specific named-condition be asserted. In the Rules section of the YAML -file, tca’s and microservices may be defined on individual -named-conditions or on logical combinations of named-conditions. - -The ‘action:’ keyword is followed by five values in square brackets. The -first two values communicate the trigger, and the last three values -communicate the actions to be taken if that trigger occurs: - -1. The first value conveys the trigger level. If the field on which the - action is defined reaches or passes through that level, then the - trigger fires. If a specific level is not important to the - recommended action, the ‘any’ keyword may be used as the first value. - (Note: ‘any’ is often used when an action is defined on the ‘event’ - structure as a whole). - -2. The second value indicates the direction of traversal of the level - specified in the first value. The second value may be ‘up’, ‘down’, - ‘at’ or ‘any’. ‘any’ is used if the direction of traversal is not - important. ‘at’ implies that it traversed (or exactly attained) the - trigger level but it doesn’t matter if the traversal was in the up - direction or down direction. Note: If ‘up’, ‘down’ or ‘at’ are used, - the implication is that the microservices processing the events - within the service provider are maintaining state (e.g., to know that - a measurement field traversed a trigger level in an ‘up’ direction, - the microservice would have to know that the field was previously - below the trigger level). When initially implementing support for - YAML actions, a service provider may choose to use and interpret - these keywords in a simpler way to eliminate the need to handle - state. Specifically, they may choose to define and interpret all ‘up’ - guidance to mean ‘at the indicated trigger level or greater’, and - they may choose to define and interpret all ‘down’ guidance to mean - ‘at the indicated trigger level or lower’. - -3. The third value optionally names the condition that has been attained - when the triggers fires (e.g., ‘invalidLicence’ or - ‘capacityExhaustion’). Named-conditions should be expressed in camel - case with no underscores, hyphens or spaces and with the first letter - in lowercase. In the Rules section of the YAML file, named-conditions - may be used to specify events that should be generated and/or - microservices that should be invoked. If it is not important to name - a condition, then the string ‘null’ (without the quotes) must be used - as the third value. - -4. The fourth value recommends a specific microservice (e.g., ‘rebootVm’ - or ‘rebuildVnf’) supported by the Service Provider, be invoked if the - trigger is attained. Design time processing of the YAML by the - service provider can use these directives to automatically establish - policies and configure flows that need to be in place to support the - recommended runtime behavior. - -.. - - If a vendor wants to recommend an action, it can either work with the - service provider to identify and specify microservices that the - service provider support, or, the vendor may simply indicate and - recommend a generic microservice function by prefixing ‘RECO-’ in - front of the microservice name, which should be expressed in upper - camel case with no underscores, hyphens or spaces. - - A fourth value must be provided. If not needed, the string ‘null’ - (without the quotes) must be used. - -5. The fifth value indicates a specific named event (e.g., a TCA) that - should be generated if the trigger occurs. This field must be - provided as a VES eventName or, if not needed, as the string ‘null’ - (without the quotes). - -.. - - When an event is specified, a YAML registration for that eventName - should be added to the event registrations within the YAML file. - -Examples: - -- event: { action: [ any, any, null, rebootVm, null ] } - -.. - - # whenever the above event occurs, the VM should be rebooted - -- fieldname: { action: [ 80, up, null, null, tcaUpEventName ], action: - [ 60, down, overcapacity, null, null ] } - -.. - - # when the value of fieldname crosses 80 in an up direction, - tcaUpEventName - - should be published; if the fieldname crosses 60 in a down direction - an - - ‘overCapacity’ named-condition is asserted. - -AggregationRole -~~~~~~~~~~~~~~~ - -The ‘aggregationRole’ keyword is applied to a keyValuePair. - -AggregationRole may be set to one of the following: - -- cumulativeCounter - -- gauge - -- index - -- reference - -“index” identifies a field as an index or a key for aggregation. - -“reference” fields have values that typically do not change over -consecutive collection intervals. - -“gauge” values may fluctuate from one collection interval to the next, -i.e., increase or decrease. - -“cumulativeCounter” values keep incrementing regardless of collection -interval boundaries until they overflow, i.e., until they exceed a -maximum value specified by design. Typically, delta calculation is -needed based on two cumulativeCounter values over two consecutive -collection intervals. - -If needed, the aggergationRole setting tells the receiving event -processor how to aggregate the extensible keyValuePair data. Data -aggregation may use a combination of ‘index’ and ‘reference’ data fields -as aggregation keys while applying aggregation formulas, such as -summation or average on the ‘gauge’ fields. - -Example 1: - - Interpretation of the below: If additionalMeasurements is supplied, - it must have key name1 and name1’s value should be interpreted as an - index: - -- additionalMeasurements: {presence: optional, structure: { - -.. - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: name1}, - - value: {presence: required, aggregationRole: index } - - }}, - - . . . - - }} - -Example 2: - -- Let’s say a vnf wants to send the following ‘TunnelTraffic’ fields - through a VES arrayOfNamedHashMap structure (specifically through - additionalMeasurements in the VES measurementField block): - -+-------------+-------------+-------------+-------------+-------------+ -| Tunnel Name | Tunnel Type | Total | Total | Total | -| | | Output | Output | Output | -| | | Bytes | Packets | Errors | -+=============+=============+=============+=============+=============+ -| ST6WA21CRS: | PRIMARY | 2457205 | 21505 | 0 | -| TUNNEL-TE40 | | | | | -| 018 | | | | | -+-------------+-------------+-------------+-------------+-------------+ -| ST6WA21CRS: | PRIMARY | 46677 | 220 | 0 | -| TUNNEL-TE10 | | | | | -| 29 | | | | | -+-------------+-------------+-------------+-------------+-------------+ -| ST6WA21CRS: | PRIMARY | 80346 | 577 | 0 | -| TUNNEL-TE10 | | | | | -| 28 | | | | | -+-------------+-------------+-------------+-------------+-------------+ - -- Tunnel Name is an index, Tunnel Type is reference data and the other - three columns are counters - -- The first three columns would be sent through VES as follows: - -additionalMeasurements: { presence: required, array: [ - -namedHashMap: { presence: required, structure: { - -name: { presence: required, value: "TunnelTraffic" }, - -hashMap: { presence: required, array: [ - -keyValuePair: { presence: required, aggregationRole: index, structure: { - -key: { presence: required, value: TunnelName }, - -value: { presence: required } - -}}, - -keyValuePair: { presence: required, aggregationRole: reference, -structure: { - -key: { presence: required, value: TunnelType }, - -value: { presence: required } - -}}, - -keyValuePair: { presence: required, aggregationRole: cumulativeCounter, - -structure: { - -key: { presence: required, value: TotalOutputBytes }, - -value: { presence: required, castTo: integer } - -}} - -]} - -}} - -]} - -Array -~~~~~ - -The ‘array’ keyword indicates that the element is an array; ‘array:’ is -following by square brackets which contain the elements of the array. -Note that unlike JSON itself, the YAML registration will explicitly -declare the array elements and will not communicate them anonymously. - -Examples: - -- element: { array: [ - -.. - - firstArrayElement: { }, - - secondArrayElement: { } - - ] } - -CastTo -~~~~~~ - -The ‘castTo’ keyword is applied to ‘value’ keywords. It tells the -receiving event processor to cast (or interpret) the supplied value from -its standard VES datatype (typically a string) to some other datatype. -If not supplied the implication is the standard VES datatype applies. - -A value may be castTo one and only one of the following data types: - -- boolean - -- integer - -- number (note: this supports decimal values as well as integral - values) - -- string - -Example: - -- fieldname: { value: [ x, y, z ], castTo: number } # only values ‘x’, - ‘y’, or ‘z’ allowed - -.. - - # each must be cast to a number - -- additionalMeasurements: {presence: optional, structure: { - -.. - - keyValuePair: {presence: required, structure: { # if - additionalMeasurements is - - key: {presence: required, value: name1}, # supplied, it must have key - ‘name1’ - - value: {presence: required, castTo: integer} # its value must be cast - to integer - - }} - - }} - - For another example, see the second example under AggregationRole. - -Comment -~~~~~~~ - -The ‘comment’ keyword enables event registrations to communicate -additional information, in the form of a quoted string, to designers -consuming the event registration. Such additional information might -convey meaning, instructions or potential effects associated with -particular fields or with the event as a whole. - -Examples: - -- fieldname: { range: [ 1, unbounded ], default: 5, comment: “needs - further diagnosis; call the TAC” } - -- fieldname: { value: [ red, white, blue ], default: blue, comment: - “red indicates degraded quality of service” } - -- event: { presence: required, comment: “this event only occurs in - conditions when the ipq has stopped operating; manual reset may be - required”, structure: { . . . } } - -Default -~~~~~~~ - -The ‘default’ keyword specifies a default field value. Note: the default -value must be within the range or enumeration of acceptable values. - -Examples: - -- fieldname: { range: [ 1, unbounded ], default: 5 } - -- fieldname: { value: [ red, white, blue ], default: blue } - -HeartbeatAction -~~~~~~~~~~~~~~~ - -The ‘heartbeatAction’ keyword is provided on the ‘event’ objectName for -heartbeat events only. It provides design time guidance to the service -provider’s heartbeat processing applications (i.e., their watchdog -timers). The syntax and semantics of the ‘heartbeatAction’ keyword are -similar to the ‘action’ keyword except the trigger is specified by the -first field only instead of the first two fields. When the -‘heartbeatAction’ keyword is indicated, the first field is an integer -indicating the number of successively missed heartbeat events. Should -that trigger occur, the remaining fields have the same order, meaning -and optionality as those described for the ‘action’ keyword. - -Examples: - -- event: { heartbeatAction: [ 3, vnfDown, RECO-rebootVnf, tcaEventName - ] } - -.. - - # whenever the above event occurs, a vnfDown condition is asserted - and the vnf should be rebooted, plus the indicated tca should be - generated. - -key -~~~ - -The ‘key’ keyword describes a specific key as part of a key-value pair -that may be sent within a keyValuePair keyword (see ‘keyValuePair’ -keyword for more explanation and examples). - -keyValuePair -~~~~~~~~~~~~ - -The ‘keyValuePair’ keyword describes a specific key-value pair that may -be sent within a hashMap structure (i.e., a VES field with the hashMap -datatype) or a keyValuePairString structure (see the keyValuePairString -keyword for more information). - -Within keyValuePair is a single ‘key’ and a single ‘value’ keyword, each -of which may be decorated with other keywords specified in this document -(e.g., with ‘presence’, ‘range’ and other relevant keywords). - -Examples: - -- The following specifies an additionalInformation field within VES, - which is of type hashMap: - -.. - - additionalInformation: {presence: optional, structure: { - - keyValuePair: {presence: required, structure: { - - key: {presence: required, value: name1}, - - value: {presence: required} - - }}, - - keyValuePair: {presence: optional, structure: { - - key: {presence: required, value: name2}, - - value: {presence: required} - - }} - - }} - -keyValuePairString -~~~~~~~~~~~~~~~~~~ - -The ‘keyValuePairString’ keyword describes the key-value pairs to be -communicated through a string (e.g., in the VES Syslog Fields -‘syslogSData’ or ‘additionalFields’ strings). This keyword takes three -parameters: - -- the first parameter specifies the character used to delimit (i.e., to - separate) the key-value pairs. If a space is used as a delimiter, - it should be communicated within single quotes as ‘ ‘; otherwise, - the delimiter character should be provided without any quotes. - -- The second parameter specifies the characters used to separate the - keys and values. If a space is used as a separator, it should be - communicated within single quotes as ‘ ‘; otherwise, the separator - character should be provided without any quotes. - -- The third parameter is a “sub-keyword” (i.e., it is used only within - ‘keyValuePairString’) called ‘keyValuePairs: [ ]’. Within the - square brackets, a list of ‘keyValuePair’ keywords can be provided - (see the ‘keyValuePair keyword for more information). - -Examples: - -- The following specifies an additionalFields string which is stuffed - with ‘key=value’ pairs delimited by the pipe (‘|’) symbol as in - (“key1=value1|key2=value2|key3=value3…”). - -additionalFields: {presence: required, keyValuePairString: {|, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: someKeyName}, - -value: {presence: required, range: [0, 100]} - -} }, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: someOtherKeyName}, - -value: {presence: required, value [red, white, blue]} - -} } - -] } } - -Presence -~~~~~~~~ - -The ‘presence’ keyword may be defined as ‘required’ or ‘optional’. If -not provided, the element is assumed to be ‘optional’. - -Examples - -- element: { presence: required } # element must be present - -- element: { presence: optional } # element is optional - -- element: { value: blue } # by omitting a presence definition, the - -.. - - element is assumed to be optional - -Range -~~~~~ - -The ‘range’ keyword applies to fields (i.e., simpleTypes); indicates the -value of the field is a number within a specified range of values from -low to high (inclusive of the indicated values). . ‘range:’ is followed -by two parameters in square brackets: - -- the first parameter conveys the minimum value - -- the second parameter conveys the maximum value or ‘unbounded’ - -The keyword ‘unbounded’ is supported to convey an unbounded upper limit. -Note that the range cannot override any restrictions defined in the VES -Common Event Format. - -Examples: - -- fieldname: { range: [ 1, unbounded ] } - -- fieldname: { range: [ 0, 3.14 ] } - -Structure -~~~~~~~~~ - -The ‘structure’ keyword indicates that the element is a complexType -(i.e., an object) and is followed by curly braces containing that -object. - -Example: - -- objectName: { structure: { - -element1: { }, - -element2: { }, - -anotherObject: { structure: { - -element3: { }, - -element4: { } - -} } - -} } - -Units -~~~~~ - -The ‘units’ qualifier may be applied to values provided in VES Common -Event Format extensible field structures. The ‘units’ qualifier -communicates the units (e.g., megabytes, seconds, Hz) that the value is -expressed in. Note: the ‘units’ should not contain any space characters -and should be expressed in camel casing (e.g., use ‘numberOfPorts’, not -‘number_of_ports’ nor ‘number of ports’). - -Example: - -- additionalInformation: { presence: optional, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: pilotNumberPoolSize}, - -value: {presence: required, units: megaBytes} - -}} - -}} - -Value -~~~~~ - -The ‘value’ keyword applies to fields (i.e., simpleTypes); indicates a -single value or an enumeration of possible values. If not provided, it -is assumed the value will be determined at runtime. Note that the -declared value cannot be inconsistent with restrictions defined in the -VES Common Event Format (e.g., it cannot add an enumerated value to an -enumeration defined in the Common Event Format, but it can subset the -defined enumerations in the Common Event Format). - -Values that are strings containing spaces should always be indicated in -single quotes. - -Examples: - -- fieldname: { value: x } # the value is ‘x’ - -- fieldname: { value: [ x, y, z ] } # the value is either ‘x’, ‘y’, or - ‘z’ - -- fieldname: { presence: required } # the value will be provided at - runtime - -- fieldname: { value: ‘error state’ } # the value is the string within - the single quotes - -Complex Conditions ------------------- - -Conditions Document -~~~~~~~~~~~~~~~~~~~ - -After all events have been defined, the YAML file may provide a YAML -document delimited by ‘---‘ and ‘…’, which specifies complex conditions -defined in terms of other conditions, which were asserted in the action -qualifiers of the preceding event definitions. For example: - - --- - - # Event Registration for eventName ‘name1’ - - event: {presence: required, action: [any, any, A, null], structure: { - - # details omitted - - }} - - ... - - --- - - # Event Registration for eventName ‘name2’ - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - # details omitted - - }} - - measurementFields: {presence: required, structure: { - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, action: [90, up, B, null]} - -}} - -]}, - -# details omitted - - }} - - }} - - ... - - --- - - # Complex Conditions - - conditions: [ - - conditionC: { defined in terms of A and B, details omitted }, - - conditionD: { defined in terms of A, B and C details omitted } - - ] - - ... - -Conditions Syntax and Semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The YAML ‘conditions’ document begins with the keyword ‘conditions’ -followed by a colon and square brackets. Each condition is then defined -within the square brackets. Commas are used to separate conditions. - -Each condition is expressed as follows: - -conditionName: *logical expression in terms of other conditions* - -Logical Expressions -~~~~~~~~~~~~~~~~~~~ - -The following logical operators are supported: - -- &&: which is a logical AND - -- \||, which is a logical OR - -In addition parentheses may be used to group expressions. - -Example logical expression: - - (A && B) \|\| (C && D) - -Where A, B, C and D are named conditions expressed earlier in the YAML -file. - -Because YAML doesn’t support the above operators, the whole expression -needs to be enclosed in double quotes. - -Example for a condition named ‘ConditionP’: - ---- - -conditions: [ - -conditionP: "B \|\| (C && D)" - -] - -... - -Alternatively, Logical ORs and ANDs can be expressed using a syntax -defined by `metacpan.org <https://metacpan.org/pod/YAML::Logic>`__ for -Perl. Using this syntax, the example above looks like this: - ---- - -conditions: [ - -conditionP: [or, [B, [and, [C, D]]]] - -] - -... - -In the above syntax, both ORs and ANDs are provided as two nested -arrays, where the outer array consists of two items: - -- The desired operator as either ‘or’ or ‘and’ - -- The inner array which consists of the conditions to be OR’d or AND’d - together - -Note1: more than two conditions may be or’d or and’d (e.g., “B \|\| C -\|\| D” or “B && C && D”) - -Note2: however expressed by YAML, parsers must be developed to make use -of the above expressions. - -Time Based Qualifiers -~~~~~~~~~~~~~~~~~~~~~ - -Time based rules may be established using a timing keyword as follows: - ---- - -conditions: [ - -PersistentB1: { - -timing: { - -condition: B, - -occurrences: 3, - -interval: 300, - -units: seconds - -} - -} - -] - -... - -This means that if condition B occurs 3 (or more) times in 300 seconds -(e.g., 5 minutes), then condition ‘PersistentB1’ has occurred. - -Array Item Qualifiers -~~~~~~~~~~~~~~~~~~~~~ - -This ‘arrayItems’ keyword defines conditions evaluated across the items -in an array. In the example below, the condition is named ‘AnyOfC’: - ---- - -conditions: [ - -AnyOfC: { - -arrayItems: { - -condition: C, - -arrayItem: measurements.cpuUsageArray.cpuUsage, - -scope: anyOf - -} - -} - -] - -... - -This means that if condition C occurs on any cpuUsage structure within -the cpuUsageArray, then the condition ‘AnyOfC’ is in effect. - -Note the dotted notation used to convey the path to the arrayItem with -respect to the encapsulating domain field block. - -Scope may have the values ‘anyOf’ or ‘allOf’ - -Mathematical Expressions -~~~~~~~~~~~~~~~~~~~~~~~~ - -Mathematical expressions evaluate to a number, using ‘(‘, ‘)’, ‘+’, ‘-‘, -‘*’, ‘/’ and variables of the form $variablePath where the variablePath -is defined with respect to the encapsulating domain field block. - -Mathematical expressions are specified as "${mathematicalExpress}". -Because YAML does not support mathematical operators, the expressions -must be enclosed within double quotes. - ---- - -conditions: [ - -PersistentB2: { - -timing: { - -condition: B, - -occurrences: 3, - -interval: "${60 \* $measurements.measurementInterval}", - -units: seconds - -} - -} - -] - -... - -This means that if condition B occurs 3 (or more) times in an interval -defined by 60 times the measurementInterval (e.g., if the -measurementInterval was expressed in seconds as 5, then this would -evaluate to 300), then condition ‘PersistentB2’ is in effect. - -Rules ------ - -Rules Document -~~~~~~~~~~~~~~ - -After all events and conditions have been defined, the YAML file may -conclude with a final YAML document delimited by ‘---‘ and ‘…’, which -defines rules based on the named ‘conditions’ asserted previously. For -example: - - --- - - # Event Registration for eventName ‘name1’ - - event: {presence: required, action: [any, any, A, null], structure: { - - # details omitted - - }} - - ... - - --- - - # Event Registration for eventName ‘name2’ - - event: {presence: required, structure: { - - commonEventHeader: {presence: required, structure: { - - # details omitted - - }} - - measurementFields: {presence: required, structure: { - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, action: [90, up, B, null]} - -}} - -]}, - -# details omitted - - }} - - }} - - ... - - --- - - # Complex Conditions - - conditions: [ - - C: { details omitted } - - ] - - ... - - --- - - # Rules - - rules: [ - - # defined based on conditions ‘A’, ‘B’ and ‘C’ - details omitted - - ] - - ... - -Rules Syntax and Semantics -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a -colon and square brackets. Each rule is then defined within the square -brackets (of ‘rules’). Commas are used to separate rule structure. - -Each rule structure is expressed as follows: - -rule: { - -trigger: *logical expression in terms of conditions*, - -microservices: [ *microservice1, microservice2, microservice3…* ] - -events: [e*ventName1, eventName2, eventName3…* ], - -} - -Notes: - -- All referenced eventNames should be defined within the YAML. - -- At least one microservice or event should be specified, and both - microservices and events may be specified. - -- For information about microservices, see section 3.1.1 bullet number - 4. - -Triggers -~~~~~~~~ - -Triggers may be as simple as a named condition, or they may be logical -expressions in terms of other conditions using the same syntax as used -by the complex conditions described above. For example: - -rules: [ - -ruleName1: { - -trigger: A, - -eventss: [eventName1], - -microservices: [rebootVm] - -}, - -ruleName2: { - -trigger: "B \|\| (C && D)", - -microservices: [scaleOut] - -} - -] - -Note: when microservices are defined in terms of multiple event -conditions, the designer should take care to consider whether the target -of the microservice is clear (e.g., which VNF or VM instance to perform -the action on). Future versions of this document may provide more -clarity. - -YAML Examples -============= - -An example YAML file is provided below which registers some events for a -hypothetical VNF. Note: some of the lines have been manually -wrapped/indented to make it easier to read. Please ignore the section -breaks that interrupt this single file; they were added to make it -easier to rapidly find examples of different types of events. - -Fault ------ - ---- - -# registration for Fault_vMrf_alarm003 - -# Constants: the values of domain, eventName, priority, vfstatus - -# , version, alarmCondition, eventSeverity, eventSourceType, - -# faultFieldsVersion, specificProblem, - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, -sourceName, - -# startEpochMicrosec - -event: {presence: required, action: [ any, any, alarm003, -RECO-rebuildVnf ], - -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: fault}, - -eventName: {presence: required, value: Fault_Vmrf-Nokia_Alarm003}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Medium}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -faultFields: {presence: required, structure: { - -alarmCondition: {presence: required, value: alarm003}, - -eventSeverity: {presence: required, value: MAJOR}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -faultFieldsVersion: {presence: required, value: 3.0}, - -specificProblem: {presence: required, value: "Configuration file was -corrupt or - -not present"}, - -vfStatus: {presence: required, value: "Requesting Termination"} - -}} - -}} - -... - ---- - -# registration for clearing Fault_vMrf_alarm003Cleared - -# Constants: the values of domain, eventName, priority, - -# , version, alarmCondition, eventSeverity, eventSourceType, - -# faultFieldsVersion, specificProblem, - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, - -# sourceName, startEpochMicrosec, vfStatus - -event: {presence: required, action: [ any, any, alarm003, Clear ], -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: fault}, - -eventName: {presence: required, value: -Fault_Vmrf-Nokia_Alarm003Cleared}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Medium}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -faultFields: {presence: required, structure: { - -alarmCondition: {presence: required, value: alarm003}, - -eventSeverity: {presence: required, value: NORMAL}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -faultFieldsVersion: {presence: required, value: 3.0}, - -specificProblem: {presence: required, value: "Valid configuration file -found"}, - -vfStatus: {presence: required, value: "Requesting Termination"} - -}} - -}} - -... - -Heartbeat ---------- - ---- - -# registration for Heartbeat_vMRF - -# Constants: the values of domain, eventName, priority, version - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, -sourceName, - -# startEpochMicrosec - -event: {presence: required, heartbeatAction: [3, vnfDown, -RECO-rebuildVnf], - -structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: heartbeat}, - -eventName: {presence: required, value: Heartbeat_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -heartbeatFields: {presence: optional, structure:{ - - heartbeatFieldsVersion: {presence: required, value: 2.0}, - - heartbeatInterval: {presence: required, range: [ 15, 300 ], -default: 60 } - -}} - -}} - -... - -Measurements ------------- - -To see how additionalMeasurements may be sent in a way that is easy for -service providers to process without custom logic, please see the -following keywords: aggregationRole and castTo. In particular, see the -second example under aggergationRole. - ---- - -# registration for Measurement_vMRF - -# Constants: the values of domain, eventName, priority, version, - -# measurementFieldsVersion, -additionalMeasurements.namedArrayOfFields.name, - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, sequence, - -# sourceName, start/lastEpochMicrosec, measurementInterval, - -# concurrentSessions, requestRate, numberOfMediaPortsInUse, - -# cpuUsageArray.cpuUsage,cpuUsage.cpuIdentifier, cpuUsage.percentUsage, - -# additionalMeasurements.namedArrayOfFields.arrayOfFields, - -# vNicPerformance.receivedOctetsAccumulated, - -# vNicPerformance.transmittedOctetsAccumulated, - -# vNicPerformance.receivedTotalPacketsAccumulated, - -# vNicPerformance.transmittedTotalPacketsAccumulated, - -# vNicPerformance.vNicIdentifier, vNicPerformance.receivedOctetsDelta, - -# vNicPerformance.receivedTotalPacketsDelta, - -# vNicPerformance.transmittedOctetsDelta, - -# vNicPerformance.transmittedTotalPacketsDelta, - -# vNicPerformance.valuesAreSuspect, memoryUsageArray.memoryUsage, - -# memoryUsage.memoryConfigured, memoryUsage.vmIdentifier, - -# memoryUsage.memoryUsed, memoryUsage.memoryFree - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: measurement}, - -eventName: {presence: required, value: Measurement_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -measurementFields: {presence: required, structure: { - -measurementFieldsVersion: {presence: required, value: 3.0}, - -measurementInterval: {presence: required, range: [ 60, 3600 ], default: -300}, - -concurrentSessions: {presence: required, range: [ 0, 100000 ]}, - -requestRate: {presence: required, range: [ 0, 100000 ]}, - -numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]}, - -cpuUsageArray: {presence: required, array: [ - -cpuUsage: {presence: required, structure: { - -cpuIdentifier: {presence: required}, - -percentUsage: {presence: required, range: [ 0, 100 ], - -action: [80, up, CpuUsageHigh, RECO-scaleOut], - -action: [10, down, CpuUsageLow, RECO-scaleIn]} - -}} - -]}, - -memoryUsageArray: {presence: required, array: [ - -memoryUsage: {presence: required, structure: { - -memoryConfigured: {presence: required, value: 33554432}, - -memoryFree: {presence: required, range: [ 0, 33554432 ], - -action: [100, down, FreeMemLow, RECO-scaleOut], - -action: [30198989, up, FreeMemHigh, RECO-scaleIn]}, - -memoryUsed: {presence: required, range: [ 0, 33554432 ]}, - -vmIdentifier: {presence: required} - -}} - -]}, - -additionalMeasurements: {presence: required, array: [ - -namedHashMap: {presence: required, structure: { - -name: {presence: required, value: licenseUsage}, - -hashMap: {presence: required, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G711AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G729AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G722AudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AMRAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AMRWBAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: OpusAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H263VideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H264NonHCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: H264HCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: MPEG4VideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VP8NonHCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VP8HCVideoPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: PLC}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: AEC}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NR}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NG}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: NLD}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: G711FaxPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: T38FaxPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: RFactor}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: T140TextPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: EVSAudioPort}, - -value: {presence: required, range: [ 0, 100000 ], - -units: numberOfPorts } - -}} - -}} - -}}, - -namedHashMap: {presence: required, structure: { - -name: {presence: required, value: mediaCoreUtilization}, - -hashMap: {presence: required, structure: { - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgAudio}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - -action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgAudio}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, AudioCoreUsageHigh, RECO-scaleOut], - -action: [10, down, AudioCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxAudio}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxAudio}, - -value: {presence: required, range: [ 0, 100 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgVideo}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgVideo}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, VideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, VideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxVideo}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxVideo}, - -value: {presence: required, range: [ 0, 100 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualAvgHcVideo}, - -value: {presence: required, range: [ 0, 255 ], - -action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelAvgHcVideo}, - -value: {presence: required, range: [ 0, 100 ], - -action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut], - -action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: actualMaxHcVideo}, - -value: {presence: required, range: [ 0, 255 ]} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: modelMaxHcVideo}, - -value: {presence: required, range: [ 0, 100 ]} - -}} - -}} - -}} - -]}, - -vNicPerformanceArray: {presence: required, array: [ - -vNicPerformance: {presence: required, structure: { - -receivedOctetsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -receivedTotalPacketsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -receivedOctetsDelta: {presence: required}, - -range: [ 0, 18446744073709551615 ], - -receivedTotalPacketsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedOctetsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedOctetsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedTotalPacketsAccumulated: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -transmittedTotalPacketsDelta: {presence: required, - -range: [ 0, 18446744073709551615 ]}, - -valuesAreSuspect: {presence: required, value: [ true, false ]}, - -vNicIdentifier: {presence: required} - -}} - -]} - -}} - -}} - -... - -Mobile Flow ------------ - ---- - -# registration for mobileFlow - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, - -# sequence, sourceName, start/lastEpochMicrosec - -# - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: mobileFlow}, - -eventName: {presence: required, value: MobileFlow_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -mobileFlowFields: {presence: required, structure: { - -mobileFlowFieldsVersion: {presence: required, value: 3.0}, - -applicationType: {presence: optional}, - -appProtocolType: {presence: optional}, - -appProtocolVersion: {presence: optional}, - -cid: {presence: optional}, - -connectionType: {presence: optional}, - -ecgi: {presence: optional}, - -flowDirection: {presence: required}, - -gtpPerFlowMetrics: {presence: required, structure: { - -avgBitErrorRate: {presence: required}, - -avgPacketDelayVariation: {presence: required}, - -avgPacketLatency: {presence: required}, - -avgReceiveThroughput: {presence: required}, - -avgTransmitThroughput: {presence: required}, - -durConnectionFailedStatus: {presence: optional}, - -durTunnelFailedStatus: {presence: optional}, - -flowActivatedBy: {presence: optional}, - -flowActivationEpoch: {presence: required}, - -flowActivationMicrosec: {presence: required}, - -flowActivationTime: {presence: optional}, - -flowDeactivatedBy: {presence: optional}, - -flowDeactivationEpoch: {presence: required}, - -flowDeactivationMicrosec: {presence: required}, - -flowDeactivationTime: {presence: required}, - -flowStatus: {presence: required}, - -gtpConnectionStatus: {presence: optional}, - -gtpTunnelStatus: {presence: optional}, - -ipTosCountList: {presence: optional}, - -ipTosList: {presence: optional}, - -largePacketRtt: {presence: optional}, - -largePacketThreshold: {presence: optional}, - -maxPacketDelayVariation: {presence: required}, - -maxReceiveBitRate: {presence: optional}, - -maxTransmitBitRate: {presence: optional}, - -mobileQciCosCountList: {presence: optional}, - -mobileQciCosList: {presence: optional}, - -numActivationFailures: {presence: required}, - -numBitErrors: {presence: required}, - -numBytesReceived: {presence: required}, - -numBytesTransmitted: {presence: required}, - -numDroppedPackets: {presence: required}, - -numGtpEchoFailures: {presence: optional}, - -numGtpTunnelErrors: {presence: optional}, - -numHttpErrors: {presence: optional}, - -numL7BytesReceived: {presence: required}, - -numL7BytesTransmitted: {presence: required}, - -numLostPackets: {presence: required}, - -numOutOfOrderPackets: {presence: required}, - -numPacketErrors: {presence: required}, - -numPacketsReceivedExclRetrans: {presence: required}, - -numPacketsReceivedInclRetrans: {presence: required}, - -numPacketsTransmittedInclRetrans: {presence: required}, - -numRetries: {presence: required}, - -numTimeouts: {presence: required}, - -numTunneledL7BytesReceived: {presence: required}, - -roundTripTime: {presence: required}, - -tcpFlagCountList: {presence: optional}, - -tcpFlagList: {presence: optional}, - -timeToFirstByte: {presence: required} - -}}, - -gtpProtocolType: {presence: optional}, - -gtpVersion: {presence: optional}, - -httpHeader: {presence: optional}, - -imei: {presence: optional}, - -imsi: {presence: optional}, - -ipProtocolType: {presence: required}, - -ipVersion: {presence: required}, - -lac: {presence: optional}, - -mcc: {presence: optional}, - -mnc: {presence: optional}, - -msisdn: {presence: optional}, - -otherEndpointIpAddress: {presence: required}, - -otherEndpointPort: {presence: required}, - -otherFunctionalRole: {presence: optional}, - -rac: {presence: optional}, - -radioAccessTechnology: {presence: optional}, - -reportingEndpointIpAddr: {presence: required}, - -reportingEndpointPort: {presence: required}, - -sac: {presence: optional}, - -samplingAlgorithm: {presence: optional}, - -tac: {presence: optional}, - -tunnelId: {presence: optional}, - -vlanId: {presence: optional}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -Sip Signaling -------------- - ---- - -# registration for sipSignaling - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -reportingEntityName, - -# sequence, sourceName, start/lastEpochMicrosec - -# - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: sipSignaling}, - -eventName: {presence: required, value: SipSignaling_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -sipSignalingFields: {presence: required, structure: { - -compressedSIP: {presence: optional}, - -correlator: {presence: required}, - -localIpAaddress: {presence: required}, - -localPort: {presence: required}, - -remoteIpAddress: {presence: required}, - -remotePort: {presence: required}, - -sipSignalingFieldsVersion: {presence: required, value: 2.0}, - -summarySip: {presence: optional}, - -vnfVendorNameFields: {presence: required, structure: { - -vendorName: {presence: required}, - -vfModuleName: {presence: optional}, - -vnfName: {presence: optional} - -}}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -Syslog ------- - ---- - -# registration for Syslog_vMRF - -# Constants: the values of domain, eventName, priority, -lastEpochMicrosec, version, - -# syslogFields.syslogFieldsVersion, syslogFields.syslogTag - -# Variables include: eventId, lastEpochMicrosec, reportingEntityId, -reportingEntityName, - -# sequence, sourceId, sourceName, startEpochMicrosec, - -# syslogFields.eventSourceHost, syslogFields.eventSourceType, - -# syslogFields.syslogFacility, syslogFields.syslogMsg - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: syslog}, - -eventName: {presence: required, value: Syslog_Vmrf-Nokia}, - -eventId: {presence: required}, - -nfNamingCode: {value: mrfx}, - -priority: {presence: required, value: Normal}, - -reportingEntityId: {presence: required}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceId: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0}, - -}}, - -syslogFields: {presence: required, structure: { - -eventSourceHost: {presence: required}, - -eventSourceType: {presence: required, value: virtualNetworkFunction}, - -syslogFacility: {presence: required, range: [16, 23]}, - -syslogSev: {presence: required, value: [Emergency, Alert, Critical, -Error]}, - -syslogFieldsVersion: {presence: required, value: 3.0}, - -syslogMsg: {presence: required}, - -syslogSData: {presence: required, keyValuePairString: {‘ ‘, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ATTEST}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DATE_IN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DATE_OUT}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: DEST_IN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: FUNCTION}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ICID}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ORIGID}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: ORIG_TN}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: SIP_REASON_HEADER}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: STATE}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: STATUS}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: VERSTAT}, - -value: {presence: required} - -}} - -]}} }] - -syslogTag: {presence: required, value: vMRF}, - -additionalFields: {presence: required, keyValuePairString: {|, =, -keyValuePairs: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: someKeyName}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: someOtherKeyName}, - -value: {presence: required} - -}} - -]}} - -}} - -}} - -... - -Voice Quality -------------- - ---- - -# registration for voiceQuality - -# Constants: the values of domain, eventName, priority, version - -# - -# Variables (to be supplied at runtime) include: eventId, -lastEpochMicrosec, - -# reportingEntityId, reportingEntityName, sequence, sourceId, - -# sourceName, startEpochMicrosec - -event: {presence: required, structure: { - -commonEventHeader: {presence: required, structure: { - -domain: {presence: required, value: voiceQualityFields}, - -eventName: {presence: required, value: VoiceQuality_Vxyz-Vendor}, - -eventId: {presence: required}, - -nfType: {presence: required, value: sbcx}, - -priority: {presence: required, value: Normal}, - -reportingEntityName: {presence: required}, - -sequence: {presence: required}, - -sourceName: {presence: required}, - -startEpochMicrosec: {presence: required}, - -lastEpochMicrosec: {presence: required}, - -timeZoneOffset: {presence: required}, - -version: {presence: required, value: 3.0} - -}}, - -voiceQualityFields: {presence: required, structure: { - -voiceQualityFieldsVersion: {presence: required, value: 2.0}, - -calleeSideCodec: {presence: required}, - -callerSideCodec: {presence: required}, - -correlator: {presence: required}, - -remoteIpAddress: {presence: required}, - -endOfCallVqmSummaries: {presence: required, structure: { - -adjacencyName: {presence: required}, - -endpointDescription: {presence: required}, - -endpointAverageJitter: {presence: optional}, - -endpointMaxJitter: {presence: optional}, - -endpointRtpOctetsLost: {presence: optional}, - -endpointRtpPacketsLost: {presence: optional}, - -endpointRtpOctetsDiscarded: {presence: optional}, - -endpointRtpOctetsReceived: {presence: optional}, - -endpointRtpOctetsSent: {presence: optional}, - -endpointRtpPacketsDiscarded: {presence: optional}, - -endpointRtpPacketsReceived: {presence: optional}, - -endpointRtpPacketsSent: {presence: optional}, - -localAverageJitter: {presence: optional}, - -localMaxJitter: {presence: optional}, - -localAverageJitterBufferDelay: {presence: optional}, - -localMaxJitterBufferDelay: {presence: optional}, - -localRtpOctetsDiscarded: {presence: optional}, - -localRtpOctetsLost: {presence: optional}, - -localRtpOctetsReceived: {presence: optional}, - -localRtpOctetsSent: {presence: optional}, - -localRtpPacketsDiscarded: {presence: optional}, - -localRtpPacketsLost: {presence: optional}, - -localRtpPacketsReceived: {presence: optional}, - -localRtpPacketsSent: {presence: optional}, - -mosCqe: {presence: optional}, - -oneWayDelay: {presence: optional}, - -packetLossPercent: {presence: optional}, - -rFactor: {presence: optional}, - -roundTripDelay: {presence: optional} - -}}, - -phoneNumber: {presence: required}, - -midCallRtcp: {presence: required}, - -vendorVnfNameFields: {presence: required, structure: { - -vendorName: {presence: required}, - -vfModuleName: {presence: optional}, - -vnfName: {presence: optional} - -}}, - -additionalInformation: {presence: optional, array: [ - -keyValuePair: {presence: required, structure: { - -key: {presence: required, value: name1}, - -value: {presence: required} - -}}, - -keyValuePair: {presence: optional, structure: { - -key: {presence: required, value: name2}, - -value: {presence: required} - -}} - -]} - -}} - -}} - -... - -.. _rules-1: - -Rules ------ - ---- - -#Rules - -Rules: [ - -ruleName1: { - -trigger: "CpuUsageHigh \|\| FreeMemLow \|\| AudioCoreUsageHigh \|\| - -VideoCoreUsageHigh \|\| HcVideoCoreUsageHigh", - -microservices: [scaleOut] - -}, - -ruleName2: { - -trigger: "CpuUsageLow && FreeMemHigh && AudioCoreUsageLow && - -VideoCoreUsageLow && HcVideoCoreUsageLow", - -microservices: [scaleIn] - -} - -] - -... - -Appendix: Historical Change Log -=============================== - -For the latest changes, see the Change Block just before the Table of -Contents. - -+-----------------------+-----------------------+-----------------------+ -| Date | Revision | Description | -+-----------------------+-----------------------+-----------------------+ -| 3/15/2017 | 1.0 | This is the initial | -| | | release of the VES | -| | | Event Registration | -| | | document. | -+-----------------------+-----------------------+-----------------------+ -| 3/22/2017 | 1.1 | - Changed the | -| | | ‘alert’ | -| | | qualifier to | -| | | ‘action’ and | -| | | added support | -| | | for conditions | -| | | that will | -| | | trigger rules. | -| | | | -| | | - Formatted the | -| | | document with | -| | | more sections | -| | | and | -| | | subsections. | -| | | | -| | | - Defined the syntax | -| | | and semantics | -| | | for condition | -| | | based rules. | -| | | | -| | | - Fixed the YAML | -| | | examples. | -+-----------------------+-----------------------+-----------------------+ -| 3/27/2017 | 1.2 | - Clarified the | -| | | audience of the | -| | | document and | -| | | the | -| | | expectations | -| | | for vendors. | -| | | | -| | | - Changed the order | -| | | of fields in | -| | | the action | -| | | keyword. | -| | | | -| | | - Updated the YAML | -| | | examples. | -| | | | -| | | - Wordsmithed | -| | | throughout. | -+-----------------------+-----------------------+-----------------------+ -| 3/31/2017 | 1.3 | - Generalized the | -| | | descriptions | -| | | from an ASDC, | -| | | ECOMP and | -| | | AT&T-specific | -| | | interaction | -| | | with a VNF | -| | | vendor, to a | -| | | generic Service | -| | | Provider | -| | | interaction | -| | | with a VNF | -| | | vendor. | -| | | | -| | | - Wordsmithed | -| | | throughout. | -| | | | -| | | - Added a ‘default’ | -| | | qualifier | -| | | | -| | | - Fixed syntax and | -| | | semantic | -| | | inconsistencies | -| | | in the Rules | -| | | section | -| | | | -| | | - Brought all | -| | | examples into | -| | | compliance with | -| | | v5.0 | -| | | | -| | | - Added a heartbeat | -| | | example | -| | | | -| | | - Modified the | -| | | measurement | -| | | example | -| | | | -| | | - Modified the | -| | | syslog example | -| | | | -| | | - Added two complex | -| | | rules | -+-----------------------+-----------------------+-----------------------+ -| 4/14/2017 | 1.4 | - Wordsmithed | -| | | throughout | -| | | | -| | | - Action keyword: | -| | | clarified use | -| | | of ‘up’, ‘down’ | -| | | and ‘at’ | -| | | triggers; | -| | | clarified the | -| | | specification | -| | | and use of | -| | | microservices | -| | | directives at | -| | | design time and | -| | | runtime, | -| | | clarified the | -| | | use of tca’s | -| | | | -| | | - HeartbeatAction | -| | | keyword: Added | -| | | the | -| | | heartbeatAction | -| | | keyword | -| | | | -| | | - Value keyword: | -| | | clarified the | -| | | communicaton of | -| | | strings | -| | | containing | -| | | spaces. | -| | | | -| | | - Rules: corrected | -| | | the use of | -| | | quotes in | -| | | examples | -| | | | -| | | - Examples: added | -| | | the | -| | | heartbeatAction | -| | | keyword on the | -| | | heartbeat event | -| | | example; also | -| | | corrected use | -| | | of quotes | -| | | throughout. | -+-----------------------+-----------------------+-----------------------+ -| 10/3/2017 | 1.5 | - Back of Cover | -| | | Page: updated the | -| | | license and | -| | | copyright notice | -| | | to comply with | -| | | ONAP guidelines | -| | | | -| | | - Section 3.1: Added | -| | | a ‘Units’ | -| | | qualifier | -| | | | -| | | - Examples: updated | -| | | the examples to | -| | | align with VES | -| | | 5.4.1 | -+-----------------------+-----------------------+-----------------------+ -| 10/31/2017 | 1.6 | - Added | -| | | KeyValuePairString | -| | | keyword to handle | -| | | strings which have | -| | | delimited | -| | | key-value pairs | -| | | within them. | -| | | | -| | | - Updated the syslog | -| | | example to show | -| | | the use of | -| | | KeyValuePairStr | -| | | ing | -| | | | -| | | - Updated the syslog | -| | | example to | -| | | align syslogSev | -| | | with VES 5.4.1 | -| | | | -| | | - Added examples for | -| | | mobile flow, | -| | | sip signaling | -| | | and voice | -| | | quality | -| | | | -| | | - Added sections | -| | | within the | -| | | examples to | -| | | facilitate | -| | | rapid access to | -| | | specific types | -| | | of example | -| | | events | -| | | | -| | | - Wordsmithed the | -| | | Introduction | -+-----------------------+-----------------------+-----------------------+ -| 6/28/2018 | 2.0 | - Updated to align | -| | | with the change of | -| | | the | -| | | ‘measurementsForVf | -| | | Scaling’ | -| | | domain to | -| | | ‘measurement’ | -| | | | -| | | - measurementsFor | -| | | VfScaling | -| | | measurement | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | measurementFiel | -| | | ds | -| | | | -| | | - measurementsFor | -| | | VfScalingVersion | -| | | measurementFiel | -| | | dsVersion | -| | | | -| | | - the ‘mfvs’ | -| | | abbreviation | -| | | measurement | -| | | | -| | | 1. Clarified YAML | -| | | file naming | -| | | | -| | | 2. Clarified the | -| | | Action keyword. | -| | | | -| | | 3. Added an | -| | | aggregationRole | -| | | keyword. | -| | | | -| | | 4. Added a castTo | -| | | keyword. | -| | | | -| | | 5. Added an | -| | | isHomogeneous | -| | | keyword. | -| | | | -| | | 6. Added a 'key' | -| | | keyword | -| | | | -| | | 7. Add a | -| | | 'keyValuePair' | -| | | keyword | -| | | | -| | | 8. Modified the | -| | | existing | -| | | 'keyValuePairStri | -| | | ng' | -| | | keyword | -| | | description to | -| | | reference the | -| | | 'keyValuePair' | -| | | keyword. | -| | | | -| | | 9. Added a section | -| | | on Complex | -| | | Conditions and | -| | | modified the | -| | | Rules section | -| | | | -| | | 10. Modified the | -| | | Examples as | -| | | follows: | -| | | | -| | | - changed | -| | | ‘faultFieldsVer | -| | | sion’ | -| | | to 3.0 | -| | | | -| | | - changed | -| | | ‘heartbeatField | -| | | sVersion’ | -| | | to 2.0 | -| | | | -| | | - provided guidance | -| | | at the top of | -| | | the | -| | | Measurements | -| | | examples as to | -| | | how to send | -| | | extensible | -| | | fields through | -| | | arrayOfNamedHas | -| | | hMap | -| | | in a way that | -| | | will eliminate | -| | | the need for | -| | | custom | -| | | development at | -| | | the service | -| | | provider. | -| | | | -| | | - changed | -| | | ‘measurementFie | -| | | ldsVersion’ | -| | | to 3.0 | -| | | | -| | | - changed | -| | | measurementFiel | -| | | ds.additionalMeasurem | -| | | ents | -| | | to reference a | -| | | ‘namedHashMap’ | -| | | | -| | | - ‘field’ is | -| | | replaced by | -| | | ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced | -| | | by ‘key’ | -| | | | -| | | - changed | -| | | ‘namedArrayOfFi | -| | | elds’ | -| | | to | -| | | ‘namedHashMap’ | -| | | | -| | | - fixed the mobile | -| | | Flow example to | -| | | show the | -| | | ‘mobileFlowFiel | -| | | ds’, | -| | | show the | -| | | ‘mobileFlowFiel | -| | | dsVersion’ | -| | | at 3.0, modify | -| | | ‘additionalInfo | -| | | rmation’ | -| | | to use a | -| | | hashMap | -| | | | -| | | - ‘field’ is | -| | | replaced by | -| | | ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced | -| | | by ‘key’ | -| | | | -| | | - changed | -| | | ‘sipSignalingFi | -| | | eldsVersion’ | -| | | to 2.0 | -| | | | -| | | - changed | -| | | ‘additionalInfo | -| | | rmation’ | -| | | to use a | -| | | hashmap | -| | | | -| | | - ‘field’ is | -| | | replaced by | -| | | ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced | -| | | by ‘key’ | -| | | | -| | | - fixed the | -| | | voiceQuality | -| | | example to show | -| | | the | -| | | ‘voiceQualityFi | -| | | elds’, | -| | | show the | -| | | ‘voiceQualityFi | -| | | eldsVersion’ | -| | | at 2.0 and | -| | | modify | -| | | ‘additionalInfo | -| | | rmation’ | -| | | to use a | -| | | hashMap | -| | | | -| | | - ‘field’ is | -| | | replaced by | -| | | ‘keyValuePair’ | -| | | | -| | | - ‘name’ is replaced | -| | | by ‘key’ | -| | | | -| | | - Modified the rules | -| | | example to conform | -| | | to the Complex | -| | | Conditions and | -| | | Rules sections. | -| | | | -| | | - Numerous | -| | | clarifications | -| | | made to address | -| | | issues with | -| | | previous drafts of | -| | | this version | -| | | including: | -| | | | -| | | - Fixed arrays | -| | | followed by | -| | | other than | -| | | square brackets | -| | | | -| | | - Section 2.2: | -| | | clarified | -| | | format of v# in | -| | | filename | -| | | | -| | | - Section 3.1.11: | -| | | clarified use | -| | | of camel casing | -| | | | -| | | - Section 3.2.1: | -| | | corrected and | -| | | clarified | -| | | | -| | | - Section 3.2.3 | -| | | Clarified | -| | | number of | -| | | conditions that | -| | | may be and’d or | -| | | or’d | -| | | | -| | | - Section 3.2.4: | -| | | fixed reference | -| | | to PersistentB1 | -| | | | -| | | - Section 3.2.6: | -| | | fixed math in | -| | | example | -| | | | -| | | - Section 3.3.2: | -| | | changed reference | -| | | from ‘alerts’ to | -| | | ‘events’ | -+-----------------------+-----------------------+-----------------------+ diff --git a/docs/files/VES_Registraion_3_2.rst b/docs/files/VES_Registraion_3_2.rst deleted file mode 100644 index 29b6059..0000000 --- a/docs/files/VES_Registraion_3_2.rst +++ /dev/null @@ -1,3298 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property, All rights reserved
-.. Copyright 2017-2018 Huawei Technologies Co., Ltd.
-
-===================================
-Service: VES Event Registration 3.2
-===================================
-
-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Legal Disclaimer** |
-| |
-| 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 |
-| |
-| http://www.apache.org/licenses/LICENSE-2.0 |
-| |
-| 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. See the License for the specific language governing permissions and limitations under the License. |
-+=====================================================================================================================================================================================================================================================================================================================+
-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-+-------------------+--------------------------+
-| Document Number | VES Event Registration |
-+-------------------+--------------------------+
-| Revision | 3.2 |
-+-------------------+--------------------------+
-| Revision Date | December 10, 2018 |
-+-------------------+--------------------------+
-| Author | Rich Erickson |
-+-------------------+--------------------------+
-
-+-----------------+------------------------------+
-| Contributors: | **Shau-Ann Chang – AT&T** |
-| | |
-| | **Min Chen – AT&T** |
-| | |
-| | **Marge Hills – Nokia** |
-| | |
-| | **Linda Horn – Nokia** |
-| | |
-| | **Alok Gupta – AT&T** |
-| | |
-| | **Zu Qiang – Ericsson** |
-| | |
-| | **Paul Sulewski – Nokia** |
-+-----------------+------------------------------+
-
-Introduction
-============
-
-This document specifies a YAML format for the registration of VES
-Events. The YAML format enables both human designers and applications to
-parse and understand the fields that will be sent by event sources in
-conjunction with specific types of events, which are identified by their
-eventNames.
-
-The semantics of the YAML format are easily extensible to accommodate
-processing needs that may arise in the future. Among the types of
-information specified in the YAML are field optionality, restrictions on
-field values, and event handling recommendations and requirements.
-
-This document should be read in conjunction with the VES Event Listener
-service specification, which defines the Common Event Format and
-introduces the concept of specific types of events, identified by
-eventNames.
-
-Audience
---------
-
-This document is intended to support the following groups:
-
-- VNF Vendors
-
-- Service Provider (e.g., AT&T) Teams responsible for deploying VNFs
- within their infrastructure
-
-VNF vendors will provide a YAML file to the Service Provider that
-describes the events that their VNFs generate. Using the semantics and
-syntax supported by YAML, vendors will indicate specific conditions that
-may arise, and recommend actions that should be taken at specific
-thresholds, or if specific conditions repeat within a specified time
-interval.
-
-Based on the vendor’s recommendations, the Service Provider may create
-another YAML, which finalizes their engineering rules for the processing
-of the vendor’s events. The Service Provider may alter the threshold
-levels recommended by the vendor, and may modify and more clearly
-specify actions that should be taken when specified conditions arise.
-The Service Provided-created version of the YAML will be distributed to
-Service Provider applications at design time.
-
-Goal
-----
-
-The goal of the YAML is to completely describe the processing of VNF
-events in a way that can be compiled or interpreted by applications
-across a Service Provider’s infrastructure.
-
-Relation to the Common Event Format
------------------------------------
-
-The Common Event Format described in the VES Event Listener service
-specification defines the structure of VES events including optional
-fields that may be provided.
-
-Specific eventNames registered by the YAML (e.g., an InvalidLicense
-fault), may require that certain fields, which are optional in the
-Common Event Format, be present when events with that eventName are
-published. For example, a fault eventName which communicates an
-‘InvalidLicense’ condition, may be registered to require that the
-configured ‘licenseKey’ be provided as a name-value pair in the Common
-Event Format’s ‘additionalFields’ structure, within the ‘faultFields’
-block. Anytime an ‘InvalidLicense’ fault event is detected, designers,
-applications and microservices across the Service Provider’s
-infrastructure can count on that name-value pair being present.
-
-The YAML registration may also restrict ranges or enumerations defined
-in the Common Event Format. For example, eventSeverity is an enumerated
-string within the Common Event Format with several values ranging from
-‘NORMAL’ to ‘CRITICAL’. The YAML registration for a particular eventName
-may require that it always be sent with eventSeverity set to a single
-value (e.g., ‘MINOR’), or to a subset of the possible enumerated values
-allowed by the Common Event Format (e.g., ‘MINOR’ or ‘NORMAL’).
-
-Relation to Service Design and Creation
----------------------------------------
-
-Event registration for a VNF (or other event source) is provided to the
-Service Provider’s Service Creation and Design Environment (e.g., ASDC)
-as a set of two YAML files consisting of the vendor recommendation YAML
-and (optionally) the final Service Provider YAML. These YAML files
-describe all the eventNames that that VNF (or other event source)
-generates.
-
-Once their events are registered, the Service Creation and Design
-Environment can then list the registered eventNames (e.g., as a drop
-down list), for each VNF or other event source (e.g., a service), and
-enable designers to study the YAML registrations for specific
-eventNames. YAML registrations are both human readable and machine
-readable.
-
-The final Service Provider YAML is a type of Service Design and Creation
-‘artifact’, which can be distributed to Service Provider applications at
-design time: notably, to applications involved in the collection and
-processing of VNF events. It can be parsed by those applications so they
-can support the receipt and processing of VNF events, without the need
-for any manual, VNF-specific development.
-
-YAML Files
-==========
-
-YAML Specification Conformance
-------------------------------
-
-YAML files should conform to version 1.2 of the YAML specification
-available at: http://yaml.org/spec/1.2/spec.html.
-
-Filename
---------
-
-YAML file names should conform to the following naming convention:
-
- {AsdcModel}\_{AsdcModelType}\_{v#}.yml
-
-The ‘#’ should be replaced with the current numbered version of the
-file.
-
-‘ASDC’ is a reference to the Service Provider’s Service Design and
-Creation environment. The AsdcModelType is an enumeration with several
-values of which the following three are potentially relevant:
-
-- Service
-
-- Vnf
-
-- VfModule
-
-The AsdcModel is the modelName of the specific modelType whose events
-are being registered (e.g., the name of the specific VNF or service as
-it appears in the the Service Design and Creation Environment).
-
-For example:
-
-- vMRF\_Vnf\_v1.yml
-
-- vMRF\_Service\_v1.yml
-
-- vIsbcSsc\_VfModule\_v1.yml
-
-File Structure
---------------
-
-Each eventType is registered as a distinct YAML ‘document’.
-
-YAML files consist of a series of YAML documents delimited by ‘---‘ and
-‘…’ for example:
-
- ---
-
- # Event Registration for eventName ‘name1’
-
- # details omitted
-
- ...
-
- ---
-
- # Event Registration for eventName ‘name2’
-
- # details omitted
-
- ...
-
- ---
-
- # Event Registration for eventName ‘name3’
-
- # details omitted
-
- ...
-
-YAML Syntax and Semantics
-=========================
-
-YAML registration documents show each relevant VES Common Event Model
-object and field (i.e., each element) for the eventName being
-registered, including any extensible fields (e.g., specific name-value
-pairs).
-
-Qualifiers
-----------
-
-Each object or field name in the eventName being registered is followed
-by a ‘qualifier’, which consists of a colon and two curly braces, for
-example:
-
- “objectOrFieldName: { }”
-
-The curly braces contain meta-information about that object or field
-name (also known as the ‘element’), such as whether it is required to be
-present, what values it may have, what handling it should trigger, etc…
-
-Semantics have been defined for the following types of meta-information
-within the curly braces:
-
-Action
-~~~~~~
-
-The ‘action’ keyword may be applied to field values or to the event as a
-whole. The ‘action’ keyword specifies a set of actions that should be
-taken if a specified trigger occurs. For example, the ‘action’ keyword
-may specify that a threshold crossing alert (i.e., tca) be generated,
-and/or that a specific microservice handler be invoked, and/or that a
-specific named-condition be asserted. In the Rules section of the YAML
-file, tca’s and microservices may be defined on individual
-named-conditions or on logical combinations of named-conditions.
-
-The ‘action:’ keyword is followed by five values in square brackets. The
-first two values communicate the trigger, and the last three values
-communicate the actions to be taken if that trigger occurs:
-
-1. The first value conveys the trigger level. If the field on which the
- action is defined reaches or passes through that level, then the
- trigger fires. If a specific level is not important to the
- recommended action, the ‘any’ keyword may be used as the first value.
- (Note: ‘any’ is often used when an action is defined on the ‘event’
- structure as a whole).
-
-2. The second value indicates the direction of traversal of the level
- specified in the first value. The second value may be ‘up’, ‘down’,
- ‘at’ or ‘any’. ‘any’ is used if the direction of traversal is not
- important. ‘at’ implies that it traversed (or exactly attained) the
- trigger level but it doesn’t matter if the traversal was in the up
- direction or down direction. Note: If ‘up’, ‘down’ or ‘at’ are used,
- the implication is that the microservices processing the events
- within the service provider are maintaining state (e.g., to know that
- a measurement field traversed a trigger level in an ‘up’ direction,
- the microservice would have to know that the field was previously
- below the trigger level). When initially implementing support for
- YAML actions, a service provider may choose to use and interpret
- these keywords in a simpler way to eliminate the need to handle
- state. Specifically, they may choose to define and interpret all ‘up’
- guidance to mean ‘at the indicated trigger level or greater’, and
- they may choose to define and interpret all ‘down’ guidance to mean
- ‘at the indicated trigger level or lower’.
-
-3. The third value optionally names the condition that has been attained
- when the triggers fires (e.g., ‘invalidLicence’ or
- ‘capacityExhaustion’). Named-conditions should be expressed in upper
- camel case with no underscores, hyphens or spaces. In the Rules
- section of the YAML file, named-conditions may be used to specify
- tca’s that should be generated and/or microservices that should be
- invoked. If it is not important to name a condition, then the keyword
- ‘null’ may be used as the third value.
-
-4. The fourth value recommends a specific microservice (e.g., ‘rebootVm’
- or ‘rebuildVnf’) supported by the Service Provider, be invoked if the
- trigger is attained. Design time processing of the YAML by the
- service provider can use these directives to automatically establish
- policies and configure flows that need to be in place to support the
- recommended runtime behavior.
-
- If a vendor wants to recommend an action, it can either work with
- the service provider to identify and specify microservices that the
- service provider support, or, the vendor may simply indicate and
- recommend a generic microservice function by prefixing ‘RECO-’ in
- front of the microservice name, which should be expressed in upper
- camel case with no underscores, hyphens or spaces.
-
- The fourth value may also be set to ‘null’.
-
-1. The fifth value third value indicates a specific threshold crossing
- alert (i.e., tca) that should be generated if the trigger occurs.
- This field may be omitted or provided as ‘null’.
-
- Tca’s should be indicated by their eventNames.
-
- When a tca is specified, a YAML registration for that tca eventName
- should be added to the event registrations within the YAML file.
-
-Examples:
-
-- event: { action: [ any, any, null, rebootVm ] }
-
- # whenever the above event occurs, the VM should be rebooted
-
-- fieldname: { action: [ 80, up, null, null, tcaUpEventName ], action:
- [ 60, down, overcapacity, null ] }
-
- # when the value of fieldname crosses 80 in an up direction,
- tcaUpEventName
-
- should be published; if the fieldname crosses 60 in a down direction
- an
-
- ‘overCapacity’ named-condition is asserted.
-
-AggregationRole
-~~~~~~~~~~~~~~~
-
-The ‘aggregationRole’ keyword is applied to the value keyword in a field
-of a name-value pair.
-
-AggregationRole may be set to one of the following:
-
-- cumulativeCounter
-
-- gauge
-
-- index
-
-- reference
-
-“index” identifies a field as an index or a key for aggregation.
-
-“reference” fields have values that typically do not change over
-consecutive collection intervals.
-
-“gauge” values may fluctuate from one collection interval to the next,
-i.e., increase or decrease.
-
-“cumulativeCounter” values keep incrementing regardless of collection
-interval boundaries until they overflow, i.e., until they exceed a
-maximum value specified by design. Typically, delta calculation is
-needed based on two cumulativeCounter values over two consecutive
-collection intervals.
-
-If needed, the aggergationRole setting tells the receiving event
-processor how to aggregate the extensible keyValuePair data. Data
-aggregation may use a combination of ‘index’ and ‘reference’ data fields
-as aggregation keys while applying aggregation formulas, such as
-summation or average on the ‘gauge’ fields.
-
-Example 1:
-
- Interpretation of the below: If additionalMeasurements is supplied,
- it must have key name1 and name1’s value should be interpreted as an
- index:
-
-- additionalMeasurements: {presence: optional, array: [
-
- {
-
- name: {presence: required},
-
- arrayOfFields: {presence: required, array: [
-
- {
-
- name: {presence: required, value: name1},
-
- value: {presence: required, aggregationRole: index}
-
- }
-
- ] }
-
- }
-
- ] }
-
-Example 2:
-
-- Let’s say a vnf wants to send the following ‘TunnelTraffic’ fields
- through a VES arrayOfFields structure (specifically through
- additionalMeasurements in the VES measurementField block):
-
-+-----------------------------+---------------+----------------------+------------------------+-----------------------+
-| Tunnel Name | Tunnel Type | Total Output Bytes | Total Output Packets | Total Output Errors |
-+=============================+===============+======================+========================+=======================+
-| ST6WA21CRS:TUNNEL-TE40018 | PRIMARY | 2457205 | 21505 | 0 |
-+-----------------------------+---------------+----------------------+------------------------+-----------------------+
-| ST6WA21CRS:TUNNEL-TE1029 | PRIMARY | 46677 | 220 | 0 |
-+-----------------------------+---------------+----------------------+------------------------+-----------------------+
-| ST6WA21CRS:TUNNEL-TE1028 | PRIMARY | 80346 | 577 | 0 |
-+-----------------------------+---------------+----------------------+------------------------+-----------------------+
-
-- Tunnel Name is an index, Tunnel Type is reference data and the other
- three columns are counters
-
-- The first three columns would be sent through VES as follows:
-
- additionalMeasurements: {presence: required, array: [
-
- {
-
- name: {presence: required, value: TunnelTraffic},
-
- arrayOfFields: {presence: required, array: [
-
- {
-
- name: {presence: required, value: TunnelName},
-
- value: {presence: required, aggregationRole: index},
-
- },
-
- {
-
- name: {presence: required, value: TunnelType},
-
- value: {presence: required, aggregationRole: reference}
-
- },
-
- {
-
- name: {presence: required, value: TotalOutputBytes},
-
- value: {presence: required, aggregationRole: gauge, castTo:
- number}
-
- }
-
- ]}
-
- }
-
- ]}
-
-Array
-~~~~~
-
-The ‘array’ keyword indicates that the element is an array; ‘array:’ is
-following by square brackets which contain the elements of the array.
-Note that unlike JSON itself, the YAML registration will explicitly
-declare the array elements and will not communicate them anonymously.
-
-Examples:
-
-- element: { array: [
-
- firstArrayElement: { },
-
- secondArrayElement: { }
-
- ] }
-
-CastTo
-~~~~~~
-
-The ‘castTo’ keyword is applied to ‘value’ keywords. It tells the
-receiving event processor to cast (or interpret) the supplied value from
-its standard VES datatype (typically a string) to some other datatype.
-If not supplied the implication is the standard VES datatype applies.
-
-A value may be castTo one and only one of the following data types:
-
-- boolean
-
-- integer
-
-- number (note: this supports decimal values as well as integral
- values)
-
-- string
-
-Example:
-
-- fieldname: { value: [ x, y, z ], castTo: number } # only values ‘x’,
- ‘y’, or ‘z’ allowed
-
- # each must be cast to a number
-
-- additionalMeasurements: {presence: optional, array: [
-
- {
-
- name: {presence: required},
-
- arrayOfFields: {presence: required, array: [
-
- {
-
- name: {presence: required, value: name1},
-
- value: {presence: required, castTo: number}
-
- }
-
- ] }
-
- }
-
- ] }
-
- For another example, see the second example under AggregationRole.
-
-Comment
-~~~~~~~
-
-The ‘comment’ keyword enables event registrations to communicate
-additional information, in the form of a quoted string, to designers
-consuming the event registration. Such additional information might
-convey meaning, instructions or potential effects associated with
-particular fields or with the event as a whole.
-
-Examples:
-
-- fieldname: { range: [ 1, unbounded ], default: 5, comment: “needs
- further diagnosis; call the TAC” }
-
-- fieldname: { value: [ red, white, blue ], default: blue, comment:
- “red indicates degraded quality of service” }
-
-- event: { presence: required, comment: “this event only occurs in
- conditions when the ipq has stopped operating; manual reset may
- be required”, structure: { . . . } }
-
-Default
-~~~~~~~
-
-The ‘default’ keyword specifies a default field value. Note: the default
-value must be within the range or enumeration of acceptable values.
-
-Examples:
-
-- fieldname: { range: [ 1, unbounded ], default: 5 }
-
-- fieldname: { value: [ red, white, blue ], default: blue }
-
-HeartbeatAction
-~~~~~~~~~~~~~~~
-
-The ‘heartbeatAction’ keyword is provided on the ‘event’ objectName for
-heartbeat events only. It provides design time guidance to the service
-provider’s heartbeat processing applications (i.e., their watchdog
-timers). The syntax and semantics of the ‘heartbeatAction’ keyword are
-similar to the ‘action’ keyword except the trigger is specified by the
-first field only instead of the first two fields. When the
-‘heartbeatAction’ keyword is indicated, the first field is an integer
-indicating the number of successively missed heartbeat events. Should
-that trigger occur, the remaining fields have the same order, meaning
-and optionality as those described for the ‘action’ keyword.
-
-Examples:
-
-- event: { heartbeatAction: [ 3, vnfDown, RECO-rebootVnf, tcaEventName
- ] }
-
- # whenever the above event occurs, a vnfDown condition is asserted
- and the vnf should be rebooted, plus the indicated tca should be
- generated.
-
-keyValuePairString
-~~~~~~~~~~~~~~~~~~
-
-The ‘keyValuePairString’ keyword describes the key-value pairs to be
-communicated through a string (e.g., in the VES Syslog Fields
-‘syslogSData’ or ‘additionalFields’ strings). This keyword takes three
-parameters:
-
-- the first parameter specifies the character used to delimit (i.e., to
- separate) the key-value pairs. If a space is used as a delimiter,
- it should be communicated within single quotes as ‘ ‘; otherwise,
- the delimiter character should be provided without any quotes.
-
-- The second parameter specifies the characters used to separate the
- keys and values. If a space is used as a separator, it should be
- communicated within single quotes as ‘ ‘; otherwise, the
- separator character should be provided without any quotes.
-
-- The third parameter is a “sub-keyword” (i.e., it is used only within
- ‘keyValuePairString’) called ‘keyValuePairs: [ ]’. Within the
- square brackets, a list of ‘keyValuePair’ keywords can be
- provided as follows:
-
- - Each ‘keyValuePair’ is a structure (used only within
- ‘keyValuePairs’) which has a ‘key’ and a ‘value’. Each
- ‘keyValuePair’, ‘key’ and ‘value’ may be decorated with any of
- the other keywords specified in this specification (e.g., with
- ‘presence’, ‘value’, ‘range’ and other keywords).
-
-Examples:
-
-- The following specifies an additionalFields string which is stuffed
- with ‘key=value’ pairs delimited by the pipe (‘\|’) symbol as in
- (“key1=value1\|key2=value2\|key3=value3…”).
-
- additionalFields: {presence: required, keyValuePairString: {\|, =, keyValuePairs: [
-
- keyValuePair: {presence: required, structure: {
-
- key: {presence: required, value: someKeyName},
-
- value: {presence: required, range: [0, 100]}
-
- } },
-
- keyValuePair: {presence: optional, structure: {
-
- key: {presence: required, value: someOtherKeyName},
-
- value: {presence: required, value [red, white, blue]}
-
- } }
-
-] } }
-
-Presence
-~~~~~~~~
-
-The ‘presence’ keyword may be defined as ‘required’ or ‘optional’. If
-not provided, the element is assumed to be ‘optional’.
-
-Examples
-
-- element: { presence: required } # element must be present
-
-- element: { presence: optional } # element is optional
-
-- element: { value: blue } # by omitting a presence definition, the element is assumed to be optional
-
-Range
-~~~~~
-
-The ‘range’ keyword applies to fields (i.e., simpleTypes); indicates the
-value of the field is a number within a specified range of values from
-low to high (inclusive of the indicated values). . ‘range:’ is followed
-by two parameters in square brackets:
-
-- the first parameter conveys the minimum value
-
-- the second parameter conveys the maximum value or ‘unbounded’
-
-The keyword ‘unbounded’ is supported to convey an unbounded upper limit.
-Note that the range cannot override any restrictions defined in the VES
-Common Event Format.
-
-Examples:
-
-- fieldname: { range: [ 1, unbounded ] }
-
-- fieldname: { range: [ 0, 3.14 ] }
-
-Structure
-~~~~~~~~~
-
-The ‘structure’ keyword indicates that the element is a complexType
-(i.e., an object) and is followed by curly braces containing that
-object.
-
-Example:
-
-- objectName: { structure: {
-
- element1: { },
-
- element2: { },
-
- anotherObject: { structure: {
-
- element3: { },
-
- element4: { }
-
- } }
-
- } }
-
-Units
-~~~~~
-
-The ‘units’ qualifier may be applied to values provided in VES Common
-Event Format extensible field structures. The ‘units’ qualifier
-communicates the units (e.g., megabytes, seconds, Hz) that the value is
-expressed in. Note: the ‘units’ should not contain any space characters
-(e.g., use ‘numberOfPorts’ or ‘number\_of\_ports’ but not ‘number of
-ports’).
-
-Example:
-
-- field: { structure: {
-
- name: { value: pilotNumberPoolSize },
-
- value: { units: megabytes } # the value will be expressed in
- megabytes
-
- } }
-
-Value
-~~~~~
-
-The ‘value’ keyword applies to fields (i.e., simpleTypes); indicates a
-single value or an enumeration of possible values. If not provided, it
-is assumed the value will be determined at runtime. Note that the
-declared value cannot be inconsistent with restrictions defined in the
-VES Common Event Format (e.g., it cannot add an enumerated value to an
-enumeration defined in the Common Event Format, but it can subset the
-defined enumerations in the Common Event Format).
-
-Values that are strings containing spaces should always be indicated in
-single quotes.
-
-Examples:
-
-- fieldname: { value: x } # the value is ‘x’
-
-- fieldname: { value: [ x, y, z ] } # the value is either ‘x’, ‘y’, or
- ‘z’
-
-- fieldname: { presence: required } # the value will be provided at
- runtime
-
-- fieldname: { value: ‘error state’ } # the value is the string within
- the single quotes
-
-Rules
------
-
-Rules Document
-~~~~~~~~~~~~~~
-
-After all events have been defined, the YAML file may conclude with a
-final YAML document delimited by ‘---‘ and ‘…’, which defines rules
-based on the named ‘conditions’ asserted in action qualifiers in the
-preceding event definitions. For example:
-
- ---
-
- # Event Registration for eventName ‘name1’
-
- event: {presence: required, action: [any, any, A, null], structure:
- {
-
- # details omitted
-
- }}
-
- ...
-
- ---
-
- # Event Registration for eventName ‘name2’
-
- event: {presence: required, structure: {
-
- commonEventHeader: {presence: required, structure: {
-
- # details omitted
-
- }}
-
- measurements: {presence: required, structure: {
-
- cpuUsageArray: {presence: required, array: {
-
- cpuUsage: {presence: required, structure: {
-
- cpuIdentifier: {presence: required},
-
- percentUsage: {presence: required, action: [90, up, B, null]}
-
- }}
-
- }},
-
-# details omitted
-
- }}
-
- }}
-
- ...
-
- ---
-
- # Rules
-
- rules: [
-
- # defined based on conditions ‘A’ and ‘B’ - details omitted
-
- ]
-
- ...
-
-Rules Syntax and Semantics
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a
-colon and square brackets. Each rule is then defined within the square
-brackets. Commas are used to separate rules.
-
-Each rule is expressed as follows:
-
-rule: {
-
-trigger: *logical expression in terms of conditions*,
-
-microservices: [ *microservice1, microservice2, microservice3…* ]
-
-alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ],
-
-}
-
-Notes:
-
-- All referenced tcaEventNames should be defined within the YAML.
-
-- For information about microservices, see section 3.1.1 bullet number
- 4.
-
-- At least one microservice or alert should be specified, and both
- microservices and alerts may be specified.
-
-Simple Triggers
-~~~~~~~~~~~~~~~
-
-The trigger is based on the named ‘conditions’ asserted in the action
-qualifiers within the event definitions earlier in the YAML file. The
-following logical operators are supported:
-
-- &: which is a logical AND
-
-- \|\|, which is a logical OR
-
-In addition parentheses may be used to group expressions.
-
-Example logical expression:
-
- (A & B) \|\| (C & D)
-
-Where A, B, C and D are named conditions expressed earlier in the YAML
-file.
-
-Example rules definition:
-
-rules: [
-
- rule: {
-
- trigger: A,
-
- alerts: [tcaEventName1],
-
- microservices: [rebootVm]
-
- },
-
- rule: {
-
- trigger: B \|\| (C & D),
-
- microservices: [scaleOut]
-
- }
-
-]
-
-Note: when microservices are defined in terms of multiple event
-conditions, the designer should take care to consider whether the target
-of the microservice is clear (e.g., which VNF or VM instance to perform
-the action on). Future versions of this document may provide more
-clarity.
-
-Time Based Qualifiers
-~~~~~~~~~~~~~~~~~~~~~
-
-Time based rules may be established by following any named condition
-with a colon and curly braces. The time based rule is placed in the
-curly braces as follows:
-
-trigger: B:{3 times in 300 seconds}
-
-This means that if condition B occurs 3 (or more) times in 300 seconds
-(e.g., 5 minutes), the trigger fires.
-
-More complex triggers can be created as follows:
-
-trigger: B:{3 times in 300 seconds} \|\| (C & D:{2 times in 600
-seconds}),
-
-This means that the trigger fires if condition B occurs 3 (or more)
-times in 5 minutes, OR, if condition D occurs 2 (or more) times in 10
-minutes AND condition C is in effect.
-
-PM Dictionary
--------------
-
-The Performance Management (PM) Dictionary is used by analytics
-applications to interpret and process perf3gpp measurement information
-from vendors, including measurement name, measurement family, measured
-object class, description, collection method, value ranges, unit of
-measure, triggering conditions and other information. The ultimate goal
-is for analytics applications to dynamically process new and updated
-measurements based on information in the PM Dictionary.
-
-The PM dictionary is supplied by NF vendors in two parts:
-
-- *PM Dictionary Schema*: specifies meta-information about perf3gpp
- measurement events from that vendor. The meta-information is conveyed
- using standard meta-information keywords, and may be extended to
- include vendor-specific meta-information keywords. The PM Dictionary
- Schema may also convey a range of vendor-specific values for some of
- the keywords. Note: a vendor may provide multiple versions of the PM
- Dictionary Schema and refer to those versions from the PM Dictionary.
-
-- *PM Dictionary*: defines specific perf3gpp measurements sent by
- vendor NFs (each of which is compliant with a referenced PM
- Dictionary Schema).
-
-PM Dictionary Schema Keywords
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following is a list of standard PM Dictionary Schema Keywords:
-
-pmDictionaryHeader Keywords:
-
-+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+
-| **Keyword** | **Description** | **M / O** | **Example** |
-+==================+=============================================================================================================================+=============+===================+
-| nfType | NF type to whom this PM Dictionary applies. nfType is vendor defined and should match the string used in eventName. | M | gnb |
-+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+
-| pmDefSchemaVsn | Version of the PM Dictionary Schema used for this PM Dictionary. Schema versions are specified in the VES Specifications. | M | 1.0 |
-+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+
-| pmDefVsn | Version of the PM Dictionary. Version is vendor defined. | M | 5G19\_1906\_002 |
-+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+
-| vendor | Vendor of the NF type to whom this PM Dictionary applies. | M | Nokia |
-+------------------+-----------------------------------------------------------------------------------------------------------------------------+-------------+-------------------+
-
-pmDictionaryMeasurements Keywords:
-
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Keyword** | **Description** | **M / O** | **Example** |
-+========================+===================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+=================+=======================================================================================================================================================================+
-| iMeasInfoId | Vendor defined integer identifier for measInfoId for efficiency in GPB. | O | 2024 |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| iMeasType | Vendor defined integer identifier for measType for efficiency in GPB. | O | 2 |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measAdditionalFields | Hashmap of vendor specific PM Dictionary fields in key value pair format | O | measAggregationLevels |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measChangeType | For the measLastChange, indicates the type of change made for this measurement. Valid values are added, modified or deleted. Deleted measurements may be kept in the PM Dictionary for one release or more or permanently for historical purposes, if desired. | M | added |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measCollectionMethod | Collection Method for the measurement. 3GPP-defined collection methods are CC, SI, DER and Gauge. Collection Methods for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item b). Collection Methods for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). The measCollectionMethod values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined collection methods not specified by 3GPP; for example Average. | M | SI |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measCondition | Text description of the condition that causes the measurement to be updated. Conditions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item c). Conditions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item c). Vendors are free to augment or modify the 3GPP-provided conditions to more accurately describe their measurements as needed. | M | This measurement is obtained by sampling at a pre-defined interval, the number of users in RRC connected mode for each NR cell and then taking the arithmetic mean. |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measDescription | Text description of the purpose of the measurement, what information does the measurement provide. Descriptions for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item a). Descriptions for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item a). Vendors are free to augment or modify the 3GPP-provided descriptions to more accurately describe their measurements as needed. | M | This measurement provides the mean number of users in RRC connected mode during each granularity period. |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measFamily | Abbreviation for a family of measurements, in 3GPP format where specified, else vendor defined. Family name abbreviations for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family name abbreviations for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4. | O | RRC |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measInfoId | Name for a group of related measurements, in 3GPP format where specified, else vendor defined. Family names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 Section 3.1. Family names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 Section 3.4. | O | Radio Resource Control |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measLastChange | PM Dictionary version the last time this measurement was changed, added or deleted. | M | 5G18A\_1807\_003 |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measObjClass | Measurement Object Class. Object classes for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item f). Object classes for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item f). The measObjClass values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined objects not specified by 3GPP; for example IPSEC. | M | NRCellCU |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measResultRange | Range for the measurement result. The range is specified as a comma separated list of discrete values or a range of values specified as minimum value-maximum value with no spaces. Result ranges for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Result ranges for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. | O | |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measResultType | Data type of the measurement result. Result data types for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d). Result data types for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d). The measResultType values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined data types not specified by 3GPP; for example boolean. | M | |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measResultUnits | Unit of measure for the result; e.g. milliseconds, bytes, kilobytes, packets, number. Unit of measure for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item d) if applicable. Unit of measure for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item d) if applicable. The measResultsUnits values supported by a vendor are specified in the PM Dictionary YAML using the “value” attribute and may include vendor-defined units of measure not specified by 3GPP; for example ethernet frames. | O | |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measType | Measurement name used in PM file, in 3GPP format where specified, else vendor defined. Names for 3GPP-defined 4G measurements are specified in 3GPP TS 32.425 item e). Names for 3GPP-defined 5G measurements are specified in 3GPP TS 28.552 item e). Vendor defined names are preceded with VS. | M | RRC.ConnMean |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sMeasInfoId | Vendor defined string identifier for measInfoId; could be the same as measInfoId or shortened version like measFamily for efficiency in GPB. | O | RRC |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sMeasType | Vendor defined string identifier for measType; could be the same as measType or it could be a shortened version for efficiency in GPB. | O | RRC.ConnMean |
-+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-PM Dictionary Schema Example
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following is a sample PM Dictionary Schema:
-
----
-
-# PM Dictionary schema specifying and describing the meta information
-used to define perf3gpp measurements in the PM Dictionary
-
-pmDictionary: { presence: required, structure: {
-
- pmDictionaryHeader: { presence: required, structure: {
-
- nfType: { presence: required, comment: "NF type; should match the string used in the perf3gpp eventName"},
-
- pmDefSchemaVsn: { presence: required, value: 1.0, comment: "PM
-Dictionary Schema Version"},
-
- pmDefVsn: { presence: required, comment: "vendor-defined PM Dictionary version"},
-
- vendor: { presence: required, comment: "vendor of the NF type"}
-
- }},
-
-pmDictionaryMeasurements: { presence: required, array: [
-
- iMeasInfoId: { presence: required, comment: "vendor-defined integer
-measurement group identifier"},
-
- iMeasType: { presence: required, comment: "vendor-defined integer
-identifier for the measType; must be combined with measInfoId to identify a specific measurement."},
-
- measAdditionalFields: { presence: required, comment: "vendor-specific PM Dictionary fields", array: [
-
- keyValuePair: { presence: required, structure: {
-
- key: { presence: required, value: measAggregationLevels, comment:
-"Nokia-specific field"},
-
- value: { presence: required, value: [NGBTS, NGCELL, IPNO, IPSEC, ETHIF],comment: "list of one or more aggregation levels that Nokia recommends for this measurement; for example, if the value is NGBTS NGCELL, then Nokia recommends this measurement be aggregated on
-the 5G BTS level and the 5G Cell level"}
-
- }}
-
-]},
-
-measChangeType: { presence: required, value: [added, modified, deleted],
-comment: "indicates the type of change that occurred during measLastChange"},
-
-measCollectionMethod: { presence: required, value: [CC, SI, DER, Gauge,
-Average], comment: "the measurement collection method; CC, SI, DER and Gauge are as defined in 3GPP; average contains the average value of the measurement during the granularity period"},
-
-measCondition: { presence: required, comment: "description of the
-condition causing the measurement"},
-
-measDescription: { presence: required, comment: "description of the
-measurement information and purpose"},
-
-measFamily: { presence: required, comment: "abbreviation for a family of
-measurements, in 3GPP format,or vendor defined"},
-
-measInfoId: { presence: required, comment: "name for a group of related
-measurements in 3GPP format or vendor defined"},
-
-measLastChange: { presence: required, comment: "version of the PM
-Dictionary the last time this measurement was added, modified or deleted"},
-
-measObjClass: { presence: required, value: [NGBTS, NGCELL, IPNO, IPSEC,
-ETHIF], comment: "measurement object class"},
-
-measResultRange: { presence: optional, comment: "range of the
-measurement result; only necessary when the range is smaller than the full range of the data type"},
-
-measResultType: { presence: required, value: [float, unit32, uint64],
-comment: "data type of the measurement result"},
-
-measResultUnits: { presence: required, value: [ seconds, minutes, nanoseconds, microseconds, dB, number, kilobytes, bytes, ethernetFrames, packets, users
-], comment: "units of measure for the measurement result"},
-
-measType: { presence: required, comment: "measurement name in 3GPP or
-vendor-specific format;
-
-vendor specific names are preceded with VS"}
-
-]}
-
-}}
-
-...
-
-PM Dictionary Example
-~~~~~~~~~~~~~~~~~~~~~
-
-The following is a sample PM Dictionary in both bracketed and
-indent-style YAML formats
-
----
-
-# PM Dictionary perf3gpp measurements for the Nokia gnb NF (bracket
-style yaml)
-
-pmDictionary: {
-
- pmDictionaryHeader: {
-
- nfType: gnb,
-
- pmDefSchemaVsn: 1.0,
-
- pmDefVsn: 5G19\_1906\_002,
-
- vendor: Nokia
-
- },
-
- pmDictionaryMeasurements: [
-
- {
-
- iMeasInfoId: 2204,
-
- iMeasType: 1,
-
- measAdditionalFields: {
-
- measAggregationLevels: "NGBTS NGCELL",
-
- },
-
- measCollectionMethod: CC,
-
- measCondition: "This measurement is updated when X2AP: SgNB Modification Required message is sent to MeNB with the SCG Change Indication set as PSCellChange.",
-
- measDescription: "This counter indicates the number of intra gNB intra
-frequency PSCell change attempts.",
-
- measFamily: NINFC,
-
- measInfoId: "NR Intra Frequency PSCell Change",
-
- measLastChange: 5G18A\_1807\_003,
-
- measObjClass: NGCELL,
-
- measResultRange: 0..4096,
-
- measResultType: integer,
-
- measResultUnits: number,
-
- measType: VS.NINFC.IntraFrPscelChAttempt
-
- },
-
- {
-
- iMeasInfoId: 2204,
-
- iMeasType: 2,
-
- measAdditionalFields: {
-
- measAggregationLevels: "NGBTS NGCELL",
-
- },
-
- measCollectionMethod: CC,
-
- measCondition: "This measurement is updated when the TDCoverall timer
-has elapsed before gNB receives the X2AP: SgNB Modification Confirm
-message.",
-
- measDescription: "This measurement the number of intra gNB intra
-frequency PSCell change failures due to TDCoverall timer expiry.",
-
- measFamily: NINFC,
-
- measInfoId: "NR Intra Frequency PSCell Change",
-
- measLastChange: 5G18A\_1807\_003,
-
- measObjClass: NGCELL,
-
- measResultRange: 0..4096,
-
- measResultType: integer,
-
- measResultUnits: number,
-
- measType: VS.NINFC.IntraFrPscelChFailTdcExp
-
- },
-
- {
-
- iMeasInfoId: 2204,
-
- iMeasType: 3,
-
- measAdditionalFields: {
-
- measAggregationLevels: "NGBTS NGCELL",
-
- },
-
- measCondition: "This measurement is updated when MeNB replies to X2AP:
-SgNB Modification Required message with the X2AP: SgNB Modification
-Refuse message.",
-
- measCollectionMethod: CC,
-
- measDescription: "This counter indicates the number of intra gNB intra
-frequency PSCell change failures due to MeNB refusal.",
-
- measFamily: NINFC,
-
- measInfoId: "NR Intra Frequency PSCell Change",
-
- measLastChange: 5G19\_1906\_002,
-
- measObjClass: NGCELL,
-
- measResultRange: 0..4096,
-
- measResultType: integer,
-
- measResultUnits: number,
-
- measType: VS.NINFC.IntraFrPscelChFailMenbRef
-
- }
-
- ]
-
-}
-
-...
-
----
-
-# PM Dictionary perf3gpp measurements for the Nokia gnb NF (indented
-style yaml)
-
-pmDictionary:
-
- pmDictionaryHeader:
-
- nfType: gnb
-
- pmDefSchemaVsn: 1.0
-
- pmDefVsn: 5G19\_1906\_002
-
- vendor: Nokia
-
- pmDictionaryMeasurements:
-
- -
-
- iMeasInfoId: 2204
-
- iMeasType: 1
-
- measAdditionalFields:
-
- measAggregationLevels: "NGBTS NGCELL"
-
- measCollectionMethod: CC
-
- measCondition: "This measurement is updated when X2AP: SgNB Modification Required message is sent to MeNB with the SCG Change Indication set as PSCellChange."
-
- measDescription: "This counter indicates the number of intra gNB intra
-frequency PSCell change attempts."
-
- measFamily: NINFC
-
- measInfoId: "NR Intra Frequency PSCell Change"
-
- measLastChange: 5G18A\_1807\_003
-
- measObjClass: NGCELL
-
- measResultRange: "0..4096"
-
- measResultType: integer
-
- measResultUnits: number
-
- measType: VS.NINFC.IntraFrPscelChAttempt
-
- -
-
- iMeasInfoId: 2204
-
- iMeasType: 2
-
- measAdditionalFields:
-
- measAggregationLevels: "NGBTS NGCELL"
-
- measCollectionMethod: CC
-
- measCondition: "This measurement is updated when the TDCoverall timer
-has elapsed before gNB receives the X2AP: SgNB Modification Confirm
-message."
-
- measDescription: "This measurement the number of intra gNB intra
-frequency PSCell change failures due to TDCoverall timer expiry."
-
- measFamily: NINFC
-
- measInfoId: "NR Intra Frequency PSCell Change"
-
- measLastChange: 5G18A\_1807\_003
-
- measObjClass: NGCELL
-
- measResultRange: "0..4096"
-
- measResultType: integer
-
- measResultUnits: number
-
- measType: VS.NINFC.IntraFrPscelChFailTdcExp
-
- -
-
- iMeasInfoId: 2204
-
- iMeasType: 3
-
- measAdditionalFields:
-
- measAggregationLevels: "NGBTS NGCELL"
-
- measCollectionMethod: CC
-
- measCondition: "This measurement is updated when MeNB replies to X2AP:
-SgNB Modification Required message with the X2AP: SgNB Modification
-Refuse message."
-
- measDescription: "This counter indicates the number of intra gNB intra
-frequency PSCell change failures due to MeNB refusal."
-
- measFamily: NINFC
-
- measInfoId: "NR Intra Frequency PSCell Change"
-
- measLastChange: 5G19\_1906\_002
-
- measObjClass: NGCELL
-
- measResultRange: "0..4096"
-
- measResultType: integer
-
- measResultUnits: number
-
- measType: VS.NINFC.IntraFrPscelChFailMenbRef
-
-...
-
-FM Meta Data
-------------
-
-FM Meta Data enables vendors to provide meta information about FM events
-using a set of standard keywords. FM Meta Data is conveyed in the YAML
-event registration using the YAML Comment qualifier.
-
-The FM Meta Data section is optional. FM Meta Data includes Alarm Meta
-Data and Fault Meta Data:
-
-- Alarm Meta Data, if provided, shall be placed in the YAML comments
- qualifier at the top of the event registration for the alarm.
-
-- Fault Meta Data, if provided, shall be placed in the YAML comments
- qualifier of faultFields.alarmAdditionalInformation within each
- alarm.
-
-FM Meta Data keywords must be provided in ‘hash format’ as Keyword:
-Value. Values containing whitespace must be enclosed in single quotes.
-Successive keywords must be separated by commas. These conventions will
-make machine processing of FM Meta Data Keywords easier to perform.
-
-Alarm Meta Data Keywords
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following is a list of standard Alarm Meta Data Keywords. Note: the
-keywords are in CAPS so they can be easily found within the YAML
-comments. R / O refers to recommended / optional.
-
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Keyword** | **R / O** | **Description** |
-+===========================+=============+===============================================================================================================================================================================================================================================================================================================================================================================================================================================+
-| ALARM ID | O | Gives a unique numerical Identifier for the alarm. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ALARM NAME | R | Gives a short, concise meaningful name of the alarm in camel format with no spaces, for example baseStationSynchronizationProblem. Note: Alarm Name meta data must match the name used in alarmCondition in the faultFields of the VES Fault Event to provide the cross reference between the Fault Event and its associated FM Meta Data. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ALARM DESCRIPTION | R | Provides a descriptive meaning of the alarm condition. This is intended to be read by an operator to give an idea of what happened. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ALARM EFFECT | R | Provides a description of the consequences when this alarm condition occurs. This is intended to be read by an operator to give a sense of the effects, consequences, and other impacted areas of the system. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ADDITIONAL TEXT | O | This field Contains further information on the alarm in free form text.See ITU-T Recommendation X.733 clause 8.1.2.13. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ASSOCIATED FAULTS | O | Indicates the associated faults that triggered this alarm. List of Fault IDs associated with the alarm which can be cross indexed against a vendor provided fault information. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CLEARING TYPE | R | Indicates whether the alarm is automatically or manually cleared. Valid values are Automatic or Manual. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| EVENT TYPE | O | Indicates the type of alarm. Event Types are found in 3GPP TS 32.111 Annex A. The types are: Communications Alarm, Processing Error Alarm, Environmental Alarm, Quality of Service Alarm, Equipment Alarm, Integrity Violation, Operational Violation, Physical Violation, Security Service or Mechanism Violation, or Time Domain Violation. Note that eventCategory in the faultFields of the VES Fault Event may contain the event type. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| MANAGED OBJECT CLASSES | R | Indicates the list of possible managed object classes (MOCs) associated with this alarm. Note that *eventSourceType* in the *faultFields* of the VES Fault Event contains the specific MOC against which the particular alarm occurrence was raised. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| PROBABLE CAUSE | O | Provides the probable cause qualifier for the alarm. Probable causes are found in 3GPP TS 32.111 Annex B, drawn from ITU-T M.3100 and from ITU-T Recommendation X.721, X.733, and X.736. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| PROPOSED REPAIR ACTIONS | R | Indicates proposed repair actions. May be used to provide recovery instructions to the operator in free form text. |
-+---------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Fault Meta Data Keywords
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following is a list of standard Fault Meta Data Keywords. Note: the
-keywords are in CAPS so they can be easily found within the YAML
-comments. R / O refers to recommended / optional.
-
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Keyword** | **R / O** | **Description** |
-+===========================+=============+=======================================================================================================================================================================================================+
-| FAULT ID | O | Gives a unique numerical Identifier for the fault. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| FAULT NAME | O | Gives a short name for the fault. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| FAULT DESCRIPTION | O | Provides a descriptive meaning of the fault condition. This is intended to be read by an operator to give an idea of what happened. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| FAULT EFFECT | O | Provides a description of the consequences when this fault occurs. This is intended to be read by an operator to give a sense of the effects, consequences, and other impacted areas of the system. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| PROPOSED REPAIR ACTIONS | O | Indicates proposed repair actions. May be used to provide recovery instructions to the operator in free form text.. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ADDITIONAL TEXT | O | Contains further information on the fault in free form text. See ITU-T Recommendation X.733 clause 8.1.2.13. |
-+---------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-FM Meta Data Example
-~~~~~~~~~~~~~~~~~~~~
-
-The following is a snippet of a fault event registration showing use of
-the FM Meta Data keywords. Note: it is recommended the information be
-conveyed in a human readable form similar to the example below:
-
-event: {
-
- presence: required,
-
- action: {any, any, baseStationSynchronizationProblem,
-RECO-ContactNokiaTechnicalSupport},
-
- comment: "
-
- ALARM NAME: baseStationSynchronizationProblem,
-
- ALARM ID: 7108,
-
- ALARM DESCRIPTION: 'A fault has occurred in the base station
-synchronization. For example: the base station reference clock signal is
-lost or is unstable or inaccurate.',
-
- ALARM EFFECT: 'The effect of the fault on the functioning of the network element depends on the fault id raised. See FAULT EFFECT below.',
-
- MANAGED OBJECT CLASSES: NRBTS,
-
- EVENT TYPE: 'Equipment Alarm',
-
- PROBABLE CAUSE: 'Timing Problem',
-
- PROPOSED REPAIR ACTIONS: 'See PROPOSED REPAIR ACTIONS for the underlying fault under alarmAdditionalInformation.',
-
- ASSOCIATED FAULTS: 9, 1818,
-
- CLEARING TYPE: Automatic
-
- ",
-
-structure: {
-
- commonEventHeader: {presence: required, structure: {
-
- version: {presence: required, value: 3.0},
-
- domain: {presence: required, value: fault},
-
- eventName: {presence: required, value:
-Fault\_gnb-Nokia\_baseStationSynchronizationProblem},
-
- eventId: {presence: required},
-
- sourceName: {presence: required},
-
- reportingEntityName: {presence: required},
-
- priority: {presence: required},
-
- startEpochMicrosec: {presence: required},
-
- lastEpochMicrosec: {presence: required},
-
- timeZoneOffset: {presence: required},
-
- sequence: {presence: required}
-
- }},
-
- faultFields: {presence: required, structure: {
-
- faultFieldsVersion: {presence: required, value: 3.0},
-
- eventCategory: {presence: optional, comment: "Equipment Alarm"},
-
- alarmCondition: {presence: required, value: 'baseStationSynchronizationProblem'},
-
- eventSourceType: {presence: required},
-
- alarminterfaceA: {presence: required},
-
- specificProblem: {presence: required},
-
- eventSeverity: {presence: required, value: [MINOR, NORMAL]},
-
- nfStatus: {default: Active},
-
- alarmAdditionalInformation: {presence: required, array: [
-
- keyValuePair: {
-
- presence: required,
-
- structure: {
-
- key: {presence: required, value: faultId},
-
- value: {presence: required}
-
- },
-
- comment: "
-
- FAULT ID: 9,
-
- FAULT NAME: 'BTS time not corrected',
-
- FAULT DESCRIPTION: 'The reference frequency that the BTS master clock
-receives has changed by about 200 ppb or more (which equals the change
-magnitude of 204 DAC steps or more (with 12bit DAC)) during the
-measurement period, compared to the BTS master clock frequency.
-
- Causes can be:
-
- 1. The reference frequency …..
-
- 2. The reference frequency fluctuates …',
-
- FAULT EFFECT: 'This fault does not immediately affect the operations of the BTS, but it is a notification …',
-
- PROPOSED REPAIR ACTION: 'access the ….follow the instructions below:
-
- 1. In case of a fault in the transmission network synchronization, …
-
- 2. If the basic accuracy of the signal used for synch is correct…
-
- 3. In case of a BTS equipment fault, the location might be:
-
- 4. After the fault situation has been cleared, ….',
-
- FAULT ID: 1818,
-
- FAULT NAME: 'BTS master clock tuning failure',
-
- FAULT DESCRIPTON: 'Master clock frequency is tuned to within 5% of its
-minimum or maximum tuning limit.',
-
- FAULT EFFECT: 'The BTS can operate properly for months …'
-
- Effects in Frequency Synchronization mode: …
-
- Effects in Phase Synchronization mode: ….',
-
- PROPOSED REPAIR ACTION: 'Perform the steps below in the listed order
-until the fault disappears.
-
- Not tracking satellites:
-
- 1. The most common reason ….
-
- 2. There might be a malfunction in the GPS receiver. Perform a (remote)power reset for the GPS receiver.
-
- 3. There might be a HW fault in the GPS receiver. Check the operation
-and change the GPS module, if needed.'
-
- "
-
- },
-
- keyValuePair: {
-
- presence: required,
-
- structure: {
-
- key: {presence: required, value: alarmId},
-
- value: {presence: required}
-
- }},
-
- keyValuePair: {
-
- presence: required,
-
- structure: {
-
- key: {presence: required, value: 'application additional information fields'},
-
- value: {presence: optional}
-
- }}
-
- ]}
-
-}}
-
-}
-
-}
-
-YAML Examples
-=============
-
-An example YAML file is provided below which registers some events for a
-hypothetical VNF. Note: some of the lines have been manually
-wrapped/indented to make it easier to read. Please ignore the section
-breaks that interrupt this single file; they were added to make it
-easier to rapidly find examples of different types of events.
-
-Fault
------
-
----
-
-# registration for Fault\_vMrf\_alarm003
-
-# Constants: the values of domain, eventName, priority, vfstatus
-
-# , version, alarmCondition, eventSeverity, eventSourceType,
-
-# faultFieldsVersion, specificProblem,
-
-# Variables (to be supplied at runtime) include: eventId,
-lastEpochMicrosec,
-
-# reportingEntityId, reportingEntityName, sequence, sourceId,
-sourceName,
-
-# startEpochMicrosec
-
-event: {presence: required, action: [ any, any, alarm003,
-RECO-rebuildVnf ],
-
-structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: fault},
-
-eventName: {presence: required, value: Fault\_vMrf\_alarm003},
-
-eventId: {presence: required},
-
-nfNamingCode: {value: mrfx},
-
-priority: {presence: required, value: Medium},
-
-reportingEntityId: {presence: required},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceId: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-faultFields: {presence: required, structure: {
-
-alarmCondition: {presence: required, value: alarm003},
-
-eventSeverity: {presence: required, value: MAJOR},
-
-eventSourceType: {presence: required, value: virtualNetworkFunction},
-
-faultFieldsVersion: {presence: required, value: 2.0},
-
-specificProblem: {presence: required, value: "Configuration file was
-corrupt or
-
-not present"},
-
-vfStatus: {presence: required, value: "Requesting Termination"}
-
-}}
-
-}}
-
-...
-
----
-
-# registration for clearing Fault\_vMrf\_alarm003Cleared
-
-# Constants: the values of domain, eventName, priority,
-
-# , version, alarmCondition, eventSeverity, eventSourceType,
-
-# faultFieldsVersion, specificProblem,
-
-# Variables (to be supplied at runtime) include: eventId,
-lastEpochMicrosec,
-
-# reportingEntityId, reportingEntityName, sequence, sourceId,
-
-# sourceName, startEpochMicrosec, vfStatus
-
-event: {presence: required, action: [ any, any, alarm003, Clear ],
-structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: fault},
-
-eventName: {presence: required, value: Fault\_vMrf\_alarm003Cleared},
-
-eventId: {presence: required},
-
-nfNamingCode: {value: mrfx},
-
-priority: {presence: required, value: Medium},
-
-reportingEntityId: {presence: required},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceId: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-faultFields: {presence: required, structure: {
-
-alarmCondition: {presence: required, value: alarm003},
-
-eventSeverity: {presence: required, value: NORMAL},
-
-eventSourceType: {presence: required, value: virtualNetworkFunction},
-
-faultFieldsVersion: {presence: required, value: 2.0},
-
-specificProblem: {presence: required, value: "Valid configuration file
-found"},
-
-vfStatus: {presence: required, value: "Requesting Termination"}
-
-}}
-
-}}
-
-...
-
-Heartbeat
----------
-
----
-
-# registration for Heartbeat\_vMRF
-
-# Constants: the values of domain, eventName, priority, version
-
-# Variables (to be supplied at runtime) include: eventId,
-lastEpochMicrosec,
-
-# reportingEntityId, reportingEntityName, sequence, sourceId,
-sourceName,
-
-# startEpochMicrosec
-
-event: {presence: required, heartbeatAction: [3, vnfDown,
-RECO-rebuildVnf],
-
-structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: heartbeat},
-
-eventName: {presence: required, value: Heartbeat\_vMrf},
-
-eventId: {presence: required},
-
-nfNamingCode: {value: mrfx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityId: {presence: required},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceId: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-heartbeatFields: {presence: optional, structure:{
-
- heartbeatFieldsVersion: {presence: required, value: 1.0},
-
- heartbeatInterval: {presence: required, range: [ 15, 300 ],
-default: 60 }
-
-}}
-
-}}
-
-...
-
-Measurements
-------------
-
----
-
-# registration for Mfvs\_vMRF
-
-# Constants: the values of domain, eventName, priority, version,
-
-# measurementFieldsVersion,
-additionalMeasurements.namedArrayOfFields.name,
-
-# Variables (to be supplied at runtime) include: eventId,
-reportingEntityName, sequence,
-
-# sourceName, start/lastEpochMicrosec, measurementInterval,
-
-# concurrentSessions, requestRate, numberOfMediaPortsInUse,
-
-# cpuUsageArray.cpuUsage,cpuUsage.cpuIdentifier, cpuUsage.percentUsage,
-
-# additionalMeasurements.namedArrayOfFields.arrayOfFields,
-
-# vNicPerformance.receivedOctetsAccumulated,
-
-# vNicPerformance.transmittedOctetsAccumulated,
-
-# vNicPerformance.receivedTotalPacketsAccumulated,
-
-# vNicPerformance.transmittedTotalPacketsAccumulated,
-
-# vNicPerformance.vNicIdentifier, vNicPerformance.receivedOctetsDelta,
-
-# vNicPerformance.receivedTotalPacketsDelta,
-
-# vNicPerformance.transmittedOctetsDelta,
-
-# vNicPerformance.transmittedTotalPacketsDelta,
-
-# vNicPerformance.valuesAreSuspect, memoryUsageArray.memoryUsage,
-
-# memoryUsage.memoryConfigured, memoryUsage.vmIdentifier,
-
-# memoryUsage.memoryUsed, memoryUsage.memoryFree
-
-event: {presence: required, structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: measurementsForVfScaling},
-
-eventName: {presence: required, value: Mfvs\_vMrf},
-
-eventId: {presence: required},
-
-nfNamingCode: {value: mrfx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityId: {presence: required},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceId: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-measurementsForVfScalingFields: {presence: required, structure: {
-
-measurementFieldsVersion: {presence: required, value: 2.0},
-
-measurementInterval: {presence: required, range: [ 60, 3600 ], default:
-300},
-
-concurrentSessions: {presence: required, range: [ 0, 100000 ]},
-
-requestRate: {presence: required, range: [ 0, 100000 ]},
-
-numberOfMediaPortsInUse: {presence: required, range: [ 0, 100000 ]},
-
-cpuUsageArray: {presence: required, array: [
-
-cpuUsage: {presence: required, structure: {
-
-cpuIdentifier: {presence: required},
-
-percentUsage: {presence: required, range: [ 0, 100 ],
-
-action: [80, up, CpuUsageHigh, RECO-scaleOut],
-
-action: [10, down, CpuUsageLow, RECO-scaleIn]}
-
-}}
-
-]},
-
-memoryUsageArray: {presence: required, array: [
-
-memoryUsage: {presence: required, structure: {
-
-memoryConfigured: {presence: required, value: 33554432},
-
-memoryFree: {presence: required, range: [ 0, 33554432 ],
-
-action: [100, down, FreeMemLow, RECO-scaleOut],
-
-action: [30198989, up, FreeMemHigh, RECO-scaleIn]},
-
-memoryUsed: {presence: required, range: [ 0, 33554432 ]},
-
-vmIdentifier: {presence: required}
-
-}}
-
-]},
-
-additionalMeasurements: {presence: required, array: [
-
-namedArrayOfFields: {presence: required, structure: {
-
-name: {presence: required, value: licenseUsage},
-
-arrayOfFields: {presence: required, array: [
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: G711AudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: G729AudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: G722AudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: AMRAudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: AMRWBAudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: OpusAudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: H263VideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: H264NonHCVideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: H264HCVideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: MPEG4VideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: VP8NonHCVideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: VP8HCVideoPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: PLC},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: AEC},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: NR},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: NG},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: NLD},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: G711FaxPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: T38FaxPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: RFactor},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: T140TextPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: EVSAudioPort},
-
-value: {presence: required, range: [ 0, 100000 ],
-
-units: numberOfPorts }
-
-}}
-
-]}
-
-}},
-
-namedArrayOfFields: {presence: required, structure: {
-
-name: {presence: required, value: mediaCoreUtilization},
-
-arrayOfFields: {presence: required, array: [
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualAvgAudio},
-
-value: {presence: required, range: [ 0, 255 ],
-
-action: [80, up, AudioCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, AudioCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelAvgAudio},
-
-value: {presence: required, range: [ 0, 100 ],
-
-action: [80, up, AudioCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, AudioCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualMaxAudio},
-
-value: {presence: required, range: [ 0, 255 ]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelMaxAudio},
-
-value: {presence: required, range: [ 0, 100 ]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualAvgVideo},
-
-value: {presence: required, range: [ 0, 255 ],
-
-action: [80, up, VideoCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, VideoCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelAvgVideo},
-
-value: {presence: required, range: [ 0, 100 ],
-
-action: [80, up, VideoCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, VideoCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualMaxVideo},
-
-value: {presence: required, range: [ 0, 255 ]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelMaxVideo},
-
-value: {presence: required, range: [ 0, 100 ]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualAvgHcVideo},
-
-value: {presence: required, range: [ 0, 255 ],
-
-action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelAvgHcVideo},
-
-value: {presence: required, range: [ 0, 100 ],
-
-action: [80, up, HcVideoCoreUsageHigh, RECO-scaleOut],
-
-action: [10, down, HcVideoCoreUsageLow, RECO-scaleIn]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: actualMaxHcVideo},
-
-value: {presence: required, range: [ 0, 255 ]}
-
-}},
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: modelMaxHcVideo},
-
-value: {presence: required, range: [ 0, 100 ]}
-
-}}
-
-]}
-
-}}
-
-]},
-
-vNicPerformanceArray: {presence: required, array: [
-
-vNicPerformance: {presence: required, structure: {
-
-receivedOctetsAccumulated: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-receivedTotalPacketsAccumulated: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-receivedOctetsDelta: {presence: required},
-
-range: [ 0, 18446744073709551615 ],
-
-receivedTotalPacketsDelta: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-transmittedOctetsDelta: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-transmittedOctetsAccumulated: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-transmittedTotalPacketsAccumulated: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-transmittedTotalPacketsDelta: {presence: required,
-
-range: [ 0, 18446744073709551615 ]},
-
-valuesAreSuspect: {presence: required, value: [ true, false ]},
-
-vNicIdentifier: {presence: required}
-
-}}
-
-]}
-
-}}
-
-}}
-
-...
-
-Syslog
-------
-
----
-
-# registration for Syslog\_vMRF
-
-# Constants: the values of domain, eventName, priority,
-lastEpochMicrosec, version,
-
-# syslogFields.syslogFieldsVersion, syslogFields.syslogTag
-
-# Variables include: eventId, lastEpochMicrosec, reportingEntityId,
-reportingEntityName,
-
-# sequence, sourceId, sourceName, startEpochMicrosec,
-
-# syslogFields.eventSourceHost, syslogFields.eventSourceType,
-
-# syslogFields.syslogFacility, syslogFields.syslogMsg
-
-event: {presence: required, structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: syslog},
-
-eventName: {presence: required, value: Syslog\_vMrf},
-
-eventId: {presence: required},
-
-nfNamingCode: {value: mrfx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityId: {presence: required},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceId: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0},
-
-}},
-
-syslogFields: {presence: required, structure: {
-
-eventSourceHost: {presence: required},
-
-eventSourceType: {presence: required, value: virtualNetworkFunction},
-
-syslogFacility: {presence: required, range: [16, 23]},
-
-syslogSev: {presence: required, value: [Emergency, Alert, Critical,
-Error]},
-
-syslogFieldsVersion: {presence: required, value: 3.0},
-
-syslogMsg: {presence: required},
-
-syslogSData: {presence: required, keyValuePairString: {‘ ‘, =,
-keyValuePairs: [
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: ATTEST},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: DATE\_IN},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: DATE\_OUT},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: DEST\_IN},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: FUNCTION},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: ICID},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: ORIGID},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: ORIG\_TN},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: SIP\_REASON\_HEADER},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: STATE},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: STATUS},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: VERSTAT},
-
-value: {presence: required}
-
-}}
-
-]}} }]
-
-syslogTag: {presence: required, value: vMRF},
-
-additionalFields: {presence: required, keyValuePairString: {\|, =,
-keyValuePairs: [
-
-keyValuePair: {presence: required, structure: {
-
-key: {presence: required, value: someKeyName},
-
-value: {presence: required}
-
-}},
-
-keyValuePair: {presence: optional, structure: {
-
-key: {presence: required, value: someOtherKeyName},
-
-value: {presence: required}
-
-}}
-
-]}}
-
-}}
-
-}}
-
-...
-
-Mobile Flow
------------
-
----
-
-# registration for mobileFlow
-
-# Constants: the values of domain, eventName, priority, version
-
-#
-
-# Variables (to be supplied at runtime) include: eventId,
-reportingEntityName,
-
-# sequence, sourceName, start/lastEpochMicrosec
-
-#
-
-event: {presence: required, structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: mobileFlow},
-
-eventName: {presence: required, value: mobileFlow},
-
-eventId: {presence: required},
-
-nfType: {presence: required, value: sbcx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-mobileFlowFieldsVersion: {presence: required, structure: {
-
-applicationType: {presence: optional},
-
-appProtocolType: {presence: optional},
-
-appProtocolVersion: {presence: optional},
-
-cid: {presence: optional},
-
-connectionType: {presence: optional},
-
-ecgi: {presence: optional},
-
-flowDirection: {presence: required},
-
-gtpPerFlowMetrics: {presence: required, structure: {
-
-avgBitErrorRate: {presence: required},
-
-avgPacketDelayVariation: {presence: required},
-
-avgPacketLatency: {presence: required},
-
-avgReceiveThroughput: {presence: required},
-
-avgTransmitThroughput: {presence: required},
-
-durConnectionFailedStatus: {presence: optional},
-
-durTunnelFailedStatus: {presence: optional},
-
-flowActivatedBy: {presence: optional},
-
-flowActivationEpoch: {presence: required},
-
-flowActivationMicrosec: {presence: required},
-
-flowActivationTime: {presence: optional},
-
-flowDeactivatedBy: {presence: optional},
-
-flowDeactivationEpoch: {presence: required},
-
-flowDeactivationMicrosec: {presence: required},
-
-flowDeactivationTime: {presence: required},
-
-flowStatus: {presence: required},
-
-gtpConnectionStatus: {presence: optional},
-
-gtpTunnelStatus: {presence: optional},
-
-ipTosCountList: {presence: optional},
-
-ipTosList: {presence: optional},
-
-largePacketRtt: {presence: optional},
-
-largePacketThreshold: {presence: optional},
-
-maxPacketDelayVariation: {presence: required},
-
-maxReceiveBitRate: {presence: optional},
-
-maxTransmitBitRate: {presence: optional},
-
-mobileQciCosCountList: {presence: optional},
-
-mobileQciCosList: {presence: optional},
-
-numActivationFailures: {presence: required},
-
-numBitErrors: {presence: required},
-
-numBytesReceived: {presence: required},
-
-numBytesTransmitted: {presence: required},
-
-numDroppedPackets: {presence: required},
-
-numGtpEchoFailures: {presence: optional},
-
-numGtpTunnelErrors: {presence: optional},
-
-numHttpErrors: {presence: optional},
-
-numL7BytesReceived: {presence: required},
-
-numL7BytesTransmitted: {presence: required},
-
-numLostPackets: {presence: required},
-
-numOutOfOrderPackets: {presence: required},
-
-numPacketErrors: {presence: required},
-
-numPacketsReceivedExclRetrans: {presence: required},
-
-numPacketsReceivedInclRetrans: {presence: required},
-
-numPacketsTransmittedInclRetrans: {presence: required},
-
-numRetries: {presence: required},
-
-numTimeouts: {presence: required},
-
-numTunneledL7BytesReceived: {presence: required},
-
-roundTripTime: {presence: required},
-
-tcpFlagCountList: {presence: optional},
-
-tcpFlagList: {presence: optional},
-
-timeToFirstByte: {presence: required}
-
-}},
-
-gtpProtocolType: {presence: optional},
-
-gtpVersion: {presence: optional},
-
-httpHeader: {presence: optional},
-
-imei: {presence: optional},
-
-imsi: {presence: optional},
-
-ipProtocolType: {presence: required},
-
-ipVersion: {presence: required},
-
-lac: {presence: optional},
-
-mcc: {presence: optional},
-
-mnc: {presence: optional},
-
-msisdn: {presence: optional},
-
-otherEndpointIpAddress: {presence: required},
-
-otherEndpointPort: {presence: required},
-
-otherFunctionalRole: {presence: optional},
-
-rac: {presence: optional},
-
-radioAccessTechnology: {presence: optional},
-
-reportingEndpointIpAddr: {presence: required},
-
-reportingEndpointPort: {presence: required},
-
-sac: {presence: optional},
-
-samplingAlgorithm: {presence: optional},
-
-tac: {presence: optional},
-
-tunnelId: {presence: optional},
-
-vlanId: {presence: optional},
-
-additionalInformation: {presence: optional, array: {
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: name1},
-
-value: {presence: required}
-
-}},
-
-field: {presence: optional, structure: {
-
-name: {presence: required, value: name2},
-
-value: {presence: required}
-
-}}
-
-}}
-
-}}
-
-}}
-
-...
-
-Sip Signaling
--------------
-
----
-
-# registration for sipSignaling
-
-# Constants: the values of domain, eventName, priority, version
-
-#
-
-# Variables (to be supplied at runtime) include: eventId,
-reportingEntityName,
-
-# sequence, sourceName, start/lastEpochMicrosec
-
-#
-
-event: {presence: required, structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: sipSignaling},
-
-eventName: {presence: required, value: sipSignaling\_modelName},
-
-eventId: {presence: required},
-
-nfType: {presence: required, value: sbcx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-sipSignalingFields: {presence: required, structure: {
-
-compressedSIP: {presence: optional},
-
-correlator: {presence: required},
-
-localIpAaddress: {presence: required},
-
-localPort: {presence: required},
-
-remoteIpAddress: {presence: required},
-
-remotePort: {presence: required},
-
-sipSignalingFieldsVersion: {presence: required},
-
-summarySip: {presence: optional},
-
-vnfVendorNameFields: {presence: required, structure: {
-
-vendorName: {presence: required},
-
-vfModuleName: {presence: optional},
-
-vnfName: {presence: optional}
-
-}},
-
-additionalInformation: {presence: optional, array: {
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: name1},
-
-value: {presence: required}
-
-}},
-
-field: {presence: optional, structure: {
-
-name: {presence: required, value: name2},
-
-value: {presence: required}
-
-}}
-
-}}
-
-}}
-
-}}
-
-...
-
-Voice Quality
--------------
-
----
-
-# registration for voiceQuality
-
-# Constants: the values of domain, eventName, priority, version
-
-#
-
-# Variables (to be supplied at runtime) include: eventId,
-lastEpochMicrosec,
-
-# reportingEntityId, reportingEntityName, sequence, sourceId,
-
-# sourceName, startEpochMicrosec
-
-event: {presence: required, structure: {
-
-commonEventHeader: {presence: required, structure: {
-
-domain: {presence: required, value: voiceQualityFields},
-
-eventName: {presence: required, value: voiceQualityFields\_modelName},
-
-eventId: {presence: required},
-
-nfType: {presence: required, value: sbcx},
-
-priority: {presence: required, value: Normal},
-
-reportingEntityName: {presence: required},
-
-sequence: {presence: required},
-
-sourceName: {presence: required},
-
-startEpochMicrosec: {presence: required},
-
-lastEpochMicrosec: {presence: required},
-
-version: {presence: required, value: 3.0}
-
-}},
-
-voiceQualityFieldsVersion: {presence: required, structure: {
-
-calleeSideCodec: {presence: required},
-
-callerSideCodec: {presence: required},
-
-correlator: {presence: required},
-
-remoteIpAddress: {presence: required},
-
-endOfCallVqmSummaries: {presence: required, structure: {
-
-adjacencyName: {presence: required},
-
-endpointDescription: {presence: required},
-
-endpointAverageJitter: {presence: optional},
-
-endpointMaxJitter: {presence: optional},
-
-endpointRtpOctetsLost: {presence: optional},
-
-endpointRtpPacketsLost: {presence: optional},
-
-endpointRtpOctetsDiscarded: {presence: optional},
-
-endpointRtpOctetsReceived: {presence: optional},
-
-endpointRtpOctetsSent: {presence: optional},
-
-endpointRtpPacketsDiscarded: {presence: optional},
-
-endpointRtpPacketsReceived: {presence: optional},
-
-endpointRtpPacketsSent: {presence: optional},
-
-localAverageJitter: {presence: optional},
-
-localMaxJitter: {presence: optional},
-
-localAverageJitterBufferDelay: {presence: optional},
-
-localMaxJitterBufferDelay: {presence: optional},
-
-localRtpOctetsDiscarded: {presence: optional},
-
-localRtpOctetsLost: {presence: optional},
-
-localRtpOctetsReceived: {presence: optional},
-
-localRtpOctetsSent: {presence: optional},
-
-localRtpPacketsDiscarded: {presence: optional},
-
-localRtpPacketsLost: {presence: optional},
-
-localRtpPacketsReceived: {presence: optional},
-
-localRtpPacketsSent: {presence: optional},
-
-mosCqe: {presence: optional},
-
-packetLossPercent: {presence: optional},
-
-rFactor: {presence: optional},
-
-roundTripDelay: {presence: optional},
-
-oneWayDelay: {presence: optional}
-
-}},
-
-phoneNumber: {presence: required},
-
-midCallRtcp: {presence: required},
-
-vendorVnfNameFields: {presence: required, structure: {
-
-vendorName: {presence: required},
-
-vfModuleName: {presence: optional},
-
-vnfName: {presence: optional}
-
-}},
-
-additionalInformation: {presence: optional, array: {
-
-field: {presence: required, structure: {
-
-name: {presence: required, value: name1},
-
-value: {presence: required}
-
-}},
-
-field: {presence: optional, structure: {
-
-name: {presence: required, value: name2},
-
-value: {presence: required}
-
-}}
-
-}}
-
-}}
-
-}}
-
-...
-
-Rules
------
-
----
-
-#Rules
-
-Rules: [
-
-rule: {
-
-trigger: CpuUsageHigh \|\| FreeMemLow \|\| AudioCoreUsageHigh \|\|
-
-VideoCoreUsageHigh \|\| HcVideoCoreUsageHigh,
-
-microservices: [scaleOut]
-
-},
-
-rule: {
-
-trigger: CpuUsageLow && FreeMemHigh && AudioCoreUsageLow &&
-
-VideoCoreUsageLow && HcVideoCoreUsageLow,
-
-microservices: [scaleIn]
-
-}
-
-]
-
-...
-
-Appendix: Historical Change Log
-===============================
-
-For the latest changes, see the Change Block just before the Table of
-Contents.
-
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Date | Revision | Description |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/15/2017 | 1.0 | This is the initial release of the VES Event Registration document. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/22/2017 | 1.1 | - Changed the ‘alert’ qualifier to ‘action’ and added support for conditions that will trigger rules. |
-| | | |
-| | | - Formatted the document with more sections and subsections. |
-| | | |
-| | | - Defined the syntax and semantics for condition based rules. |
-| | | |
-| | | - Fixed the YAML examples. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/27/2017 | 1.2 | - Clarified the audience of the document and the expectations for vendors. |
-| | | |
-| | | - Changed the order of fields in the action keyword. |
-| | | |
-| | | - Updated the YAML examples. |
-| | | |
-| | | - Wordsmithed throughout. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/31/2017 | 1.3 | - Generalized the descriptions from an ASDC, ECOMP and AT&T-specific interaction with a VNF vendor, to a generic Service Provider interaction with a VNF vendor. |
-| | | |
-| | | - Wordsmithed throughout. |
-| | | |
-| | | - Added a ‘default’ qualifier |
-| | | |
-| | | - Fixed syntax and semantic inconsistencies in the Rules section |
-| | | |
-| | | - Brought all examples into compliance with v5.0 |
-| | | |
-| | | - Added a heartbeat example |
-| | | |
-| | | - Modified the mfvs example |
-| | | |
-| | | - Modified the syslog example |
-| | | |
-| | | - Added two complex rules |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 4/14/2017 | 1.4 | - Wordsmithed throughout |
-| | | |
-| | | - Action keyword: clarified use of ‘up’, ‘down’ and ‘at’ triggers; clarified the specification and use of microservices directives at design time and runtime, clarified the use of tca’s |
-| | | |
-| | | - HeartbeatAction keyword: Added the heartbeatAction keyword |
-| | | |
-| | | - Value keyword: clarified the communicaton of strings containing spaces. |
-| | | |
-| | | - Rules: corrected the use of quotes in examples |
-| | | |
-| | | - Examples: added the heartbeatAction keyword on the heartbeat event example; also corrected use of quotes throughout. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 10/3/2017 | 1.5 | - Back of Cover Page: updated the license and copyright notice to comply with ONAP guidelines |
-| | | |
-| | | - Section 3.1: Added a ‘Units’ qualifier |
-| | | |
-| | | - Examples: updated the examples to align with VES 5.4.1 |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 10/31/2017 | 1.6 | - Added KeyValuePairString keyword to handle strings which have delimited key-value pairs within them. |
-| | | |
-| | | - Updated the syslog example to show the use of KeyValuePairString |
-| | | |
-| | | - Updated the syslog example to align syslogSev with VES 5.4.1 |
-| | | |
-| | | - Added examples for mobile flow, sip signaling and voice quality |
-| | | |
-| | | - Added sections within the examples to facilitate rapid access to specific types of example events |
-| | | |
-| | | - Wordsmithed the Introduction |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/28/2018 | 2.0 | - Updated to align with the change of the ‘measurementsForVfScaling’ domain to ‘measurement’ |
-| | | |
-| | | - measurementsForVfScaling measurement |
-| | | |
-| | | - measurementsForVfScalingFields measurementFields |
-| | | |
-| | | - measurementsForVfScalingVersion measurementFieldsVersion |
-| | | |
-| | | - the ‘mfvs’ abbreviation measurement |
-| | | |
-| | | 1. Clarified YAML file naming |
-| | | |
-| | | 2. Clarified the Action keyword. |
-| | | |
-| | | 3. Added an aggregationRole keyword. |
-| | | |
-| | | 4. Added a castTo keyword. |
-| | | |
-| | | 5. Added an isHomogeneous keyword. |
-| | | |
-| | | 6. Added a 'key' keyword |
-| | | |
-| | | 7. Add a 'keyValuePair' keyword |
-| | | |
-| | | 8. Modified the existing 'keyValuePairString' keyword description to reference the 'keyValuePair' keyword. |
-| | | |
-| | | 9. Added a section on Complex Conditions and modified the Rules section |
-| | | |
-| | | 10. Modified the Examples as follows: |
-| | | |
-| | | - changed ‘faultFieldsVersion’ to 3.0 |
-| | | |
-| | | - changed ‘heartbeatFieldsVersion’ to 2.0 |
-| | | |
-| | | - provided guidance at the top of the Measurements examples as to how to send extensible fields through arrayOfNamedHashMap in a way that will eliminate the need for custom development at the service provider. |
-| | | |
-| | | - changed ‘measurementFieldsVersion’ to 3.0 |
-| | | |
-| | | - changed measurementFields.additionalMeasurements to reference a ‘namedHashMap’ |
-| | | |
-| | | - ‘field’ is replaced by ‘keyValuePair’ |
-| | | |
-| | | - ‘name’ is replaced by ‘key’ |
-| | | |
-| | | - changed ‘namedArrayOfFields’ to ‘namedHashMap’ |
-| | | |
-| | | - fixed the mobile Flow example to show the ‘mobileFlowFields’, show the ‘mobileFlowFieldsVersion’ at 3.0, modify ‘additionalInformation’ to use a hashMap |
-| | | |
-| | | - ‘field’ is replaced by ‘keyValuePair’ |
-| | | |
-| | | - ‘name’ is replaced by ‘key’ |
-| | | |
-| | | - changed ‘sipSignalingFieldsVersion’ to 2.0 |
-| | | |
-| | | - changed ‘additionalInformation’ to use a hashmap |
-| | | |
-| | | - ‘field’ is replaced by ‘keyValuePair’ |
-| | | |
-| | | - ‘name’ is replaced by ‘key’ |
-| | | |
-| | | - fixed the voiceQuality example to show the ‘voiceQualityFields’, show the ‘voiceQualityFieldsVersion’ at 2.0 and modify ‘additionalInformation’ to use a hashMap |
-| | | |
-| | | - ‘field’ is replaced by ‘keyValuePair’ |
-| | | |
-| | | - ‘name’ is replaced by ‘key’ |
-| | | |
-| | | - Modified the rules example to conform to the Complex Conditions and Rules sections. |
-| | | |
-| | | - Numerous clarifications made to address issues with previous drafts of this version including: |
-| | | |
-| | | - Fixed arrays followed by other than square brackets |
-| | | |
-| | | - Section 2.2: clarified format of v# in filename |
-| | | |
-| | | - Section 3.1.11: clarified use of camel casing |
-| | | |
-| | | - Section 3.2.1: corrected and clarified |
-| | | |
-| | | - Section 3.2.3 Clarified number of conditions that may be and’d or or’d |
-| | | |
-| | | - Section 3.2.4: fixed reference to PersistentB1 |
-| | | |
-| | | - Section 3.2.6: fixed math in example |
-| | | |
-| | | - Section 3.3.2: changed reference from ‘alerts’ to ‘events’ |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/30/2018 | 3.0 | - Removed the isHomogeneous keyword. |
-| | | |
-| | | - Modified the types of aggregationRoles. |
-| | | |
-| | | - Clarified castTo |
-| | | |
-| | | - Added comment keyword |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/14/2018 | 3.1 | - Added keywords: CastTo, Comment, Aggregation Role. These were modified versions of the keywords already defined in version 3.0. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 12/10/2018 | 3.2 | - Added the PM Data Dictionary and FM Meta Data sections. |
-+--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/files/VesEventListener-v6.0.rst b/docs/files/VesEventListener-v6.0.rst deleted file mode 100644 index a45cf00..0000000 --- a/docs/files/VesEventListener-v6.0.rst +++ /dev/null @@ -1,9278 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 AT&T Intellectual Property, All rights reserved -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -=================================== -Service: *VES Event Listener 6.0.0* -=================================== - -.. contents:: Table of Contents - -+---------------+--------------------+ -| Revision | 6.0 | -+---------------+--------------------+ -| Revision Date | June 28, 2018 | -+---------------+--------------------+ -| Author | Rich Erickson | -+---------------+--------------------+ - -+---------------+---------------------------+ -| Contributors: | **Min Chen – AT&T** | -| | | -| | **Fred Delaplace - AT&T** | -| | | -| | **Andrew Egan – AT&T** | -| | | -| | **Alok Gupta – AT&T** | -| | | -| | **Marge Hillis – Nokia** | -| | | -| | **Gerard Hynes – AT&T** | -| | | -| | **Ken Kelly – AT&T** | -| | | -| | **Tim Verall – Intel** | -| | | -| | **Sumit Verdi – VMWare** | -+---------------+---------------------------+ - - -Introduction -============ - -This document describes the RESTful interface for the VES Event -Listener. The VES acronym originally stood for Virtual-function Event -Streaming, but VES has been generalized to support network-function -event streaming, whether virtualized or not. The VES Event Listener is -capable of receiving any event sent in the VES Common Event Format. The -Common Event Format is expressed in JSON schema in section 4 of this -document. In the Common Event Format, an event consists of a required -Common Event Header block (i.e., object) accompanied by zero or more -event domain blocks. - -It should be understood that events are well structured packages of -information, identified by an eventName, which are asynchronously -communicated to subscribers who are interested in the eventName. Events -can convey measurements, faults, syslogs, threshold crossing alerts and -other types of information. Events are simply a way of communicating -well-structured packages of information to one or more instances of an -Event Listener service. - -This document describes a RESTful connectionless push event listener -that is capable of receiving single events or batches of events in the -Common Event Format. In future, additional documents may describe other -transports which make use of persistent TCP connections for high volumes -of streaming events. - -Event Registration ------------------- - -All events must be compliant with the common event format, but specific -events identified by their eventNames, may require that certain fields, -which are optional in the common event format, be present when they are -published. For example, a specific eventName may require that specific -name-value pairs be present in the extensible structures provided within -the Common Event Format. - -Events are registered using an extensible YAML format (defined in a -separate document), which specifies, for each eventName, the fields that -are required, what field values may be sent, and any special handling -that should be performed on those eventNames. - -Naming Standards for eventName ------------------------------- - -To prevent naming collisions, eventNames sent as part of the -commonEventHeader, should conform to the following naming convention -designed to summarize the purpose and type of the event, and to ensure -the uniqueness of the eventName: - - {DomainAbbreviation}_{PublisherName}_{Description} - -Each underscore-separated subfield above must start with a capital -letter and use camel-casing to separate words and acronyms. Acronyms -must capitalize only the first letter of the acronym. Spaces and -underscores should not appear within any subfield. - -The DomainAbbreviation subfield derives from the ‘domain’ field in the -commonEventHeader, as specified below: - -- ‘Fault’ for the fault domain - -- ‘Heartbeat’ for the heartbeat domain - -- ‘Measurement’ for the measurements domain - -- ‘MobileFlow’ for the mobileFlow domain - -- ‘Other’ for the other domain - -- ‘PnfReg’ for the pnfRegistration domain - -- ‘SipSignaling’ for the sipSignaling domain - -- ‘StateChange’ for the stateChange domain - -- ‘Syslog’ for the syslog domain - -- ‘Tca’ for the thresholdCrossingAlert domain - -- ‘VoiceQuality’ for the voiceQuality domain - -The PublisherName subfield describes the vendor product or application -publishing the event. This subfield conforms to the following -conventions: - -- Vendor products are specified as: - -{productName}-{vendorName} - - For example: vISBC-Metaswitch or vDBE-Juniper, where a hyphen is used - to separate the productName and vendorName subfields. Note that the - productName and vendorName subfields must not include hyphens - themselves. - - Organizing the information in this way will cause an alphabetical - listing of eventNames to sort similar network functions together, - rather than to sort them by vendor. - - The productName subfield may describe a NF or a NFC. Where NFC names - may be reused across different NF’s, they should be specified as: - -{NfName}:{NfcName} - - where a colon is used to separate the NfName and NfcName subfields. - Note that the NfName and NfcName subfields must not include colons - themselves. - - The ProductName may also describe other types of vendor modules or - components such as a VM, application or hostname. As with NFs and - NFCs, parent:child relationships may be communicated using colon as a - subfield delimiter. - -- Service providers who adopt the VES Common Event Format for internal - use, may provide PublisherName without the vendorName subfield. They - would typically identify an application, system, service or - microservice publishing the event (e.g., ‘Policy’, ‘So’, - ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child - relationships may be communicated using colon as a subfield delimiter - (e.g., ApplicatoinName:ApplicationComponent). - -The final subfield of the eventName name should describe, in a compact -camel case format the specific information being conveyed by the event. -In some cases, this final subfield may not be required (e.g., in the -case of certain heartbeats). - -Examples of eventNames following the naming standards are provided -below: - -- Tca_Vdbe:Ericsson_CpuThresholdExceeded - -- Heartbeat_Visbc:Mmc-Metaswitch - -- Syslog_Vdbe-Ericsson - -- Fault_MobileCallRecording_PilotNumberPoolExhaustion - -- Other_So:WanBonding_InstantiationPart1Complete - -EventId Use Cases Examples --------------------------- - -[Author: Alok Gupta]: - -eventId Examples: - -Example 1: assumes a unique key for each domain consisting of domain -followed by an integer domainnnnnnn e.g. fault000001, heartbeat000001, -mfvs000005 - -Example 2: assumes an integer key for all events nnnnnnnnn: 000000001, -00000002, 000000003 - -Rules: - -1. All domains except Fault: each time a subsequent event is sent the - integer part of eventId will increment by 1. Repeat of eventId - assumes duplicate event. - -2. eventId construction for Fault Events: - - a. Most likely scenario - - i. The sourceName on each Fault event is the vNFC Name or VM - hostname. - - ii. The eventId on Fault events is the same every time a given - fault is raised (onset), re-raised at fixed time interval, - until it is cleared. Once the fault is cleared, a new eventId - is used. - - iii. The startEpochMicrosec value for the Fault event is the - timestamp for when that event is generated until a clear is - sent. - - iv. lastEpochMicrosec indicates the current event time. - - v. The sequence number for each Fault event is set to 1 when the - event is first raised, and increments each time the same - Fault event is raised, until a clear is sent. - - |image0| - - b. Alternative scenario: for vNF when fault event status is not - maintained. - - vi. The sourceName on each Fault event is the vNFC Name or VM - hostname. - - vii. The eventId on Fault events is the same every time a given - fault is raised or cleared, even if it is re-raised after it - had previously cleared. So, for example, if EMS loses - contact with a particular device then a Fault event might be - sent for a raise, re-raise (because EMS has re-tried and - still can’t contact the device), clear (because EMS has - re-tried and it can contact the device) and then raise again - (because EMS has lost contact with the device again). The - same eventId is used for all 4 of those Fault events. - - viii. The startEpochMicrosec value for each Fault event is the - timestamp for when that event is generated, not when the - fault first occurred. So all 4 of the Fault events in the - previous bullet point would have a different timestamp. - - ix. lastEpochMicrosec indicates the current event time. - - x. The sequence number for each Fault event is currently set to - 0 on a raise and 1 on a clear. We could change that so that - each Fault event is given a new monotonically increasing - sequence number whether it is a raise or a clear if that is - helpful (which is reset to 0 if the VM restarts) but they - won’t be consecutive. - -|image1| - -Measurement Expansion Fields ----------------------------- - -When expansion fields are used, the goal is to avoid custom development -by the service provider collecting the fields, since custom development -adds obvious cost, delay and resource overhead. In the domain of -measurements, it is expected that a high percentage (perhaps as high as -90 percent) of use cases for extensible fields can be satisfied by using -the additionalMeasurements arrayOfNamedHashMap data structure in -combination with a YAML registration file (provided at design time). The -YAML registration file conveys meta-information about the processing of -additionalMeasurements. For more information, please see the VES Event -Registration specification and in particular the aggregationRole, castTo -and isHomogeneous keywords. - -Syslogs -------- - -Syslog’s can be classified as either Control or Session/Traffic. They -differ by message content and expected volume: - -- Control logs are generally free-form human-readable text used for - reporting errors or warnings supporting the operation and - troubleshooting of NFs. The volume of these logs is typically less - than 2k per day. - -- Session logs use common structured fields to report normal NF - processing such as DNS lookups or firewall rules processed. The - volume of these logs is typically greater than 1k per hour (and - sometimes as high as 10k per second). - -VES supports both classes of syslog, however VES is only recommended for -lower volume session logs, less than 60k per hour. High volume session -logging should use a file-based transport solution. - -Support for Protocols Other Than HTTPS --------------------------------------- - -This API specification describes an HTTPS RESTful interface using the -JSON content-type. - -Alternative API specifications may be provided in future using Google -Protobuf, websockets, or Apache Avro. - -Versioning ----------- - -Three types of version numbers supported by this specification: - -- The API specification itself is versioned. Going forward, the major - number of the specification version will be incremented whenever any - change could break an existing client (e.g., a field name is deleted - or changed). All other changes to the spec (e.g., a field name is - added or text changes are made to the specification itself) will - increment only the minor number or patch number. Note that the major - number appears in REST resource URLs as v# (where ‘#’ is the major - number). Minor and patch numbers are communicated in HTTP headers. - For more information, see the API Versioning writeup in section 6.1. - -- The JSON schema is versioned. Going forward, the major number of the - JSON schema will be incremented whenever any change could break an - existing client (e.g., a field name is deleted or changed). All other - changes to the schema (e.g., a field name is added or text changes - are made to the field descriptions) will increment only the minor - number or patch number. - -- The field blocks are versioned. Field blocks include the - commonEventHeader and the domain blocks (e.g., the faultFields - block). Going forward, the major number of each field block will be - incremented whenever any change to that block could break an existing - client (e.g., a field name is deleted or changed). All other changes - to that block (e.g., a field name is added or text changes are made - to the field descriptions) will increment only the minor number. - -Field Block Versions -~~~~~~~~~~~~~~~~~~~~ - -A summary of the latest field block versions as of this version of the -API spec is provided below: - -- commonEventHeader: version: 3.0 - -- faultFieldsVersion: 3.0 - -- heartbeatFieldsVersion: 2.0 - -- measurementFieldsVersion: 3.0 - -- mobileFlowFieldsVersion: 3.0 - -- notificationFieldsVersion: 1.0 - -- otherFieldsVersion: 2.0 - -- pnfRegistrationFieldsVersion: 1.0 - -- sigSignalingFieldsVersion: 2.0 - -- stateChangeFieldsVersion: 3.0 - -- syslogFieldsVersion: 3.1 - -- tcaFieldsVersion: 3.0 - -- voiceQualityFieldsVersion: 3.0 - -Security -======== - -Event sources must identify themselves to the VES Event Listener. - -In the future, support for 2-way SSL certificate authentication (aka -mutual SSL) will be provided but for now, event source credentials are -passed using HTTP `Basic -Authentication <http://tools.ietf.org/html/rfc2617>`__. - -Credentials must not be passed on the query string. Credentials must be -sent in an Authorization header as follows: - -1. The username and password are formed into one string as - “username:password” - -2. The resulting string is Base64 encoded to produce the encoded - credential. - -3. The encoded credential is communicated in the header after the string - “Authorization: Basic “ - -Because the credentials are merely encoded but not encrypted, HTTPS -(rather than HTTP) should be used. HTTPS will also encrypt and protect -event contents. - -Examples are provided below. - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Sample Request -^^^^^^^^^^^^^^ - -+--------------------------------------------------------------+ -| POST /eventListener/v5 HTTPS/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": 3.0, | -| | -| "domain": "heartbeat", | -| | -| "eventName": "Heartbeat_vIsbcMmc", | -| | -| "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546015", | -| | -| "sequence": 0, | -| | -| "priority": "Normal", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "EricssonOamVf", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "ibcx0001vm002ssc001", | -| | -| "nfNamingCode": "ibcx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000 | -| | -| } | -| | -| } | -| | -| } | -+--------------------------------------------------------------+ - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -+------------------------+ - -Resource Structure -================== - -REST resources are defined with respect to a ServerRoot: - -ServerRoot = /{optionalRoutingtPath} - -The resource structure is provided below: - -|image2| - -Figure – REST Resource Structure - -The {Domain} or FQDN above is typically provisioned into each -eventsource when it is instantiated. The {Port} above is typically 8443. - -Common Event Format -=================== - -A JSON schema describing the Common Event Format is provided below and -is reproduced in the tables that follow. - -Note on optional fields: - - If the event publisher collects a field that is identified as - optional in the data structures below, then the event publisher - *must* send that field. - -Note on extensible fields: - - VES contains various extensible structures (e.g., hashMap) that - enable event publishers to send information that has not been - explicitly defined in VES data structures. - -- Event publishers *must not* send information through extensible - structures where VES has explicitly defined fields for that - information. For example, event publishers *must not* send - information like cpuIdle, through an extensible structure, because - VES has explicitly defined a cpuUsage.cpuIdle field for the - communication of that information. - -- Keys sent through extensible fields must use camel casing to separate - words and acronyms; only the first letter of each acronym shall be - capitalized. - -Common Event Datatypes ----------------------- - -.. _common-event-datatypes-1: - -Common Event Datatypes -~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: arrayOfJsonObject -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The arrayOfJsonObject datatype provides an array of json objects, each -of which is described by name, schema and other meta-information. It -consists of the following fields: - -+-------------------+----------------+-----------+---------------------+ -| Field | Type | Required? | Description | -+===================+================+===========+=====================+ -| arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject | -+-------------------+----------------+-----------+---------------------+ - -Datatype: arrayOfNamedHashmap -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The arrayOfNamedHashmap datatype provides an array of hashMaps, each of -which is associated with a descriptive name. It consists of the -following fields: - -+---------------------+------------------+-----------+-----------------------+ -| Field | Type | Required? | Description | -+=====================+==================+===========+=======================+ -| arrayOfNamedHashmap | namedHashMap [ ] | Yes | Array of namedHashMap | -+---------------------+------------------+-----------+-----------------------+ - -Datatype: event -^^^^^^^^^^^^^^^ - -The event datatype consists of the following fields which constitute the -‘root level’ of the common event format: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| commonEventHead | commonEventHead | Yes | Fields common | -| er | er | | to all events | -+-----------------+-----------------+-----------------+-----------------+ -| faultFields | faultFields | No | Fields specific | -| | | | to fault events | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatFields | heartbeatFields | No | Fields specific | -| | | | to heartbeat | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| measurementFiel | measurementFiel | No | Fields specific | -| ds | ds | | to measurement | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| mobileFlowField | mobileFlowField | No | Fields specific | -| s | s | | to mobility | -| | | | flow events | -+-----------------+-----------------+-----------------+-----------------+ -| notificationFie | notificationFie | No | Fields specific | -| lds | lds | | to notification | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| otherFields | otherFields | No | Fields specific | -| | | | to other types | -| | | | of events | -+-----------------+-----------------+-----------------+-----------------+ -| pnfRegistration | pnfRegistration | No | Fields specific | -| Fields | Fields | | to | -| | | | pnfRegistration | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| sipSignalingFie | sipSignalingFie | No | Fields specific | -| lds | lds | | to sipSignaling | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| stateChangeFiel | stateChangeFiel | No | Fields specific | -| ds | ds | | to state change | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFields | syslogFields | No | Fields specific | -| | | | to syslog | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| thresholdCrossi | thresholdCrossi | No | Fields specific | -| ngAlertFields | ngAlertFields | | to threshold | -| | | | crossing alert | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ -| voiceQualityFie | voiceQualityFie | No | Fields specific | -| lds | lds | | to voiceQuality | -| | | | events | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: eventList -^^^^^^^^^^^^^^^^^^^ - -The eventList datatype consists of the following fields: - -+-----------+-----------+-----------+-----------------+ -| Field | Type | Required? | Description | -+===========+===========+===========+=================+ -| eventList | event [ ] | Yes | Array of events | -+-----------+-----------+-----------+-----------------+ - -Datatype: hashMap -^^^^^^^^^^^^^^^^^ - -The hashMap datatype is an associative array which is an array of -key-value pairs of the form “key”: “value”, where each key and value are -strings. Keys must use camel casing to separate words and acronyms; only -the first letter of each acronym shall be capitalized. - -Datatype: jsonObject -^^^^^^^^^^^^^^^^^^^^ - -The jsonObject datatype provides a json object schema, name and other -meta-information along with one or more object instances that conform to -the schema: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| objectInstances | JsonObjectInsta | Yes | Contains one or | -| | nce | | more instances | -| | [ ] | | of the json | -| | | | object | -+-----------------+-----------------+-----------------+-----------------+ -| objectName | string | Yes | Name of the | -| | | | json object | -+-----------------+-----------------+-----------------+-----------------+ -| objectSchema | string | No | json schema for | -| | | | the object | -+-----------------+-----------------+-----------------+-----------------+ -| objectSchemaUrl | string | No | URL to the json | -| | | | schema for the | -| | | | object | -+-----------------+-----------------+-----------------+-----------------+ -| nfSubscribedObj | string | No | Name of the | -| ectName | | | object | -| | | | associated with | -| | | | the | -| | | | nfSubscriptionI | -| | | | d | -+-----------------+-----------------+-----------------+-----------------+ -| nfSubscriptionI | string | No | Identifies an | -| d | | | openConfig | -| | | | telemetry | -| | | | subscription on | -| | | | a network | -| | | | function, which | -| | | | configures the | -| | | | network | -| | | | function to | -| | | | send complex | -| | | | object data | -| | | | associated with | -| | | | the jsonObject | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: jsonObjectInstance -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The jsonObjectInstance datatype provides meta-information about an -instance of a jsonObject along with the actual object instance: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| objectInstance | object | Yes | Contains an | -| | | | instance | -| | | | conforming to | -| | | | the jsonObject | -| | | | schema | -+-----------------+-----------------+-----------------+-----------------+ -| objectInstanceE | number | No | the unix time, | -| pochMicrosec | | | aka epoch time, | -| | | | associated with | -| | | | this | -| | | | objectInstance- | -| | | | -as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| objectKeys | key [ ] | No | An ordered set | -| | | | of keys that | -| | | | identifies this | -| | | | particular | -| | | | instance of | -| | | | jsonObject | -| | | | (e.g., that | -| | | | places it in a | -| | | | hierarchy) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: key -^^^^^^^^^^^^^ - -The key datatype is a tuple which provides the name of a key along with -its value and relative order; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| keyName | string | Yes | Name of the key | -+-----------------+-----------------+-----------------+-----------------+ -| keyOrder | Integer | No | Relative | -| | | | sequence or | -| | | | order of the | -| | | | key (with | -| | | | respect to | -| | | | other keys) | -+-----------------+-----------------+-----------------+-----------------+ -| keyValue | string | No | Value of the | -| | | | key | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: namedHashmap -^^^^^^^^^^^^^^^^^^^^^^ - -The namedHashmap datatype is a hashMap which is associated with and -described by a name; it consists of the following fields: - -+---------+---------+-----------+------------------------------------------------+ -| Field | Type | Required? | Description | -+=========+=========+===========+================================================+ -| name | string | Yes | Name associated with or describing the hashmap | -+---------+---------+-----------+------------------------------------------------+ -| hashMap | hashMap | Yes | One or more key:value pairs | -+---------+---------+-----------+------------------------------------------------+ - -Datatype: requestError -^^^^^^^^^^^^^^^^^^^^^^ - -The requestError datatype defines the standard request error data -structure: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| messageId | string | Yes | Unique message | -| | | | identifier of | -| | | | the format | -| | | | ‘ABCnnnn’ where | -| | | | ‘ABC’ is either | -| | | | ‘SVC’ for | -| | | | Service | -| | | | Exceptions or | -| | | | ‘POL’ for | -| | | | Policy | -| | | | Exception. | -| | | | Exception | -| | | | numbers may be | -| | | | in the range of | -| | | | 0001 to 9999 | -| | | | where 0001 to | -| | | | 2999 are | -| | | | defined by OMA | -| | | | (see section | -| | | | 5.1) and | -| | | | 3000-9999 are | -| | | | available and | -| | | | undefined. | -+-----------------+-----------------+-----------------+-----------------+ -| text | string | Yes | Message text, | -| | | | with | -| | | | replacement | -| | | | variables | -| | | | marked with %n, | -| | | | where n is an | -| | | | index into the | -| | | | list of | -| | | | <variables> | -| | | | elements, | -| | | | starting at 1 | -+-----------------+-----------------+-----------------+-----------------+ -| url | string | No | Hyperlink to a | -| | | | detailed error | -| | | | resource e.g., | -| | | | an HTML page | -| | | | for browser | -| | | | user agents | -+-----------------+-----------------+-----------------+-----------------+ -| variables | string | No | List of zero or | -| | | | more strings | -| | | | that represent | -| | | | the contents of | -| | | | the variables | -| | | | used by the | -| | | | message text | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: vendorNfNameFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The vendorNfNameFields provides vendor, nf and nfModule identifying -information: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| vendorName | string | Yes | Network | -| | | | function vendor | -| | | | name | -+-----------------+-----------------+-----------------+-----------------+ -| nfModuleName | string | No | Name of the | -| | | | nfModule | -| | | | generating the | -| | | | event | -+-----------------+-----------------+-----------------+-----------------+ -| nfName | string | No | Name of the | -| | | | network | -| | | | function | -| | | | generating the | -| | | | event | -+-----------------+-----------------+-----------------+-----------------+ - -‘Common Event Header’ Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: commonEventHeader -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The commonEventHeader datatype consists of the following fields common -to all events: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| domain | string | Yes | Event domain | -| | | | enumeration: | -| | | | ‘fault’, | -| | | | ‘heartbeat’, | -| | | | ‘measurement’, | -| | | | ‘mobileFlow’, | -| | | | ‘notification’, | -| | | | ‘other’, | -| | | | ‘pnfRegistratio | -| | | | n’, | -| | | | ‘sipSignaling’, | -| | | | ‘stateChange’, | -| | | | ‘syslog’, | -| | | | ‘thresholdCross | -| | | | ingAlert’, | -| | | | ‘voiceQuality’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventId | string | Yes | Event key that | -| | | | is unique to | -| | | | the event | -| | | | source. | -| | | | The key must be | -| | | | unique within | -| | | | notification | -| | | | life cycle | -| | | | similar to | -| | | | EventID from | -| | | | 3GPP. It could | -| | | | be a sequential | -| | | | number, or a | -| | | | composite key | -| | | | formed from the | -| | | | event fields, | -| | | | such as | -| | | | domain_sequence | -| | | | . | -| | | | The eventId | -| | | | should not | -| | | | include | -| | | | whitespace. For | -| | | | fault events, | -| | | | eventId is the | -| | | | eventId of the | -| | | | initial alarm; | -| | | | if the same | -| | | | alarm is raised | -| | | | again for | -| | | | changed, | -| | | | acknowledged or | -| | | | cleared cases, | -| | | | eventId must be | -| | | | the same as the | -| | | | initial alarm | -| | | | (along with the | -| | | | same | -| | | | startEpochMicro | -| | | | sec | -| | | | but with a | -| | | | different | -| | | | sequence | -| | | | number). Note: | -| | | | see section 1.3 | -| | | | for eventide | -| | | | use case | -| | | | examples. | -+-----------------+-----------------+-----------------+-----------------+ -| eventName | string | Yes | Unique event | -| | | | name (see | -| | | | section 1.2 for | -| | | | more | -| | | | information) | -+-----------------+-----------------+-----------------+-----------------+ -| eventType | string | No | For example: | -| | | | ‘applicationNf’ | -| | | | , | -| | | | ‘guestOS’, | -| | | | ‘hostOS’, | -| | | | ‘platform’ | -+-----------------+-----------------+-----------------+-----------------+ -| internalHeader | internalHeader | No | Fields (not | -| Fields | Fields | | supplied by | -| | | | event sources) | -| | | | that the VES | -| | | | Event Listener | -| | | | service can use | -| | | | to enrich the | -| | | | event if needed | -| | | | for efficient | -| | | | internal | -| | | | processing. | -| | | | This is an | -| | | | empty object | -| | | | which is | -| | | | intended to be | -| | | | defined | -| | | | separately by | -| | | | each provider | -| | | | implementing | -| | | | the VES Event | -| | | | Listener. | -+-----------------+-----------------+-----------------+-----------------+ -| lastEpochMicros | number | Yes | the latest unix | -| ec | | | time aka epoch | -| | | | time associated | -| | | | with the event | -| | | | from any | -| | | | component--as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| nfcNamingCode | string | No | Network | -| | | | function | -| | | | component type: | -| | | | 3 characters | -| | | | (aligned with | -| | | | vfc naming | -| | | | standards) | -+-----------------+-----------------+-----------------+-----------------+ -| nfNamingCode | string | No | Network | -| | | | function type: | -| | | | 4 characters | -| | | | (aligned with | -| | | | vnf and pnf | -| | | | naming | -| | | | standards) | -+-----------------+-----------------+-----------------+-----------------+ -| priority | string | Yes | Processing | -| | | | priority | -| | | | enumeration: | -| | | | ‘High’, | -| | | | ‘Medium’, | -| | | | ‘Normal’, ‘Low’ | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEntity | string | No | UUID | -| Id | | | identifying the | -| | | | entity | -| | | | reporting the | -| | | | event or | -| | | | detecting a | -| | | | problem in | -| | | | another vnf/vm | -| | | | or pnf which is | -| | | | experiencing | -| | | | the problem. | -| | | | (Note: the AT&T | -| | | | internal | -| | | | enrichment | -| | | | process shall | -| | | | ensure that | -| | | | this field is | -| | | | populated). The | -| | | | reportingEntity | -| | | | Id | -| | | | is an id for | -| | | | the | -| | | | reportingEntity | -| | | | Name. | -| | | | See | -| | | | ‘reportingEntit | -| | | | yName’ | -| | | | for more | -| | | | information. | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEntity | string | Yes | Name of the | -| Name | | | entity | -| | | | reporting the | -| | | | event or | -| | | | detecting a | -| | | | problem in | -| | | | another vnf/vm | -| | | | or pnf which is | -| | | | experiencing | -| | | | the problem. | -| | | | May be the same | -| | | | as the | -| | | | sourceName. For | -| | | | synthetic | -| | | | events | -| | | | generated by | -| | | | DCAE, it is the | -| | | | name of the app | -| | | | generating the | -| | | | event. | -+-----------------+-----------------+-----------------+-----------------+ -| sequence | integer | Yes | Ordering of | -| | | | events | -| | | | communicated by | -| | | | an event source | -| | | | instance (or 0 | -| | | | if not needed) | -+-----------------+-----------------+-----------------+-----------------+ -| sourceId | string | No | UUID | -| | | | identifying the | -| | | | entity | -| | | | experiencing | -| | | | the event | -| | | | issue, which | -| | | | may be detected | -| | | | and reported by | -| | | | a separate | -| | | | reporting | -| | | | entity (note: | -| | | | the AT&T | -| | | | internal | -| | | | enrichment | -| | | | process shall | -| | | | ensure that | -| | | | this field is | -| | | | populated). The | -| | | | sourceId is an | -| | | | id for the | -| | | | sourceName. See | -| | | | ‘sourceName’ | -| | | | for more | -| | | | information. | -+-----------------+-----------------+-----------------+-----------------+ -| sourceName | string | Yes | Name of the | -| | | | entity | -| | | | experiencing | -| | | | the event | -| | | | issue, which | -| | | | may be detected | -| | | | and reported by | -| | | | a separate | -| | | | reporting | -| | | | entity. The | -| | | | sourceName | -| | | | identifies the | -| | | | device for | -| | | | which data is | -| | | | collected. A | -| | | | valid | -| | | | sourceName must | -| | | | be inventoried | -| | | | in A&AI. If | -| | | | sourceName is a | -| | | | xNFC or VM, | -| | | | then the event | -| | | | must be | -| | | | reporting data | -| | | | for that | -| | | | particular xNFC | -| | | | or VM. If the | -| | | | sourceName is a | -| | | | xNF, comprised | -| | | | of multiple | -| | | | xNFCs, the data | -| | | | must be | -| | | | reported/aggreg | -| | | | ated | -| | | | at the xNF | -| | | | leveI. Data | -| | | | for individual | -| | | | xNFC must not | -| | | | be included in | -| | | | the xNF | -| | | | sourceName | -| | | | event. | -+-----------------+-----------------+-----------------+-----------------+ -| startEpochMicro | number | Yes | the earliest | -| sec | | | unix time aka | -| | | | epoch time | -| | | | associated with | -| | | | the event from | -| | | | any | -| | | | component--as | -| | | | microseconds | -| | | | elapsed since 1 | -| | | | Jan 1970 not | -| | | | including leap | -| | | | seconds. For | -| | | | measurements | -| | | | and heartbeats, | -| | | | where events | -| | | | are collected | -| | | | over predefined | -| | | | intervals, | -| | | | startEpochMicro | -| | | | sec | -| | | | shall be | -| | | | rounded to the | -| | | | nearest | -| | | | interval | -| | | | boundary (e.g., | -| | | | the epoch | -| | | | equivalent of | -| | | | 3:00PM, 3:10PM, | -| | | | 3:20PM, etc…). | -| | | | For fault | -| | | | events, | -| | | | startEpochMicro | -| | | | sec | -| | | | is the | -| | | | timestamp of | -| | | | the initial | -| | | | alarm; if the | -| | | | same alarm is | -| | | | raised again | -| | | | for changed, | -| | | | acknowledged or | -| | | | cleared cases, | -| | | | startEpoch | -| | | | Microsec must | -| | | | be the same as | -| | | | the initial | -| | | | alarm (along | -| | | | with the same | -| | | | eventId and an | -| | | | incremental | -| | | | sequence | -| | | | number). For | -| | | | devices with no | -| | | | timing source | -| | | | (clock), the | -| | | | default value | -| | | | will be 0 and | -| | | | the VES | -| | | | collector will | -| | | | replace it with | -| | | | Collector time | -| | | | stamp (when the | -| | | | event is | -| | | | received) | -+-----------------+-----------------+-----------------+-----------------+ -| timeZoneOffset | Number | No | Offset to GMT | -| | | | to indicate | -| | | | local time zone | -| | | | for device | -+-----------------+-----------------+-----------------+-----------------+ -| version | number | Yes | Version of the | -| | | | event header | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: internalHeaderFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The internalHeaderFields datatype is an undefined object which can -contain arbitrarily complex JSON structures. It is intended to be -defined separately by each provider implementing the VES Event Listener. -The fields in internalHeaderFields are not provided by any event source -but instead are added by the VES Event Listener service itself as part -of an event enrichment process necessary for efficient internal -processing of events received by the VES Event Listener: - -Technology Independent Datatypes --------------------------------- - -‘Fault’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: faultFields -^^^^^^^^^^^^^^^^^^^^^ - -The faultFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| alarmAdditional | hashMap | No | Additional | -| Information | | | alarm | -| | | | information. | -| | | | | -| | | | - Note1: for | -| | | | SNMP mapping | -| | | | to VES, for | -| | | | hash key use | -| | | | OID of | -| | | | varbind, for | -| | | | value use | -| | | | incoming | -| | | | data for | -| | | | that | -| | | | varbind). | -| | | | | -| | | | - Note2: Alarm | -| | | | ID for 3GPP | -| | | | should be | -| | | | included (if | -| | | | applicable) | -| | | | in | -| | | | alarmAdditon | -| | | | alInformation | -| | | | as | -| | | | ‘alarmId’:’a | -| | | | larmIdValue’. | -| | | | | -| | | | Could contain | -| | | | managed object | -| | | | instance as | -| | | | separate | -| | | | key:value; | -| | | | could add | -| | | | probable cause | -| | | | as separate | -| | | | key:value. | -+-----------------+-----------------+-----------------+-----------------+ -| alarmCondition | string | Yes | Short name of | -| | | | the alarm | -| | | | condition/probl | -| | | | em, | -| | | | such as a trap | -| | | | name. Should | -| | | | not have white | -| | | | space (e.g., | -| | | | tpLgCgiNotInCon | -| | | | fig, | -| | | | BfdSessionDown, | -| | | | linkDown, etc…) | -+-----------------+-----------------+-----------------+-----------------+ -| alarmInterfaceA | string | No | Card, port, | -| | | | channel or | -| | | | interface name | -| | | | of the device | -| | | | generating the | -| | | | alarm. This | -| | | | could reflect | -| | | | managed object. | -+-----------------+-----------------+-----------------+-----------------+ -| eventCategory | string | No | Event category, | -| | | | for example: | -| | | | ‘license’, | -| | | | ‘link’, | -| | | | ‘routing’, | -| | | | ‘security’, | -| | | | ‘signaling’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventSeverity | string | Yes | Event severity | -| | | | enumeration: | -| | | | ‘CRITICAL’, | -| | | | ‘MAJOR’, | -| | | | ‘MINOR’, | -| | | | ‘WARNING’, | -| | | | ‘NORMAL’. | -| | | | NORMAL is used | -| | | | to represent | -| | | | clear. | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceType | string | Yes | Examples: | -| | | | ‘card’, ‘host’, | -| | | | ‘other’, | -| | | | ‘port’, | -| | | | ‘portThreshold’ | -| | | | , | -| | | | ‘router’, | -| | | | ‘slotThreshold’ | -| | | | , | -| | | | ‘switch’, | -| | | | ‘virtualMachine | -| | | | ’, | -| | | | ‘virtualNetwork | -| | | | Function’. | -| | | | This could be | -| | | | managed object | -| | | | class. | -+-----------------+-----------------+-----------------+-----------------+ -| faultFieldsVers | number | Yes | Version of the | -| ion | | | faultFields | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| specificProblem | string | Yes | Description of | -| | | | the alarm or | -| | | | problem (e.g., | -| | | | ‘eNodeB 155197 | -| | | | in PLMN 310-410 | -| | | | with eNodeB | -| | | | name KYL05197 | -| | | | is lost’). 3GPP | -| | | | probable cause | -| | | | would be | -| | | | included in | -| | | | this field. | -+-----------------+-----------------+-----------------+-----------------+ -| vfStatus | string | Yes | Virtual | -| | | | function status | -| | | | enumeration: | -| | | | ‘Active’, | -| | | | ‘Idle’, | -| | | | ‘Preparing to | -| | | | terminate’, | -| | | | ‘Ready to | -| | | | terminate’, | -| | | | ‘Requesting | -| | | | Termination’ | -+-----------------+-----------------+-----------------+-----------------+ - -‘Heartbeat’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: heartbeatFields -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The heartbeatFields datatype is an optional field block for fields -specific to heartbeat events; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | expansion | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatFields | number | Yes | Version of the | -| Version | | | heartbeatFields | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| heartbeatInterv | Integer | Yes | Current | -| al | | | heartbeatInterv | -| | | | al | -| | | | in seconds | -+-----------------+-----------------+-----------------+-----------------+ - - ‘Measurements’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: codecsInUse -^^^^^^^^^^^^^^^^^^^^^ - -The codecsInUse datatype consists of the following fields describing the -number of times an identified codec was used over the -measurementInterval: - -+----------------+---------+-----------+------------------------------+ -| Field | Type | Required? | Description | -+================+=========+===========+==============================+ -| codecIdentifer | string | Yes | Description of the codec | -+----------------+---------+-----------+------------------------------+ -| numberInUse | integer | Yes | Number of such codecs in use | -+----------------+---------+-----------+------------------------------+ - -Datatype: cpuUsage -^^^^^^^^^^^^^^^^^^ - -The cpuUsage datatype defines the usage of an identifier CPU and -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| cpuCapacityCont | number | No | The amount of | -| ention | | | time the CPU | -| | | | cannot run due | -| | | | to contention, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandAvg | number | No | The total CPU | -| | | | time that the | -| | | | NF/NFC/VM could | -| | | | use if there | -| | | | was no | -| | | | contention, in | -| | | | milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandMhz | number | No | CPU demand in | -| | | | MHz | -+-----------------+-----------------+-----------------+-----------------+ -| cpuDemandPct | number | No | CPU demand as a | -| | | | percentage of | -| | | | the provisioned | -| | | | capacity | -+-----------------+-----------------+-----------------+-----------------+ -| cpuIdentifier | string | Yes | CPU Identifier | -+-----------------+-----------------+-----------------+-----------------+ -| cpuIdle | number | No | Percentage of | -| | | | CPU time spent | -| | | | in the idle | -| | | | task | -+-----------------+-----------------+-----------------+-----------------+ -| cpuLatencyAvg | number | No | Percentage of | -| | | | time the VM is | -| | | | unable to run | -| | | | because it is | -| | | | contending for | -| | | | access to the | -| | | | physical CPUs | -+-----------------+-----------------+-----------------+-----------------+ -| cpuOverheadAvg | number | No | The overhead | -| | | | demand above | -| | | | available | -| | | | allocations and | -| | | | reservations, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuSwapWaitTime | number | No | Swap wait time, | -| | | | in milliseconds | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageInterru | number | No | Percentage of | -| pt | | | time spent | -| | | | servicing | -| | | | interrupts | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageNice | number | No | Percentage of | -| | | | time spent | -| | | | running user | -| | | | space processes | -| | | | that have been | -| | | | niced | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSoftIrq | number | No | Percentage of | -| | | | time spent | -| | | | handling soft | -| | | | irq interrupts | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSteal | number | No | Percentage of | -| | | | time spent in | -| | | | involuntary | -| | | | wait which is | -| | | | neither user, | -| | | | system or idle | -| | | | time and is | -| | | | effectively | -| | | | time that went | -| | | | missing | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageSystem | number | No | Percentage of | -| | | | time spent on | -| | | | system tasks | -| | | | running the | -| | | | kernel | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageUser | number | No | Percentage of | -| | | | time spent | -| | | | running | -| | | | un-niced user | -| | | | space processes | -+-----------------+-----------------+-----------------+-----------------+ -| cpuWait | number | No | Percentage of | -| | | | CPU time spent | -| | | | waiting for I/O | -| | | | operations to | -| | | | complete | -+-----------------+-----------------+-----------------+-----------------+ -| percentUsage | number | Yes | Aggregate cpu | -| | | | usage of the | -| | | | virtual machine | -| | | | on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: diskUsage -^^^^^^^^^^^^^^^^^^^ - -The diskUsage datatype defines the usage of a disk and consists of the -following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| diskBusResets | number | No | Number of bus | -| | | | resets over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskCommandsAbo | number | No | Number of disk | -| rted | | | commands | -| | | | aborted over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskCommandsAvg | number | No | Average number | -| | | | of commands per | -| | | | second over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskFlushReques | number | No | Total flush | -| ts | | | requests of the | -| | | | disk cache over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskFlushTime | number | No | Milliseconds | -| | | | spent on disk | -| | | | cache flushing | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIdentifier | string | Yes | Disk Identifier | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeAvg | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the average | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeLast | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeMax | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the maximum | -| | | | value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskIoTimeMin | number | No | Milliseconds | -| | | | spent doing | -| | | | input/output | -| | | | operations over | -| | | | 1 sec; treat | -| | | | this metric as | -| | | | a device load | -| | | | percentage | -| | | | where 1000ms | -| | | | matches 100% | -| | | | load; provide | -| | | | the minimum | -| | | | value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadA | number | No | Number of | -| vg | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadL | number | No | Number of | -| ast | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadM | number | No | Number of | -| ax | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | maximum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedReadM | number | No | Number of | -| in | | | logical read | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | read | -| | | | operations, | -| | | | e.g., two | -| | | | logical reads | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | minimum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Avg | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Last | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | last value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Max | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | maximum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskMergedWrite | number | No | Number of | -| Min | | | logical write | -| | | | operations that | -| | | | were merged | -| | | | into physical | -| | | | write | -| | | | operations, | -| | | | e.g., two | -| | | | logical writes | -| | | | were served by | -| | | | one physical | -| | | | disk access; | -| | | | provide the | -| | | | minimum value | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Avg | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| | | | octets per | -| Last | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Max | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsRead | number | No | Number of | -| Min | | | octets per | -| | | | second read | -| | | | from a disk or | -| | | | partition; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Avg | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Last | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Max | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOctetsWrite | number | No | Number of | -| Min | | | octets per | -| | | | second written | -| | | | to a disk or | -| | | | partition; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadAvg | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadLast | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadMax | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsReadMin | number | No | Number of read | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteAvg | number | No | Number of write | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteLas | number | No | Number of write | -| t | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWrite | number | No | Number of write | -| Max | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskOpsWriteMin | number | No | Number of write | -| | | | operations per | -| | | | second issued | -| | | | to the disk; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsAvg | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsLast | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsMax | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskPendingOper | number | No | Queue size of | -| ationsMin | | | pending I/O | -| | | | operations per | -| | | | second; provide | -| | | | the minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskReadCommand | number | No | Average number | -| sAvg | | | of read | -| | | | commands issued | -| | | | per second to | -| | | | the disk over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTime | number | No | Nanoseconds | -| | | | spent on disk | -| | | | cache | -| | | | reads/writes | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeReadAvg | number | No | Milliseconds a | -| | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Last | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Max | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeRead | number | No | Milliseconds a | -| Min | | | read operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Avg | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | average | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Last | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | last | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Max | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | maximum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTimeWrite | number | No | Milliseconds a | -| Min | | | write operation | -| | | | took to | -| | | | complete; | -| | | | provide the | -| | | | minimum | -| | | | measurement | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTotalReadLa | number | No | Average read | -| tencyAvg | | | time from the | -| | | | perspective of | -| | | | a Guest OS: sum | -| | | | of the Kernel | -| | | | Read Latency | -| | | | and Physical | -| | | | Device Read | -| | | | Latency in | -| | | | milliseconds | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskTotalWriteL | number | No | Average write | -| atencyAvg | | | time from the | -| | | | perspective of | -| | | | a Guest OS: sum | -| | | | of the Kernel | -| | | | Write Latency | -| | | | and Physical | -| | | | Device Write | -| | | | Latency in | -| | | | milliseconds | -| | | | over the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| diskWriteComman | number | No | Average number | -| dsAvg | | | of write | -| | | | commands issued | -| | | | per second to | -| | | | the disk over | -| | | | the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: filesystemUsage -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The filesystemUsage datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| filesystemName | string | Yes | File system | -| | | | name | -+-----------------+-----------------+-----------------+-----------------+ -| blockConfigured | number | Yes | Configured | -| | | | block storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| blockIops | number | Yes | Block storage | -| | | | input-output | -| | | | operations per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| blockUsed | number | Yes | Used block | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralConfig | number | Yes | Configured | -| ured | | | ephemeral | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralIops | number | Yes | Ephemeral | -| | | | storage | -| | | | input-output | -| | | | operations per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| ephemeralUsed | number | Yes | Used ephemeral | -| | | | storage | -| | | | capacity in GB | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: hugePages -^^^^^^^^^^^^^^^^^^^ - -The hugePages datatype provides metrics on system hugePages; it consists -of the following fields: - -+---------------------+--------+-----------+-------------------------------------+ -| Field | Type | Required? | Description | -+=====================+========+===========+=====================================+ -| bytesFree | number | No | Number of free hugePages in bytes | -+---------------------+--------+-----------+-------------------------------------+ -| bytesUsed | number | No | Number of used hugePages in bytes | -+---------------------+--------+-----------+-------------------------------------+ -| hugePagesIdentifier | string | Yes | HugePages identifier | -+---------------------+--------+-----------+-------------------------------------+ -| percentFree | number | No | Number of free hugePages in percent | -+---------------------+--------+-----------+-------------------------------------+ -| percentUsed | number | No | Number of used hugePages in percent | -+---------------------+--------+-----------+-------------------------------------+ -| vmPageNumberFree | number | No | Number of free vmPages in numbers | -+---------------------+--------+-----------+-------------------------------------+ -| vmPageNumberUsed | number | No | Number of used vmPages in numbers | -+---------------------+--------+-----------+-------------------------------------+ - -Datatype: ipmi (Intelligent Platform Management Interface) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmi datatype provides intelligent platform management interface -metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| exitAirTemperat | number | No | System fan exit | -| ure | | | air flow | -| | | | temperature in | -| | | | Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| frontPanelTempe | number | No | Front panel | -| rature | | | temp in Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| ioModuleTempera | number | No | Io module temp | -| ture | | | in Celsius | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBaseboardTe | ipmiBaseboard | No | Array of | -| mperatureArray | Temperature [ ] | | ipmiBaseboard | -| | | | Temperature | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBaseboardVo | ipmiBaseboard | No | Array of | -| ltageRegulator | VoltageRegulato | | ipmiBaseboard | -| Array | r | | VoltageRegulato | -| | [ ] | | r | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiBatteryArra | ipmiBattery [ ] | No | Array of | -| y | | | ipmiBattery | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiFanArray | ipmiFan [ ] | No | Array of | -| | | | ipmiFan objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiHsbpArray | ipmiHsbp [ ] | No | Array of | -| | | | ipmiHsbp | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiGlobalAggre | ipmiGlobalAggre | No | ipmi global | -| gateTemperature | gate | | aggregate | -| | | | temperature | -| MarginArray | TemperatureMarg | | margin | -| | in | | | -| | [ ] | | | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiNicArray | ipmiNic [ ] | No | Array of | -| | | | ipmiNic objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiPowerSupply | ipmiPowerSupply | No | Array of | -| Array | [ ] | | ipmiPowerSupply | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiProcessorAr | ipmiProcessor [ | No | Array of | -| ray | ] | | ipmiProcessor | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ -| systemAirflow | number | No | Airflow in | -| | | | cubic feet per | -| | | | minute (cfm) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBaseboardTemperature -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBaseboardTemperature datatype consists of the following fields -which describe ipmi baseboard temperature metrics: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| baseboardTemper | string | Yes | Identifier for | -| ature | | | the location | -| Identifier | | | where the | -| | | | temperature is | -| | | | taken | -+-----------------+-----------------+-----------------+-----------------+ -| baseboardTemper | number | No | Baseboard | -| ature | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBaseboardVoltageRegulator -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBaseboardVoltageRegulator datatype consists of the following -fields which describe ipmi baseboard voltage regulator metrics: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| baseboardVoltag | string | Yes | Identifier for | -| e | | | the baseboard | -| RegulatorIdenti | | | voltage | -| fier | | | regulator | -+-----------------+-----------------+-----------------+-----------------+ -| voltageRegulato | number | No | Voltage | -| r | | | regulator | -| Temperature | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiBattery -^^^^^^^^^^^^^^^^^^^^^ - -The ipmiBattery datatype consists of the following fields which describe -ipmi battery metrics: - -+---------------------+--------+-----------+----------------------------+ -| Field | Type | Required? | Description | -+=====================+========+===========+============================+ -| batteryIdentifier | string | Yes | Identifier for the battery | -+---------------------+--------+-----------+----------------------------+ -| batteryType | string | No | Type of battery | -+---------------------+--------+-----------+----------------------------+ -| batteryVoltageLevel | number | No | Battery voltage level | -+---------------------+--------+-----------+----------------------------+ - -Datatype: ipmiFan -^^^^^^^^^^^^^^^^^ - -The ipmiFan datatype consists of the following fields which describe -ipmi fan metrics: - -+---------------+--------+-----------+-------------------------------------------+ -| Field | Type | Required? | Description | -+===============+========+===========+===========================================+ -| fanIdentifier | string | Yes | Identifier for the fan | -+---------------+--------+-----------+-------------------------------------------+ -| fanSpeed | number | No | Fan speed in revolutions per minute (rpm) | -+---------------+--------+-----------+-------------------------------------------+ - -Datatype: ipmiHsbp -^^^^^^^^^^^^^^^^^^ - -The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| hsbpIdentifier | string | Yes | Identifier for | -| | | | the hot swap | -| | | | backplane power | -| | | | unit | -+-----------------+-----------------+-----------------+-----------------+ -| hsbpTemperature | number | No | Hot swap | -| | | | backplane power | -| | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiNic -^^^^^^^^^^^^^^^^^ - -The ipmiNic datatype provides network interface control care metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| nicIdentifier | string | Yes | Identifier for | -| | | | the network | -| | | | interface | -| | | | control card | -+-----------------+-----------------+-----------------+-----------------+ -| nicTemperature | number | No | nic temperature | -| | | | in Celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiPowerSupply -^^^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiPowerSupply datatype provides ipmi power supply metrics; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| powerSupplyIden | string | Yes | Identifier for | -| tifier | | | the power | -| | | | supply | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyInpu | number | No | Input power in | -| tPower | | | watts | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyCurr | number | No | Current output | -| entOutput | | | voltage as a | -| Percent | | | percentage of | -| | | | the design | -| | | | specified level | -+-----------------+-----------------+-----------------+-----------------+ -| powerSupplyTemp | number | No | Power supply | -| erature | | | temperature in | -| | | | Celsius | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: ipmiProcessor -^^^^^^^^^^^^^^^^^^^^^^^ - -The ipmiProcessor datatype provides ipmi processor metrics; it consists -of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| processorIdenti | string | Yes | Identifier for | -| fier | | | the power | -| | | | supply | -+-----------------+-----------------+-----------------+-----------------+ -| pprocessorTherm | number | No | Io module | -| alControl | | | temperatue in | -| Percent | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ -| processorDtsThe | number | No | Front panel | -| rmalMargin | | | temperature in | -| | | | celsius | -+-----------------+-----------------+-----------------+-----------------+ -| processorDimmAg | processorDimm | No | Array of | -| gregate | AggregateTherma | | processorDimmAg | -| ThermalMarginAr | l | | gregate | -| ray | Margin [ ] | | ThermalMargin | -| | | | objects | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: latencyBucketMeasure -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The latencyBucketMeasure datatype consists of the following fields which -describe the number of counts falling within a defined latency bucket: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| countsInTheBuck | number | Yes | Number of | -| et | | | counts falling | -| | | | within a | -| | | | defined latency | -| | | | bucket | -+-----------------+-----------------+-----------------+-----------------+ -| highEndOfLatenc | number | No | High end of | -| yBucket | | | bucket range | -| | | | (typically in | -| | | | ms) | -+-----------------+-----------------+-----------------+-----------------+ -| lowEndOfLatency | number | No | Low end of | -| Bucket | | | bucket range | -| | | | (typically in | -| | | | ms) | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: load -^^^^^^^^^^^^^^ - -The load datatype provides metrics on system cpu and io utilization -obtained using /proc/loadavg; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| longTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over | -| | | | 15 minutes | -| | | | using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ -| midTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over 5 | -| | | | minutes using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ -| shortTerm | number | No | number of jobs | -| | | | in the run | -| | | | queue (state R, | -| | | | cpu | -| | | | utilization) or | -| | | | waiting for | -| | | | disk I/O (state | -| | | | D, io | -| | | | utilization) | -| | | | averaged over 1 | -| | | | minute using | -| | | | /proc/loadavg | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: machineCheckException -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The machineCheckException datatype describes machine check exceptions; -it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| correctedMemory | number | No | Total hardware | -| Errors | | | errors that | -| | | | were corrected | -| | | | by the hardware | -| | | | (e.g. data | -| | | | corruption | -| | | | corrected via | -| | | | ECC) over the | -| | | | measurementInte | -| | | | rval. | -| | | | These errors do | -| | | | not require | -| | | | immediate | -| | | | software | -| | | | actions, but | -| | | | are still | -| | | | reported for | -| | | | accounting | -| | | | and predictive | -| | | | failure | -| | | | analysis | -+-----------------+-----------------+-----------------+-----------------+ -| correctedMemory | number | No | Total hardware | -| Errors | | | errors that | -| In1Hr | | | were corrected | -| | | | by the hardware | -| | | | over the last | -| | | | one hour | -+-----------------+-----------------+-----------------+-----------------+ -| uncorrectedMemo | number | No | Total | -| ryErrors | | | uncorrected | -| | | | hardware errors | -| | | | that were | -| | | | detected by the | -| | | | hardware (e.g., | -| | | | causing data | -| | | | corruption) | -| | | | over the | -| | | | measurementInte | -| | | | rval. | -| | | | These errors | -| | | | require a | -| | | | software | -| | | | response. | -+-----------------+-----------------+-----------------+-----------------+ -| uncorrectedMemo | number | No | Total | -| ryErrors | | | uncorrected | -| In1Hr | | | hardware errors | -| | | | that were | -| | | | detected by the | -| | | | hardware over | -| | | | the last one | -| | | | hour | -+-----------------+-----------------+-----------------+-----------------+ -| processIdentifi | string | Yes | processIdentifi | -| er | | | er | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: measurementFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The measurementFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | measurement | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalMeasu | arrayOfNamedHas | No | Array of named | -| rements | hMap | | hashMap if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalObjec | arrayOfJsonObje | No | Array of JSON | -| ts | ct | | objects | -| | | | described by | -| | | | name, schema | -| | | | and other | -| | | | meta-informatio | -| | | | n, | -| | | | if needed | -+-----------------+-----------------+-----------------+-----------------+ -| codecUsageArray | codecsInUse [] | No | Array of codecs | -| | | | in use | -+-----------------+-----------------+-----------------+-----------------+ -| concurrentSessi | integer | No | Peak concurrent | -| ons | | | sessions for | -| | | | the VM or xNF | -| | | | (depending on | -| | | | the context) | -| | | | over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| configuredEntit | integer | No | Depending on | -| ies | | | the context | -| | | | over the | -| | | | measurementInte | -| | | | rval: | -| | | | peak total | -| | | | number of | -| | | | users, | -| | | | subscribers, | -| | | | devices, | -| | | | adjacencies, | -| | | | etc., for the | -| | | | VM, or peak | -| | | | total number of | -| | | | subscribers, | -| | | | devices, etc., | -| | | | for the xNF | -+-----------------+-----------------+-----------------+-----------------+ -| cpuUsageArray | cpuUsage [] | No | Usage of an | -| | | | array of CPUs | -+-----------------+-----------------+-----------------+-----------------+ -| diskUsageArray | diskUsage [] | No | Usage of an | -| | | | array of disks | -+-----------------+-----------------+-----------------+-----------------+ -| featureUsageArr | hashMap | No | The hashMap key | -| ay | | | should identify | -| | | | the feature, | -| | | | while the value | -| | | | defines the | -| | | | number of times | -| | | | the identified | -| | | | feature was | -| | | | used | -+-----------------+-----------------+-----------------+-----------------+ -| filesystemUsage | filesystemUsage | No | Filesystem | -| Array | [ ] | | usage of the VM | -| | | | on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| hugePagesArray | hugePages [ ] | No | Array of | -| | | | metrics on | -| | | | hugePages | -+-----------------+-----------------+-----------------+-----------------+ -| ipmiArray | ipmi [ ] | No | Array of | -| | | | intelligent | -| | | | platform | -| | | | management | -| | | | interface | -| | | | metrics | -+-----------------+-----------------+-----------------+-----------------+ -| latencyDistribu | latencyBucketMe | No | Array of | -| tion | asure | | integers | -| | [ ] | | representing | -| | | | counts of | -| | | | requests whose | -| | | | latency in | -| | | | milliseconds | -| | | | falls within | -| | | | per-xNF | -| | | | configured | -| | | | ranges; where | -| | | | latency is the | -| | | | duration | -| | | | between a | -| | | | service request | -| | | | and its | -| | | | fulfillment. | -+-----------------+-----------------+-----------------+-----------------+ -| loadArray | load [ ] | No | Array of system | -| | | | load metrics | -+-----------------+-----------------+-----------------+-----------------+ -| machineCheckExc | machineCheckExc | No | Array of | -| eptionArray | eption | | machine check | -| | [ ] | | exceptions | -+-----------------+-----------------+-----------------+-----------------+ -| meanRequestLate | number | No | Mean seconds | -| ncy | | | required to | -| | | | respond to each | -| | | | request for the | -| | | | VM on which the | -| | | | xNFC reporting | -| | | | the event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| measurementFiel | number | Yes | Version of the | -| dsVersion | | | measurementFiel | -| | | | ds | -| | | | block. | -+-----------------+-----------------+-----------------+-----------------+ -| measurementInte | number | Yes | Interval over | -| rval | | | which | -| | | | measurements | -| | | | are being | -| | | | reported in | -| | | | seconds | -+-----------------+-----------------+-----------------+-----------------+ -| memoryUsageArra | memoryUsage [] | No | Memory usage of | -| y | | | an array of VMs | -+-----------------+-----------------+-----------------+-----------------+ -| numberOfMediaPo | integer | No | Number of media | -| rtsInUse | | | ports in use | -+-----------------+-----------------+-----------------+-----------------+ -| processStatsArr | processStats [ | No | Array of | -| ay | ] | | metrics on | -| | | | system | -| | | | processes | -+-----------------+-----------------+-----------------+-----------------+ -| requestRate | number | No | Peak rate of | -| | | | service | -| | | | requests per | -| | | | second to the | -| | | | xNF over the | -| | | | measurementInte | -| | | | rval | -+-----------------+-----------------+-----------------+-----------------+ -| nfcScalingMetri | integer | No | Represents | -| c | | | busy-ness of | -| | | | the network | -| | | | function from 0 | -| | | | to 100 as | -| | | | reported by the | -| | | | nfc | -+-----------------+-----------------+-----------------+-----------------+ -| nicPerformanceA | nicPerformance | No | Performance | -| rray | [ ] | | metrics of an | -| | | | array of | -| | | | network | -| | | | interface cards | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: memoryUsage -^^^^^^^^^^^^^^^^^^^^^ - -The memoryUsage datatype defines the memory usage of a virtual machine -and consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| memoryBuffered | number | No | Kibibytes of | -| | | | temporary | -| | | | storage for raw | -| | | | disk blocks | -+-----------------+-----------------+-----------------+-----------------+ -| memoryCached | number | No | Kibibytes of | -| | | | memory used for | -| | | | cache | -+-----------------+-----------------+-----------------+-----------------+ -| memoryConfigure | number | No | Kibibytes of | -| d | | | memory | -| | | | configured in | -| | | | the virtual | -| | | | machine on | -| | | | which the xNFC | -| | | | reporting the | -| | | | event is | -| | | | running | -+-----------------+-----------------+-----------------+-----------------+ -| memoryDemand | number | No | Host demand in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memoryFree | number | Yes | Kibibytes of | -| | | | physical RAM | -| | | | left unused by | -| | | | the system | -+-----------------+-----------------+-----------------+-----------------+ -| memoryLatencyAv | number | No | Percentage of | -| g | | | time the VM is | -| | | | waiting to | -| | | | access swapped | -| | | | or compressed | -| | | | memory | -+-----------------+-----------------+-----------------+-----------------+ -| memorySharedAvg | number | No | Shared memory | -| | | | in kilobytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySlabRecl | number | No | The part of the | -| | | | slab that can | -| | | | be reclaimed | -| | | | such as caches | -| | | | measured in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySlabUnrec | number | No | The part of the | -| l | | | slab that | -| | | | cannot be | -| | | | reclaimed even | -| | | | when lacking | -| | | | memory measure | -| | | | in kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapInAvg | number | No | Amount of | -| | | | memory | -| | | | swapped-in from | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapInRat | number | No | Rate at which | -| eAvg | | | memory is | -| | | | swapped from | -| | | | disk into | -| | | | active memory | -| | | | during the | -| | | | interval in | -| | | | kilobytes per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapOutAv | number | No | Amount of | -| g | | | memory | -| | | | swapped-out to | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapOutRa | number | No | Rate at which | -| teAvg | | | memory is being | -| | | | swapped from | -| | | | active memory | -| | | | to disk during | -| | | | the current | -| | | | interval in | -| | | | kilobytes per | -| | | | second | -+-----------------+-----------------+-----------------+-----------------+ -| memorySwapUsedA | number | No | Space used for | -| vg | | | caching swapped | -| | | | pages in the | -| | | | host cache in | -| | | | kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| memoryUsed | number | Yes | Total memory | -| | | | minus the sum | -| | | | of free, | -| | | | buffered, | -| | | | cached and slab | -| | | | memory measured | -| | | | in kibibytes | -+-----------------+-----------------+-----------------+-----------------+ -| vmIdentifier | string | Yes | Virtual Machine | -| | | | identifier | -| | | | associated with | -| | | | the memory | -| | | | metrics | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: nicPerformance -^^^^^^^^^^^^^^^^^^^^^^^^ - -The vNicPerformance datatype consists of the following fields which -describe the performance and errors of an of an identified virtual -network interface card: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| nicIdentifier | string | Yes | Network | -| | | | interface card | -| | | | identifier | -+-----------------+-----------------+-----------------+-----------------+ -| receivedBroadca | number | No | Cumulative | -| stPacketsAccumu | | | count of | -| lated | | | broadcast | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedBroadca | number | No | Count of | -| stPacketsDelta | | | broadcast | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedDiscard | number | No | Cumulative | -| edPacketsAccumu | | | count of | -| lated | | | discarded | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedDiscard | number | No | Count of | -| edPacketsDelta | | | discarded | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedErrorPa | number | No | Cumulative | -| cketsAccumulate | | | count of error | -| d | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedErrorPa | number | No | Count of error | -| cketsDelta | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedMultica | number | No | Cumulative | -| stPacketsAccumu | | | count of | -| lated | | | multicast | -| | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedMultica | number | No | Count of | -| stPacketsDelta | | | multicast | -| | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedOctetsA | number | No | Cumulative | -| ccumulated | | | count of octets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedOctetsD | number | No | Count of octets | -| elta | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedTotalPa | number | No | Cumulative | -| cketsAccumulate | | | count of all | -| d | | | packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedTotalPa | number | No | Count of all | -| cketsDelta | | | packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedUnicast | number | No | Cumulative | -| PacketsAccumula | | | count of | -| ted | | | unicast packets | -| | | | received as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| receivedUnicast | number | No | Count of | -| PacketsDelta | | | unicast packets | -| | | | received within | -| | | | the measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedBroa | number | No | Cumulative | -| dcastPacketsAcc | | | count of | -| umulated | | | broadcast | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedBroa | number | No | Count of | -| dcastPacketsDel | | | broadcast | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedDisc | number | No | Cumulative | -| ardedPacketsAcc | | | count of | -| umulated | | | discarded | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedDisc | number | No | Count of | -| ardedPacketsDel | | | discarded | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedErro | number | No | Cumulative | -| rPacketsAccumul | | | count of error | -| ated | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedErro | number | No | Count of error | -| rPacketsDelta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedMult | number | No | Cumulative | -| icastPacketsAcc | | | count of | -| umulated | | | multicast | -| | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedMult | number | No | Count of | -| icastPacketsDel | | | multicast | -| ta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedOcte | number | No | Cumulative | -| tsAccumulated | | | count of octets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedOcte | number | No | Count of octets | -| tsDelta | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedTota | number | No | Cumulative | -| lPacketsAccumul | | | count of all | -| ated | | | packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedTota | number | No | Count of all | -| lPacketsDelta | | | packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedUnic | number | No | Cumulative | -| astPacketsAccum | | | count of | -| ulated | | | unicast packets | -| | | | transmitted as | -| | | | read at the end | -| | | | of the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| transmittedUnic | number | No | Count of | -| astPacketsDelta | | | unicast packets | -| | | | transmitted | -| | | | within the | -| | | | measurement | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| valuesAreSuspec | string | Yes | Enumeration: | -| t | | | ‘true’ or | -| | | | ‘false’. If | -| | | | ‘true’ then the | -| | | | vNicPerformance | -| | | | values are | -| | | | likely | -| | | | inaccurate due | -| | | | to counter | -| | | | overflow or | -| | | | other | -| | | | condtions. | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: processorDimmAggregateThermalMargin -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The processorDimmAggregateThermalMargin datatype provides intelligent -platform management interface (ipmi) processor dual inline memory module -aggregate thermal margin metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| processorDimmAg | string | Yes | identifier for | -| gregateThermal | | | the aggregate | -| MarginIdentifie | | | thermal margin | -| r | | | metrics from | -| | | | the processor | -| | | | dual inline | -| | | | memory module | -+-----------------+-----------------+-----------------+-----------------+ -| thermalMargin | number | No | the difference | -| | | | between the | -| | | | DIMM's current | -| | | | temperature, in | -| | | | celsius, and | -| | | | the DIMM's | -| | | | throttling | -| | | | thermal trip | -| | | | point | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: processStats -^^^^^^^^^^^^^^^^^^^^^^ - -The processStats datatype provides metrics on system processes; it -consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| forkRate | number | No | The number of | -| | | | threads created | -| | | | since the last | -| | | | reboot | -+-----------------+-----------------+-----------------+-----------------+ -| processIdentifi | string | Yes | processIdentifi | -| er | | | er | -+-----------------+-----------------+-----------------+-----------------+ -| psStateBlocked | number | No | The number of | -| | | | processes in a | -| | | | blocked state | -+-----------------+-----------------+-----------------+-----------------+ -| psStatePaging | number | No | The number of | -| | | | processes in a | -| | | | paging state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateRunning | number | No | The number of | -| | | | processes in a | -| | | | running state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateSleeping | number | No | The number of | -| | | | processes in a | -| | | | sleeping state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateStopped | number | No | The number of | -| | | | processes in a | -| | | | stopped state | -+-----------------+-----------------+-----------------+-----------------+ -| psStateZombie | number | No | The number of | -| | | | processes in a | -| | | | zombie state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Notification’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: notificationFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The notificationFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | notification | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| arrayOfNamedHas | namedHashMap [ | No | Array of named | -| hMap | ] | | hashMaps | -+-----------------+-----------------+-----------------+-----------------+ -| changeContact | string | No | Identifier for | -| | | | a contact | -| | | | related to the | -| | | | change | -+-----------------+-----------------+-----------------+-----------------+ -| changeIdentifie | string | Yes | System or | -| r | | | session | -| | | | identifier | -| | | | associated with | -| | | | the change | -+-----------------+-----------------+-----------------+-----------------+ -| changeType | string | Yes | Describes what | -| | | | has changed for | -| | | | the entity, for | -| | | | example: | -| | | | configuration | -| | | | changed, | -| | | | capability | -| | | | added, | -| | | | capability | -| | | | removed… | -+-----------------+-----------------+-----------------+-----------------+ -| newState | string | No | New state of | -| | | | the entity, for | -| | | | example: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| notificationFie | number | Yes | Version of the | -| ldsVersion | | | notificaitionFi | -| | | | elds | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| oldState | string | No | Previous state | -| | | | of the entity, | -| | | | for example: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| stateInterface | string | No | Card or port | -| | | | name of the | -| | | | entity that | -| | | | changed state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Other’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: otherFields -^^^^^^^^^^^^^^^^^^^^^ - -The otherFields datatype defines fields for events belonging to the -'other' domain of the commonEventHeader domain enumeration; it consists -of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| arrayOfNamedHas | arrayOfNamedHas | No | Array of named | -| hMap | hMap | | hashMaps | -+-----------------+-----------------+-----------------+-----------------+ -| hashMap | hashMap | No | Array of | -| | | | name-value | -| | | | pairs | -+-----------------+-----------------+-----------------+-----------------+ -| jsonObjects | arrayOfJsonObje | No | Array of JSON | -| | ct | | objects | -| | | | described by | -| | | | name, schema | -| | | | and other | -| | | | meta-informatio | -| | | | n | -+-----------------+-----------------+-----------------+-----------------+ -| otherFieldsVers | number | Yes | Version of the | -| ion | | | otherFields | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ - -‘pnfRegistration’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: pnfRegistrationFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The pnfRegistrationFields datatype defines fields for events belonging -to the 'pnfRegistration' domain of the commonEventHeader domain -enumeration; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | pnfRegistration | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| lastServiceDate | string | No | TS 32.692 | -| | | | dateOfLastServi | -| | | | ce | -| | | | = date of last | -| | | | service; e.g. | -| | | | 15022017 | -+-----------------+-----------------+-----------------+-----------------+ -| macAddress | string | No | MAC address of | -| | | | OAM interface | -| | | | of the unit | -+-----------------+-----------------+-----------------+-----------------+ -| manufactureDate | string | No | TS 32.692 | -| | | | dateOfManufactu | -| | | | re | -| | | | = manufacture | -| | | | date of the | -| | | | unit; 24032016 | -+-----------------+-----------------+-----------------+-----------------+ -| modelNumber | string | No | TS 32.692 | -| | | | versionNumber = | -| | | | version of the | -| | | | unit from | -| | | | vendor; e.g. | -| | | | AJ02. Maps to | -| | | | AAI equip-model | -+-----------------+-----------------+-----------------+-----------------+ -| oamV4IpAddress | string | No | IPv4 m-plane IP | -| | | | address to be | -| | | | used by the | -| | | | manager to | -| | | | contact the PNF | -+-----------------+-----------------+-----------------+-----------------+ -| oamV6IpAddress | string | No | IPv6 m-plane IP | -| | | | address to be | -| | | | used by the | -| | | | manager to | -| | | | contact the PNF | -+-----------------+-----------------+-----------------+-----------------+ -| pnfRegistration | number | Yes | Version of the | -| FieldsVersion | | | registrationFie | -| | | | lds | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| serialNumber | string | No | TS 32.692 | -| | | | serialNumber = | -| | | | serial number | -| | | | of the unit; | -| | | | e.g. 6061ZW3 | -+-----------------+-----------------+-----------------+-----------------+ -| softwareVersion | string | No | TS 32.692 | -| | | | swName = active | -| | | | SW running on | -| | | | the unit; e.g. | -| | | | 5gDUv18.05.201 | -+-----------------+-----------------+-----------------+-----------------+ -| unitFamily | string | No | TS 32.692 | -| | | | vendorUnitFamil | -| | | | yType | -| | | | = general type | -| | | | of HW unit; | -| | | | e.g. BBU | -+-----------------+-----------------+-----------------+-----------------+ -| unitType | string | No | TS 32.692 | -| | | | vendorUnitTypeN | -| | | | umber | -| | | | = vendor name | -| | | | for the unit; | -| | | | e.g. Airscale | -+-----------------+-----------------+-----------------+-----------------+ -| vendorName | string | No | TS 32.692 | -| | | | vendorName = | -| | | | name of | -| | | | manufacturer; | -| | | | e.g. Nokia. | -| | | | Maps to AAI | -| | | | equip-vendor | -+-----------------+-----------------+-----------------+-----------------+ - - ‘State Change’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: stateChangeFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The stateChangeFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | stateChange | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| newState | string | Yes | New state of | -| | | | the entity: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| oldState | string | Yes | Previous state | -| | | | of the entity: | -| | | | ‘inService’, | -| | | | ‘maintenance’, | -| | | | ‘outOfService’ | -+-----------------+-----------------+-----------------+-----------------+ -| stateChangeFiel | number | Yes | Version of the | -| dsVersion | | | stateChangeFiel | -| | | | ds | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| stateInterface | string | Yes | Card or port | -| | | | name of the | -| | | | entity that | -| | | | changed state | -+-----------------+-----------------+-----------------+-----------------+ - -‘Syslog’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: syslogFields -^^^^^^^^^^^^^^^^^^^^^^ - -The syslogFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | string | No | Additional | -| s | | | syslog fields | -| | | | if needed, | -| | | | provided as | -| | | | name=value | -| | | | delimited by a | -| | | | pipe ‘|’ | -| | | | symbol, for | -| | | | example: | -| | | | “name1=value1|n | -| | | | ame2=value2|…” | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceHost | string | No | Hostname of the | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| eventSourceType | string | Yes | Examples: | -| | | | ‘other’, | -| | | | ‘router’, | -| | | | ‘switch’, | -| | | | ‘host’, ‘card’, | -| | | | ‘port’, | -| | | | ‘slotThreshold’ | -| | | | , | -| | | | ‘portThreshold’ | -| | | | , | -| | | | ‘virtualMachine | -| | | | ’, | -| | | | ‘virtualNetwork | -| | | | Function’ | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFacility | integer | No | Numeric code | -| | | | from 0 to 23 | -| | | | for facility: | -| | | | | -| | | | 0 kernel | -| | | | messages | -| | | | | -| | | | 1 user-level | -| | | | messages | -| | | | | -| | | | 2 mail system | -| | | | | -| | | | 3 system | -| | | | daemons | -| | | | | -| | | | 4 | -| | | | security/author | -| | | | ization | -| | | | messages | -| | | | | -| | | | 5 messages | -| | | | generated | -| | | | internally by | -| | | | syslogd | -| | | | | -| | | | 6 line printer | -| | | | subsystem | -| | | | | -| | | | 7 network news | -| | | | subsystem | -| | | | | -| | | | 8 UUCP | -| | | | subsystem | -| | | | | -| | | | 9 clock daemon | -| | | | | -| | | | 10 | -| | | | security/author | -| | | | ization | -| | | | messages | -| | | | | -| | | | 11 FTP daemon | -| | | | | -| | | | 12 NTP | -| | | | subsystem | -| | | | | -| | | | 13 log audit | -| | | | | -| | | | 14 log alert | -| | | | | -| | | | 15 clock daemon | -| | | | (note 2) | -| | | | | -| | | | 16 local use 0 | -| | | | (local0) | -| | | | | -| | | | 17 local use 1 | -| | | | (local1) | -| | | | | -| | | | 18 local use 2 | -| | | | (local2) | -| | | | | -| | | | 19 local use 3 | -| | | | (local3) | -| | | | | -| | | | 20 local use 4 | -| | | | (local4) | -| | | | | -| | | | 21 local use 5 | -| | | | (local5) | -| | | | | -| | | | 22 local use 6 | -| | | | (local6) | -| | | | | -| | | | 23 local use 7 | -| | | | (local7 ) | -+-----------------+-----------------+-----------------+-----------------+ -| syslogFieldsVer | number | Yes | Version of the | -| sion | | | syslogFields | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| syslogMsg | string | Yes | Syslog message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogMsgHost | string | No | Hostname parsed | -| | | | from non-VES | -| | | | syslog message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogPri | integer | No | 0-192 | -| | | | | -| | | | Combined | -| | | | Severity and | -| | | | Facility (see | -| | | | rfc5424( | -+-----------------+-----------------+-----------------+-----------------+ -| syslogProc | string | No | Identifies the | -| | | | application | -| | | | that originated | -| | | | the message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogProcId | number | No | The process | -| | | | number assigned | -| | | | by the OS when | -| | | | the application | -| | | | was started | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSData | string | No | Syslog | -| | | | structured data | -| | | | consisting of a | -| | | | structured data | -| | | | Id followed by | -| | | | a set of key | -| | | | value pairs | -| | | | (see below for | -| | | | an example) | -| | | | | -| | | | \**Note: SD-ID | -| | | | may not be | -| | | | present if | -| | | | syslogSdId is | -| | | | populated | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSdId | string | No | 0-32 char in | -| | | | format | -| | | | name@number, | -| | | | | -| | | | i.e., | -| | | | ourSDID@32473 | -+-----------------+-----------------+-----------------+-----------------+ -| syslogSev | string | No | Level-of-severi | -| | | | ty | -| | | | text | -| | | | enumeration | -| | | | defined below: | -| | | | | -| | | | Text Sev | -| | | | Description | -| | | | | -| | | | Emergency 0 | -| | | | system is | -| | | | unusable | -| | | | | -| | | | Alert 1 action | -| | | | must be taken | -| | | | immediately | -| | | | | -| | | | Critical 2 | -| | | | critical | -| | | | conditions | -| | | | | -| | | | Error 3 error | -| | | | conditions | -| | | | | -| | | | Warning 4 | -| | | | warning | -| | | | conditions | -| | | | | -| | | | Notice 5 normal | -| | | | but significant | -| | | | condition | -| | | | | -| | | | Info 6 | -| | | | Informational | -| | | | messages | -| | | | | -| | | | Debug 7 | -| | | | debug-level | -| | | | messages | -+-----------------+-----------------+-----------------+-----------------+ -| syslogTag | string | Yes | Also known as | -| | | | MsgId. Brief | -| | | | non-spaced text | -| | | | indicating the | -| | | | type of message | -| | | | such as | -| | | | ‘TCPOUT’ or | -| | | | ‘BGP_STATUS_CHA | -| | | | NGE’; | -| | | | ‘NILVALUE’ | -| | | | should be used | -| | | | when no other | -| | | | value can be | -| | | | provided | -+-----------------+-----------------+-----------------+-----------------+ -| syslogTs | string | No | Timestamp | -| | | | parsed from | -| | | | non-VES syslog | -| | | | message | -+-----------------+-----------------+-----------------+-----------------+ -| syslogVer | number | No | IANA assigned | -| | | | version of the | -| | | | syslog protocol | -| | | | specification: | -| | | | | -| | | | 0: VES | -| | | | | -| | | | 1: IANA RFC5424 | -+-----------------+-----------------+-----------------+-----------------+ - -Examples of syslogSData (with syslogVer=1): - - syslogSData = NILVALUE / 1*SD-ELEMENT - - SD-ELEMENT = SD-PARAM \*(sp SD-PARAM) - - SD-PARAM = PARAM-NAME "=" %d34 PARAM-VALUE %d34 - - SD-ID = SD-NAME - - PARAM-NAME = SD-NAME - - PARAM-VALUE = UTF-8-STRING ; characters '"', '\' and ']' MUST be - escaped. - - SD-NAME = 1*32PRINTUSASCII , except '=', SP, ']', %d34 (") - - Example: key1=”value1” key2=”value2” - -NOTE: To support older implementations, syslogSData may be prefixed with -the SD-ID, but to indicate this, the entire contents must be within -square bracket delimiters “[ ]” to follow RFC5424 syntax. Example: - - [attinc@1234 key1=”value1” key2=”value2”] - -syslogSData (with syslogVer=0): - - STRUCTURED-DATA = NILVALUE / 1*SD-ELEMENT - - SD-ELEMENT = SD-PARAM \*(“|”SD-PARAM) - - SD-PARAM = PARAM-NAME "=" PARAM-VALUE - - PARAM-NAME = SD-NAME - - PARAM-VALUE = UTF-8-STRING ; characters '"', '\' and '|' MUST be - escaped. - - SD-NAME = 1*32PRINTUSASCII, except '=', SP, ']', %d34 ("), ‘|’, ‘,’ - - Example: key1=value1|key2=value2 - -Syslog references: - -https://tools.ietf.org/html/rfc5424#section-6 - - https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml - - ‘Threshold Crossing Alert’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: counter -^^^^^^^^^^^^^^^^^ - -The counter datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| criticality | string | Yes | Enumeration: | -| | | | ‘CRIT’, ‘MAJ’ | -+-----------------+-----------------+-----------------+-----------------+ -| hashMap | hashMap | Yes | Key is the name | -| | | | of the counter | -| | | | and value is | -| | | | the current | -| | | | value of the | -| | | | counter | -+-----------------+-----------------+-----------------+-----------------+ -| threshholdCross | string | Yes | Last threshold | -| ed | | | that was | -| | | | crossed | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: thresholdCrossingAlertFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The thresholdCrossingAlertFields datatype consists of the following -fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | threshold | -| | | | crossing alert | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| additionalParam | counter [ ] | Yes | Array of | -| eters | | | performance | -| | | | counters | -+-----------------+-----------------+-----------------+-----------------+ -| alertAction | string | Yes | Enumeration: | -| | | | ‘SET’, ‘CONT’, | -| | | | ‘CLEAR’ | -+-----------------+-----------------+-----------------+-----------------+ -| alertDescriptio | string | Yes | Unique short | -| n | | | alert | -| | | | description | -| | | | (e.g., | -| | | | NE-CPUMEM) | -+-----------------+-----------------+-----------------+-----------------+ -| alertType | string | Yes | Enumeration: | -| | | | ‘CARD-ANOMALY’, | -| | | | ‘INTERFACE-ANOM | -| | | | ALY’, | -| | | | ELEMENT-ANOMALY | -| | | | ’, | -| | | | ‘SERVICE-ANOMAL | -| | | | Y’ | -+-----------------+-----------------+-----------------+-----------------+ -| alertValue | string | No | Calculated API | -| | | | value (if | -| | | | applicable) | -+-----------------+-----------------+-----------------+-----------------+ -| associatedAlert | string [ ] | No | List of | -| IdList | | | eventIds | -| | | | associated with | -| | | | the event being | -| | | | reported | -+-----------------+-----------------+-----------------+-----------------+ -| collectionTimes | string | Yes | Time when the | -| tamp | | | performance | -| | | | collector | -| | | | picked up the | -| | | | data; with RFC | -| | | | 2822 compliant | -| | | | format: ‘Sat, | -| | | | 13 Mar 2010 | -| | | | 11:29:05 -0800’ | -+-----------------+-----------------+-----------------+-----------------+ -| dataCollector | string | No | Specific | -| | | | performance | -| | | | collector | -| | | | instance used | -+-----------------+-----------------+-----------------+-----------------+ -| elementType | string | No | Type of network | -| | | | element | -| | | | (internal AT&T | -| | | | field) | -+-----------------+-----------------+-----------------+-----------------+ -| eventSeverity | string | Yes | Event severity | -| | | | or priority | -| | | | enumeration: | -| | | | ‘CRITICAL’, | -| | | | ‘MAJOR’, | -| | | | ‘MINOR’, | -| | | | ‘WARNING’, | -| | | | ‘NORMAL’ | -+-----------------+-----------------+-----------------+-----------------+ -| eventStartTimes | string | Yes | Time closest to | -| tamp | | | when the | -| | | | measurement was | -| | | | made; with RFC | -| | | | 2822 compliant | -| | | | format: ‘Sat, | -| | | | 13 Mar 2010 | -| | | | 11:29:05 -0800’ | -+-----------------+-----------------+-----------------+-----------------+ -| interfaceName | string | No | Physical or | -| | | | logical port or | -| | | | card (if | -| | | | applicable) | -+-----------------+-----------------+-----------------+-----------------+ -| networkService | string | No | Network name | -| | | | (internal AT&T | -| | | | field) | -+-----------------+-----------------+-----------------+-----------------+ -| possibleRootCau | string | No | Reserved for | -| se | | | future use | -+-----------------+-----------------+-----------------+-----------------+ -| thresholdCrossi | number | Yes | Version of the | -| ng | | | thresholdCrossi | -| FieldsVersion | | | ngAlertFields | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ - -Technology Specific Datatypes ------------------------------ - - ‘Mobile Flow’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: gtpPerFlowMetrics -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The gtpPerFlowMetrics datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| avgBitErrorRate | number | Yes | Average bit | -| | | | error rate | -+-----------------+-----------------+-----------------+-----------------+ -| avgPacketDelayV | number | Yes | Average packet | -| ariation | | | delay variation | -| | | | or jitter in | -| | | | milliseconds | -| | | | for received | -| | | | packets: | -| | | | Average | -| | | | difference | -| | | | between the | -| | | | packet | -| | | | timestamp and | -| | | | time received | -| | | | for all pairs | -| | | | of consecutive | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| avgPacketLatenc | number | Yes | Average | -| y | | | delivery | -| | | | latency | -+-----------------+-----------------+-----------------+-----------------+ -| avgReceiveThrou | number | Yes | Average receive | -| ghput | | | throughput | -+-----------------+-----------------+-----------------+-----------------+ -| avgTransmitThro | number | Yes | Average | -| ughput | | | transmit | -| | | | throughput | -+-----------------+-----------------+-----------------+-----------------+ -| durConnectionFa | number | No | Duration of | -| iledStatus | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| durTunnelFailed | number | No | Duration of | -| Status | | | errored state, | -| | | | computed as the | -| | | | cumulative time | -| | | | between a | -| | | | tunnel error | -| | | | indicator and | -| | | | the next | -| | | | following | -| | | | non-errored | -| | | | indicator, over | -| | | | this reporting | -| | | | interval | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivatedBy | string | No | Endpoint | -| | | | activating the | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationE | number | Yes | Time the | -| poch | | | connection is | -| | | | activated in | -| | | | the flow | -| | | | (connection) | -| | | | being reported | -| | | | on, or | -| | | | transmission | -| | | | time of the | -| | | | first packet if | -| | | | activation time | -| | | | is not | -| | | | available | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationM | number | Yes | Integer | -| icrosec | | | microseconds | -| | | | for the start | -| | | | of the flow | -| | | | connection | -+-----------------+-----------------+-----------------+-----------------+ -| flowActivationT | string | No | Time the | -| ime | | | 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’ | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivated | string | No | Endpoint | -| By | | | deactivating | -| | | | the flow | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | number | Yes | Time for the | -| nEpoch | | | start of the | -| | | | flow | -| | | | connection, in | -| | | | integer UTC | -| | | | epoch time aka | -| | | | UNIX time | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | number | Yes | Integer | -| nMicrosec | | | microseconds | -| | | | for the start | -| | | | of the flow | -| | | | connection | -+-----------------+-----------------+-----------------+-----------------+ -| flowDeactivatio | string | Yes | Transmission | -| nTime | | | 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’ | -+-----------------+-----------------+-----------------+-----------------+ -| flowStatus | string | Yes | Connection | -| | | | status at | -| | | | reporting time | -| | | | as a working / | -| | | | inactive / | -| | | | failed | -| | | | indicator value | -+-----------------+-----------------+-----------------+-----------------+ -| gtpConnectionSt | string | No | Current | -| atus | | | connection | -| | | | state at | -| | | | reporting time | -+-----------------+-----------------+-----------------+-----------------+ -| gtpTunnelStatus | string | No | Current tunnel | -| | | | state at | -| | | | reporting time | -+-----------------+-----------------+-----------------+-----------------+ -| ipTosCountList | hashMap | No | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| ipTosList | string | No | Array of unique | -| | | | IP | -| | | | Type-of-Service | -| | | | values observed | -| | | | in the flow | -| | | | where values | -| | | | range from '0' | -| | | | to '255' | -+-----------------+-----------------+-----------------+-----------------+ -| largePacketRtt | number | No | large packet | -| | | | round trip time | -+-----------------+-----------------+-----------------+-----------------+ -| largePacketThre | number | No | large packet | -| shold | | | threshold being | -| | | | applied | -+-----------------+-----------------+-----------------+-----------------+ -| maxPacketDelayV | number | Yes | Maximum packet | -| ariation | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| maxReceiveBitRa | number | No | maximum receive | -| te | | | bit rate" | -+-----------------+-----------------+-----------------+-----------------+ -| maxTransmitBitR | number | No | maximum | -| ate | | | transmit bit | -| | | | rate | -+-----------------+-----------------+-----------------+-----------------+ -| mobileQciCosCou | hashMap | No | array of key: | -| ntList | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| mobileQciCosLis | string | No | Array of unique | -| t | | | LTE QCI or UMTS | -| | | | class-of-servic | -| | | | e | -| | | | values observed | -| | | | in the flow | -+-----------------+-----------------+-----------------+-----------------+ -| numActivationFa | number | Yes | Number of | -| ilures | | | failed | -| | | | activation | -| | | | requests, as | -| | | | observed by the | -| | | | reporting node | -+-----------------+-----------------+-----------------+-----------------+ -| numBitErrors | number | Yes | number of | -| | | | errored bits | -+-----------------+-----------------+-----------------+-----------------+ -| numBytesReceive | number | Yes | number of bytes | -| d | | | received, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numBytesTransmi | number | Yes | number of bytes | -| tted | | | transmitted, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numDroppedPacke | number | Yes | number of | -| ts | | | received | -| | | | packets dropped | -| | | | due to errors | -| | | | per virtual | -| | | | interface | -+-----------------+-----------------+-----------------+-----------------+ -| numGtpEchoFailu | number | No | Number of Echo | -| res | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| numGtpTunnelErr | number | No | Number of | -| ors | | | tunnel error | -| | | | indications | -| | | | where errors | -| | | | are defined in | -| | | | 3GPP TS 29.281 | -| | | | sec 7.3.1 and | -| | | | 3GPP TS 29.060 | -| | | | sec. 11.1 | -+-----------------+-----------------+-----------------+-----------------+ -| numHttpErrors | number | No | Http error | -| | | | count | -+-----------------+-----------------+-----------------+-----------------+ -| numL7BytesRecei | number | Yes | number of | -| ved | | | tunneled layer | -| | | | 7 bytes | -| | | | received, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numL7BytesTrans | number | Yes | number of | -| mitted | | | tunneled layer | -| | | | 7 bytes | -| | | | transmitted, | -| | | | excluding | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numLostPackets | number | Yes | number of lost | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| numOutOfOrderPa | number | Yes | number of | -| ckets | | | out-of-order | -| | | | packets | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketErrors | number | Yes | number of | -| | | | errored packets | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsRecei | number | Yes | number of | -| vedExclRetrans | | | packets | -| | | | received, | -| | | | excluding | -| | | | retransmission | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsRecei | number | Yes | number of | -| vedInclRetrans | | | packets | -| | | | received, | -| | | | including | -| | | | retransmission | -+-----------------+-----------------+-----------------+-----------------+ -| numPacketsTrans | number | Yes | number of | -| mittedInclRetra | | | packets | -| ns | | | transmitted, | -| | | | including | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| numRetries | number | Yes | number of | -| | | | packet retrie | -+-----------------+-----------------+-----------------+-----------------+ -| numTimeouts | number | Yes | number of | -| | | | packet timeouts | -+-----------------+-----------------+-----------------+-----------------+ -| numTunneledL7By | number | Yes | number of | -| tesReceived | | | tunneled layer | -| | | | 7 bytes | -| | | | received, | -| | | | excluding | -| | | | retransmissions | -+-----------------+-----------------+-----------------+-----------------+ -| roundTripTime | number | Yes | Round Trip time | -+-----------------+-----------------+-----------------+-----------------+ -| tcpFlagCountLis | hashMap | No | Array of key: | -| t | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| tcpFlagList | string | No | Array of unique | -| | | | TCP Flags | -| | | | observed in the | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ -| timeToFirstByte | number | Yes | Time in | -| | | | milliseconds | -| | | | between the | -| | | | connection | -| | | | activation and | -| | | | first byte | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: mobileFlowFields -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The mobileFlowFields datatype consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalField | hashMap | No | Additional | -| s | | | mobileFlow | -| | | | fields if | -| | | | needed | -+-----------------+-----------------+-----------------+-----------------+ -| applicationType | string | No | Application | -| | | | type inferred | -+-----------------+-----------------+-----------------+-----------------+ -| appProtocolType | string | No | Application | -| | | | protocol | -+-----------------+-----------------+-----------------+-----------------+ -| appProtocolVers | string | No | Application | -| ion | | | version | -+-----------------+-----------------+-----------------+-----------------+ -| cid | string | No | Cell Id | -+-----------------+-----------------+-----------------+-----------------+ -| connectionType | string | No | Abbreviation | -| | | | referencing a | -| | | | 3GPP reference | -| | | | point e.g., | -| | | | S1-U, S11, etc | -+-----------------+-----------------+-----------------+-----------------+ -| ecgi | string | No | Evolved Cell | -| | | | Global Id | -+-----------------+-----------------+-----------------+-----------------+ -| flowDirection | string | Yes | Flow direction, | -| | | | indicating if | -| | | | the reporting | -| | | | node is the | -| | | | source of the | -| | | | flow or | -| | | | destination for | -| | | | the flow | -+-----------------+-----------------+-----------------+-----------------+ -| gtpPerFlowMetri | gtpPer | Yes | Mobility GTP | -| cs | FlowMetrics | | Protocol per | -| | | | flow metrics | -+-----------------+-----------------+-----------------+-----------------+ -| gtpProtocolType | string | No | GTP protocol | -+-----------------+-----------------+-----------------+-----------------+ -| gtpVersion | string | No | GTP protocol | -| | | | version | -+-----------------+-----------------+-----------------+-----------------+ -| httpHeader | string | No | HTTP request | -| | | | header, if the | -| | | | flow connects | -| | | | to a node | -| | | | referenced by | -| | | | HTTP | -+-----------------+-----------------+-----------------+-----------------+ -| imei | string | No | IMEI for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| imsi | string | No | IMSI for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| ipProtocolType | string | Yes | IP protocol | -| | | | type e.g., TCP, | -| | | | UDP, RTP... | -+-----------------+-----------------+-----------------+-----------------+ -| ipVersion | string | Yes | IP protocol | -| | | | version e.g., | -| | | | IPv4, IPv6 | -+-----------------+-----------------+-----------------+-----------------+ -| lac | string | No | Location area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mcc | string | No | Mobile country | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mnc | string | No | Mobile network | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| mobileFlowField | number | Yes | Version of the | -| sVersion | | | mobileFlowField | -| | | | s | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| msisdn | string | No | MSISDN for the | -| | | | subscriber UE | -| | | | used in this | -| | | | flow, as an | -| | | | integer, if the | -| | | | flow connects | -| | | | to a mobile | -| | | | device | -+-----------------+-----------------+-----------------+-----------------+ -| otherEndpointIp | string | Yes | IP address for | -| Address | | | the other | -| | | | endpoint, as | -| | | | used for the | -| | | | flow being | -| | | | reported on | -+-----------------+-----------------+-----------------+-----------------+ -| otherEndpointPo | integer | Yes | IP Port for the | -| rt | | | reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| otherFunctional | string | No | Functional role | -| Role | | | of the other | -| | | | endpoint for | -| | | | the flow being | -| | | | reported on | -| | | | e.g., MME, | -| | | | S-GW, P-GW, | -| | | | PCRF... | -+-----------------+-----------------+-----------------+-----------------+ -| rac | string | No | Routing area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| radioAccessTech | string | No | Radio Access | -| nology | | | Technology | -| | | | e.g., 2G, 3G, | -| | | | LTE | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEndpoi | string | Yes | IP address for | -| ntIpAddr | | | the reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| reportingEndpoi | integer | Yes | IP port for the | -| ntPort | | | reporting | -| | | | entity, as used | -| | | | for the flow | -| | | | being reported | -| | | | on | -+-----------------+-----------------+-----------------+-----------------+ -| sac | string | No | Service area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| samplingAlgorit | integer | No | Integer | -| hm | | | 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 | -+-----------------+-----------------+-----------------+-----------------+ -| tac | string | No | Transport area | -| | | | code | -+-----------------+-----------------+-----------------+-----------------+ -| tunnelId | string | No | Tunnel | -| | | | identifier | -+-----------------+-----------------+-----------------+-----------------+ -| vlanId | string | No | VLAN identifier | -| | | | used by this | -| | | | flow | -+-----------------+-----------------+-----------------+-----------------+ - - ‘SipSignaling’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: sipSignalingFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The sipSignalingFields datatype communicates information about sip -signaling messages, parameters and signaling state; it consists of the -following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalInfor | hashMap | No | Additional | -| mation | | | sipSignaling | -| | | | fields | -+-----------------+-----------------+-----------------+-----------------+ -| compressedSip | string | No | The full SIP | -| | | | request/respons | -| | | | e | -| | | | including | -| | | | headers and | -| | | | bodies | -+-----------------+-----------------+-----------------+-----------------+ -| correlator | string | Yes | Constant across | -| | | | all events on | -| | | | this call | -+-----------------+-----------------+-----------------+-----------------+ -| localIpAddress | string | Yes | Ip address on | -| | | | xNF | -+-----------------+-----------------+-----------------+-----------------+ -| localPort | string | Yes | Port on xNF | -+-----------------+-----------------+-----------------+-----------------+ -| remoteIpAddress | string | Yes | IP address of | -| | | | peer endpoint | -+-----------------+-----------------+-----------------+-----------------+ -| remotePort | string | Yes | Port of peer | -| | | | endpoint | -+-----------------+-----------------+-----------------+-----------------+ -| sipSignalingFie | number | Yes | Version of the | -| ldsVersion | | | sipSignalingFie | -| | | | lds | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ -| summarySip | string | No | The SIP Method | -| | | | or Response | -| | | | (‘INVITE’, ‘200 | -| | | | OK’, ‘BYE’, | -| | | | etc) | -+-----------------+-----------------+-----------------+-----------------+ -| vendorNfNameFie | vendorNfNameFie | Yes | Vendor, NF and | -| lds | lds | | nfModule names | -+-----------------+-----------------+-----------------+-----------------+ - - ‘Voice Quality’ Domain Datatypes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Datatype: endOfCallVqmSummaries -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The endOfCallVqmSummaries datatype provides end of call voice quality -metrics; it consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| adjacencyName | string | Yes | Adjacency name | -+-----------------+-----------------+-----------------+-----------------+ -| endpointAverage | number | No | Endpoint | -| Jitter | | | average jitter | -+-----------------+-----------------+-----------------+-----------------+ -| endpointDescrip | string | Yes | Enumeration: | -| tion | | | ‘Caller’, | -| | | | ‘Callee’ | -+-----------------+-----------------+-----------------+-----------------+ -| endpointMaxJitt | number | No | Endpoint | -| er | | | maximum jitter | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsDiscarded | | | octets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsLost | | | octets lost | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsReceived | | | octets received | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpOcte | number | No | Endpoint RTP | -| tsSent | | | octets sent | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsDiscarded | | | packets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsLost | | | packets lost | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsReceived | | | packets | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ -| endpointRtpPack | number | No | Endpoint RTP | -| etsSent | | | packets sent | -+-----------------+-----------------+-----------------+-----------------+ -| localAverageJit | number | No | Local average | -| ter | | | jitter | -+-----------------+-----------------+-----------------+-----------------+ -| localAverageJit | number | No | Local average | -| terBufferDelay | | | jitter buffer | -| | | | delay | -+-----------------+-----------------+-----------------+-----------------+ -| localMaxJitter | number | No | Local maximum | -| | | | jitter | -+-----------------+-----------------+-----------------+-----------------+ -| localMaxJitterB | number | No | Local max | -| ufferDelay | | | jitter buffer | -| | | | delay | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsD | number | No | Local RTP | -| iscarded | | | octets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsL | number | No | Local RTP | -| ost | | | octets lost | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsR | number | No | Local RTP | -| eceived | | | octets received | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpOctetsS | number | No | Local RTP | -| ent | | | octets sent | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Discarded | | | packets | -| | | | discarded | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Lost | | | packets lost | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Received | | | packets | -| | | | received | -+-----------------+-----------------+-----------------+-----------------+ -| localRtpPackets | number | No | Local RTP | -| Sent | | | packets sent | -+-----------------+-----------------+-----------------+-----------------+ -| mosCqe | number | No | Decimal range | -| | | | from 1 to 5 (1 | -| | | | decimal place) | -+-----------------+-----------------+-----------------+-----------------+ -| oneWayDelay | number | No | one-way path | -| | | | delay in | -| | | | milliseconds | -+-----------------+-----------------+-----------------+-----------------+ -| packetLossPerce | number | No | Calculated | -| nt | | | percentage | -| | | | packet loss | -| | | | based on | -| | | | endpoint RTP | -| | | | packets lost | -| | | | (as reported in | -| | | | RTCP) and local | -| | | | RTP packets | -| | | | sent. Direction | -| | | | is based on | -| | | | endpoint | -| | | | description | -| | | | (Caller, | -| | | | Callee). | -| | | | Decimal (2 | -| | | | decimal places) | -+-----------------+-----------------+-----------------+-----------------+ -| rFactor | number | No | rFactor from 0 | -| | | | to 100 | -+-----------------+-----------------+-----------------+-----------------+ -| roundTripDelay | number | No | Round trip | -| | | | delay in | -| | | | milliseconds | -+-----------------+-----------------+-----------------+-----------------+ - -Datatype: voiceQualityFields -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The voiceQualityFields datatype provides statistics related to customer -facing voice products; consists of the following fields: - -+-----------------+-----------------+-----------------+-----------------+ -| Field | Type | Required? | Description | -+=================+=================+=================+=================+ -| additionalInfor | hashMap | No | Additional | -| mation | | | voice quality | -| | | | fields | -+-----------------+-----------------+-----------------+-----------------+ -| calleeSideCodec | string | Yes | Callee codec | -| | | | for the call | -+-----------------+-----------------+-----------------+-----------------+ -| callerSideCodec | string | Yes | Caller codec | -| | | | for the call | -+-----------------+-----------------+-----------------+-----------------+ -| correlator | string | Yes | Constant across | -| | | | all events on | -| | | | this call | -+-----------------+-----------------+-----------------+-----------------+ -| endOfCallVqmSum | endOfCallVqm | No | End of call | -| maries | Summaries | | voice quality | -| | | | metric | -| | | | summaries | -+-----------------+-----------------+-----------------+-----------------+ -| phoneNumber | string | No | Phone number | -| | | | associated with | -| | | | the correlator | -+-----------------+-----------------+-----------------+-----------------+ -| midCallRtcp | string | Yes | Base64 encoding | -| | | | of the binary | -| | | | RTCP data | -| | | | (excluding | -| | | | Eth/IP/UDP | -| | | | headers) | -+-----------------+-----------------+-----------------+-----------------+ -| vendorNfNameFie | vendorNfNameFie | Yes | Vendor, NF and | -| lds | lds | | nfModule names | -+-----------------+-----------------+-----------------+-----------------+ -| voiceQualityFie | number | Yes | Version of the | -| ldsVersion | | | voiceQualityFie | -| | | | lds | -| | | | block | -+-----------------+-----------------+-----------------+-----------------+ - -Exceptions -========== - -RESTful Web Services Exceptions -------------------------------- - -RESTful services generate and send exceptions to clients in response to -invocation errors. Exceptions send HTTP status codes (specified later in -this document for each operation). HTTP status codes may be followed by -an optional JSON exception structure described below. Two types of -exceptions may be defined: service exceptions and policy exceptions. - -+-----------------+-----------------+-----------------+-----------------+ -| **Field Name** | **Data Type** | **Required?** | **Description** | -+=================+=================+=================+=================+ -| messageId | xs:string | Yes | Unique message | -| | | | identifier of | -| | | | the format | -| | | | ‘ABCnnnn’ where | -| | | | ‘ABC’ is either | -| | | | ‘SVC’ for | -| | | | Service | -| | | | Exceptions or | -| | | | ‘POL’ for | -| | | | Policy | -| | | | Exception. | -| | | | | -| | | | Exception | -| | | | numbers may be | -| | | | in the range of | -| | | | 0001 to 9999 | -| | | | where : | -| | | | | -| | | | - 0001 to 2999 | -| | | | are defined | -| | | | by OMA (see | -| | | | OMA’s | -| | | | `Common | -| | | | definitions | -| | | | for RESTful | -| | | | Network | -| | | | APIs <http:/ | -| | | | /technical.open | -| | | | mobilealliance. | -| | | | org/Technical/r | -| | | | elease_program/ | -| | | | docs/REST_NetAP | -| | | | I_Common/V1_0-2 | -| | | | 0120417-C/OMA-T | -| | | | S-REST_NetAPI_C | -| | | | ommon-V1_0-2012 | -| | | | 0417-C.pdf>`__ | -| | | | for details) | -| | | | | -| | | | - 3000-9999 | -| | | | are | -| | | | available | -| | | | and | -| | | | undefined | -+-----------------+-----------------+-----------------+-----------------+ -| text | xs:string | Yes | Message text, | -| | | | with | -| | | | replacement | -| | | | variables | -| | | | marked with %n, | -| | | | where n is an | -| | | | index into the | -| | | | list of | -| | | | <variables> | -| | | | elements, | -| | | | starting at 1 | -+-----------------+-----------------+-----------------+-----------------+ -| variables | xs:string | No | List of zero or | -| | [0..unbounded] | | more strings | -| | | | that represent | -| | | | the contents of | -| | | | the variables | -| | | | used by the | -| | | | message text. | -+-----------------+-----------------+-----------------+-----------------+ -| url | xs:anyUrl | No | Hyperlink to a | -| | | | detailed error | -| | | | resource (e.g., | -| | | | an HTML page | -| | | | for browser | -| | | | user agents). | -+-----------------+-----------------+-----------------+-----------------+ - -Service Exceptions ------------------- - -When a service is not able to process a request, and retrying the -request with the same information will also result in a failure, and the -issue is not related to a service policy issue, then the service will -issue a fault using the service exception fault message. Examples of -service exceptions include invalid input, lack of availability of a -required resource or a processing error. - -A service exception uses the letters 'SVC' at the beginning of the -message identifier. ‘SVC’ service exceptions used by the VES Event -Listener API are defined below. - -+-------------+-------------+-------------+-------------+-------------+ -| *MessageId* | *Descriptio | *Text* | *Variables* | *Parent | -| | n | | | HTTP Code* | -| | / Comment* | | | | -+=============+=============+=============+=============+=============+ -| SVC0001 | General | <custom | None | 400 | -| | service | error | | | -| | error (see | message> | | | -| | SVC2000) | | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC0002 | Bad | Invalid | %1: message | 400 | -| | parameter | input value | part | | -| | | for message | | | -| | | part %1 | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC1000 | No server | No server | None | 500 | -| | resources | resources | | | -| | | available | | | -| | | to process | | | -| | | the request | | | -+-------------+-------------+-------------+-------------+-------------+ -| SVC2000 | More | The | %1: human | 400 | -| | elaborate | following | readable | | -| | version of | service | description | | -| | SVC0001 | error | of the | | -| | | occurred: | error | | -| | | %1. Error | | | -| | | code is %2. | %2: error | | -| | | | code | | -+-------------+-------------+-------------+-------------+-------------+ - -.. - - Table - Service Exceptions - -Policy Exceptions ------------------ - -When a service is not able to complete because the request fails to meet -a policy criteria, then the service will issue a fault using the policy -exception fault message. To clarify how a policy exception differs from -a service exception, consider that all the input to an operation may be -valid as meeting the required input for the operation (thus no service -exception), but using that input in the execution of the service may -result in conditions that require the service not to complete. Examples -of policy exceptions include privacy violations, requests not permitted -under a governing service agreement or input content not acceptable to -the service provider. - -A Policy Exception uses the letters 'POL' at the beginning of the -message identifier. ‘POL’ policy exceptions used by the VES Event -Listener API are defined below. - -+-------------+-------------+-------------+-------------+-------------+ -| *MessageId* | *Descriptio | *Text* | *Variables* | *Parent | -| | n | | | HTTP Code* | -| | / Comment* | | | | -+=============+=============+=============+=============+=============+ -| POL0001 | General | A policy | None | 401 | -| | policy | error | | | -| | error (see | occurred. | | | -| | POL2000) | | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL1009 | User not | User has | None | 401 | -| | provisioned | not been | | | -| | for service | provisioned | | | -| | | for service | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL1010 | User | User has | None | 401 | -| | suspended | been | | | -| | from | suspended | | | -| | service | from | | | -| | | service | | | -+-------------+-------------+-------------+-------------+-------------+ -| POL2000 | More | The | %1: human | 401 | -| | elaborate | following | readable | | -| | version of | policy | description | | -| | POL0001 | error | of the | | -| | | occurred: | error | | -| | | %1. Error | | | -| | | code is %2. | %2: error | | -| | | | code | | -+-------------+-------------+-------------+-------------+-------------+ -| POL9003 | Message | Message | None | 400 | -| | size | content | | | -| | exceeds | size | | | -| | limit | exceeds the | | | -| | | allowable | | | -| | | limit | | | -+-------------+-------------+-------------+-------------+-------------+ - -.. - - Table - Policy Exceptions - -RESTful Web Services Definition -=============================== - -REST Operation Overview ------------------------ - -REST Operation Summary -~~~~~~~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| **Operation Action** | **HTTP** | **Resource URL | -| | | relative to | -| | **Verb** | {ServerRoot}, which | -| | | is defined in | -| | | section** **3** | -+-----------------------+-----------------------+-----------------------+ -| publishAnyEvent | POST | /eventListener/v{apiV | -| | | ersion} | -+-----------------------+-----------------------+-----------------------+ -| publishEventBatch | POST | /eventListener/v{apiV | -| | | ersion}/eventBatch | -+-----------------------+-----------------------+-----------------------+ - -Table - REST Operation Summary - -Api Versioning -~~~~~~~~~~~~~~ - -apiVersion is used to describe the major version number of the event -listener API (which is the same as the major version number of this -specification). When this number changes, the implication is: the new -major version will break clients of older major versions in some way, if -they try to use the new API without modification (e.g., unmodified v1 -clients would not be able to use v2 without error). - -The Event Listener shall provide the following HTTP headers in response -to all requests. Additionally, clients may populate these headers on -requests to indicate the specific version they are interested in. - -- X-MinorVersion: 0 - -- X-PatchVersion: 0 - -- X-LatestVersion: 6.0.0 - -If a client requests major version 5 (per the REST resource URL) and -does not specify the above headers, then they will be provided with the -latest patch version of 5.0.x. If the client wants a particular minor -version of major version 5, then they need to supply the X-MinorVersion -header with their request. For example, if they request major version 5 -with X-MinorVersion: 4, they will get the latest patch version of 5.4, -which is 5.4.1 - -Buffering of Events -~~~~~~~~~~~~~~~~~~~~ - -{ServerRoot} is defined in section 3 of this document, which defines the -REST resource URL. One or more FQDNs may be provisioned in an event -source when it is instantiated or updated. If an event source is unable -to reach any of the provisioned FQDNs, it should buffer the event data -specified below, up to a maximum of 1 hour, until a connection can be -established and the events can be successfully delivered to the VES -Event Listener service. - -During such an outage, only the following events should be buffered: - -- Faults with eventSeverity of “MINOR”, “MAJOR” or “CRITICAL” - -- Syslogs with syslogSev of 0-5 - -- All measurement events - -xNFs acting as event sources should not send syslog events to the VES -Event Listener during debug mode (which is controlled via the Netconf -management interface), but should store syslog events locally for -access, and possible FTP transfer, via the xNF console (e.g., command -line interface). - -If the internal event source event buffer or local storage should -overflow, then the event source should send a Fault event, and should -discard events in a first-in, first-out (FIFO) manner (i.e., discard -oldest events first). - -Message Size -~~~~~~~~~~~~ - -Message size should be limited to 2 megabytes of uncompressed text sent -as application/json. - -Operation: publishAnyEvent --------------------------- - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish any single event to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -Call Flow -~~~~~~~~~ - -|image3| - -Figure - publishAnyEvent Call Flow - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Accept | string | No | Determines the | -| | | | format of the | -| | | | body of the | -| | | | response. Valid | -| | | | values are: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| Authorization | string | Yes | The username | -| | | | and password | -| | | | are formed into | -| | | | one string as | -| | | | “username:passw | -| | | | ord”. | -| | | | This string is | -| | | | then Base64 | -| | | | encoded to | -| | | | produce the | -| | | | encoded | -| | | | credential | -| | | | which is | -| | | | communicated in | -| | | | the header | -| | | | after the | -| | | | string | -| | | | “Authorization: | -| | | | Basic “. See | -| | | | examples below. | -| | | | If the | -| | | | Authorization | -| | | | header is | -| | | | missing, then | -| | | | an HTTP 400 | -| | | | Invalid Request | -| | | | message shall | -| | | | be returned. If | -| | | | the string | -| | | | supplied is | -| | | | invalid, then | -| | | | an HTTP 401 | -| | | | Unauthorized | -| | | | message shall | -| | | | be returned. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Note that | -| | | | content length | -| | | | is limited to | -| | | | 2Megabyte. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | Yes | Must be set to | -| | | | one of the | -| | | | following | -| | | | values: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | No | The minor | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | No | The patch | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | No | The full | -| | | | version of the | -| | | | API requested | -| | | | by the client | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Event | event | Yes | Contains the | -| | | | JSON structure | -| | | | of the common | -| | | | event format. | -+-----------------+-----------------+-----------------+-----------------+ - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Used only in | -| | | | error | -| | | | conditions. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | No | Used only in | -| | | | error | -| | | | conditions | -+-----------------+-----------------+-----------------+-----------------+ -| Date | datetime | No | Date time of | -| | | | the response in | -| | | | GMT | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | Yes | The minor | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | Yes | The patch | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | Yes | The full | -| | | | version of the | -| | | | API service | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields (for success responses): no content is provided. - -Body Fields (for error responses): - -+---------------+---------------+------------------+--------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+---------------+---------------+------------------+--------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+---------------+---------------+------------------+--------------------------------+ - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| *Code* | *Reason Phrase* | *Description* | -+=======================+=======================+=======================+ -| 202 | Accepted | The request has been | -| | | accepted for | -| | | processing | -+-----------------------+-----------------------+-----------------------+ -| 400 | Bad Request | Many possible reasons | -| | | not specified by the | -| | | other codes (e.g., | -| | | missing required | -| | | parameters or | -| | | incorrect format). | -| | | The response body may | -| | | include a further | -| | | exception code and | -| | | text. HTTP 400 errors | -| | | may be mapped to | -| | | SVC0001 (general | -| | | service error), | -| | | SVC0002 (bad | -| | | parameter), SVC2000 | -| | | (general service | -| | | error with details) | -| | | or PO9003 (message | -| | | content size exceeds | -| | | the allowable limit). | -+-----------------------+-----------------------+-----------------------+ -| 401 | Unauthorized | Authentication failed | -| | | or was not provided. | -| | | HTTP 401 errors may | -| | | be mapped to POL0001 | -| | | (general policy | -| | | error) or POL2000 | -| | | (general policy error | -| | | with details). | -+-----------------------+-----------------------+-----------------------+ -| 404 | Not Found | The server has not | -| | | found anything | -| | | matching the | -| | | Request-URI. No | -| | | indication is given | -| | | of whether the | -| | | condition is | -| | | temporary or | -| | | permanent. | -+-----------------------+-----------------------+-----------------------+ -| 405 | Method Not Allowed | A request was made of | -| | | a resource using a | -| | | request method not | -| | | supported by that | -| | | resource (e.g., using | -| | | PUT on a REST | -| | | resource that only | -| | | supports POST). | -+-----------------------+-----------------------+-----------------------+ -| 500 | Internal Server Error | The server | -| | | encountered an | -| | | internal error or | -| | | timed out; please | -| | | retry (general | -| | | catch-all server-side | -| | | error).HTTP 500 | -| | | errors may be mapped | -| | | to SVC1000 (no server | -| | | resources). | -+-----------------------+-----------------------+-----------------------+ - -.. _sample-request-and-response-1: - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _sample-request-1: - -Sample Request -^^^^^^^^^^^^^^ - -+-----------------------------------------------------------------------+ -| POST /eventListener/v6 HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| { | -| | -| "event": { | -| | -| "commonEventHeader": { | -| | -| "version": 3.0, | -| | -| "domain": "fault", | -| | -| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000245", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "EricssonOamVf", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": -5.0 | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 3.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are | -| unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| } | -| | -| } | -+-----------------------------------------------------------------------+ - -.. _sample-success-response-1: - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -+------------------------+ - -6. .. rubric:: Sample Error Responses - :name: sample-error-responses - - 1. .. rubric:: Sample Policy Exception - :name: sample-policy-exception - -+-------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+-------------------------------------------------------------+ - -Sample Service Exception -'''''''''''''''''''''''' - -+---------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------+ - -Operation: publishEventBatch ----------------------------- - -.. _functional-behavior-1: - -Functional Behavior -~~~~~~~~~~~~~~~~~~~ - -Allows authorized clients to publish any single event to the VES event -listener. - -- Supports only secure HTTPS (one way SSL) access. - -- Uses the HTTP verb POST - -- Supports JSON content types - -- Provides HTTP response codes as well as Service and Policy error - messages - -.. _call-flow-1: - -Call Flow -~~~~~~~~~ - -|image4| - -Figure – publishEventBatch Call Flow - -.. _input-parameters-1: - -Input Parameters -~~~~~~~~~~~~~~~~ - -Header Fields (note: all parameter names shall be treated as -case-insensitive): - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Accept | string | No | Determines the | -| | | | format of the | -| | | | body of the | -| | | | response. Valid | -| | | | values are: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| Authorization | string | Yes | The username | -| | | | and password | -| | | | are formed into | -| | | | one string as | -| | | | “username:passw | -| | | | ord”. | -| | | | This string is | -| | | | then Base64 | -| | | | encoded to | -| | | | produce the | -| | | | encoded | -| | | | credential | -| | | | which is | -| | | | communicated in | -| | | | the header | -| | | | after the | -| | | | string | -| | | | “Authorization: | -| | | | Basic “. See | -| | | | examples below. | -| | | | If the | -| | | | Authorization | -| | | | header is | -| | | | missing, then | -| | | | an HTTP 400 | -| | | | Invalid Request | -| | | | message shall | -| | | | be returned. If | -| | | | the string | -| | | | supplied is | -| | | | invalid, then | -| | | | an HTTP 401 | -| | | | Unauthorized | -| | | | message shall | -| | | | be returned. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Note that | -| | | | content length | -| | | | is limited to | -| | | | 2Megabyte. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | Yes | Must be set to | -| | | | one of the | -| | | | following | -| | | | values: | -| | | | | -| | | | - application/ | -| | | | json | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | No | The minor | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | No | The patch | -| | | | version of the | -| | | | API requested | -| | | | by the client | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | No | The full | -| | | | version of the | -| | | | API requested | -| | | | by the client | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| eventList | eventList | Yes | Array of events | -| | | | conforming to | -| | | | the common | -| | | | event format. | -+-----------------+-----------------+-----------------+-----------------+ - -.. _output-parameters-1: - -Output Parameters -~~~~~~~~~~~~~~~~~ - -Header fields: - -+-----------------+-----------------+-----------------+-----------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief | -| | | | description** | -+-----------------+-----------------+-----------------+-----------------+ -| Content-length | integer | No | Used only in | -| | | | error | -| | | | conditions. | -+-----------------+-----------------+-----------------+-----------------+ -| Content-type | string | No | Used only in | -| | | | error | -| | | | conditions | -+-----------------+-----------------+-----------------+-----------------+ -| Date | datetime | No | Date time of | -| | | | the response in | -| | | | GMT | -+-----------------+-----------------+-----------------+-----------------+ -| X-MinorVersion | integer | Yes | The minor | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-PatchVersion | integer | Yes | The patch | -| | | | version of the | -| | | | API service | -+-----------------+-----------------+-----------------+-----------------+ -| X-LatestVersion | string | Yes | The full | -| | | | version of the | -| | | | API service | -| | | | expressed as | -| | | | {major}.{minor} | -| | | | .{patch} | -+-----------------+-----------------+-----------------+-----------------+ - -Body Fields (for success responses: no content is provided. - -Body Fields (for error responses): - -+---------------+---------------+------------------+--------------------------------+ -| **Parameter** | **Data Type** | **Required?** | **Brief description** | -+---------------+---------------+------------------+--------------------------------+ -| requestError | requestError | Yes (for errors) | Used only in error conditions. | -+---------------+---------------+------------------+--------------------------------+ - -.. _http-status-codes-1: - -HTTP Status Codes -~~~~~~~~~~~~~~~~~ - -+-----------------------+-----------------------+-----------------------+ -| *Code* | *Reason Phrase* | *Description* | -+=======================+=======================+=======================+ -| 202 | Accepted | The request has been | -| | | accepted for | -| | | processing | -+-----------------------+-----------------------+-----------------------+ -| 400 | Bad Request | Many possible reasons | -| | | not specified by the | -| | | other codes (e.g., | -| | | missing required | -| | | parameters or | -| | | incorrect format). | -| | | The response body may | -| | | include a further | -| | | exception code and | -| | | text. HTTP 400 errors | -| | | may be mapped to | -| | | SVC0001 (general | -| | | service error), | -| | | SVC0002 (bad | -| | | parameter), SVC2000 | -| | | (general service | -| | | error with details) | -| | | or PO9003 (message | -| | | content size exceeds | -| | | the allowable limit). | -+-----------------------+-----------------------+-----------------------+ -| 401 | Unauthorized | Authentication failed | -| | | or was not provided. | -| | | HTTP 401 errors may | -| | | be mapped to POL0001 | -| | | (general policy | -| | | error) or POL2000 | -| | | (general policy error | -| | | with details). | -+-----------------------+-----------------------+-----------------------+ -| 404 | Not Found | The server has not | -| | | found anything | -| | | matching the | -| | | Request-URI. No | -| | | indication is given | -| | | of whether the | -| | | condition is | -| | | temporary or | -| | | permanent. | -+-----------------------+-----------------------+-----------------------+ -| 405 | Method Not Allowed | A request was made of | -| | | a resource using a | -| | | request method not | -| | | supported by that | -| | | resource (e.g., using | -| | | PUT on a REST | -| | | resource that only | -| | | supports POST). | -+-----------------------+-----------------------+-----------------------+ -| 500 | Internal Server Error | The server | -| | | encountered an | -| | | internal error or | -| | | timed out; please | -| | | retry (general | -| | | catch-all server-side | -| | | error).HTTP 500 | -| | | errors may be mapped | -| | | to SVC1000 (no server | -| | | resources). | -+-----------------------+-----------------------+-----------------------+ - -.. _sample-request-and-response-2: - -Sample Request and Response -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. _sample-request-2: - -Sample Request -^^^^^^^^^^^^^^ - -+-----------------------------------------------------------------------+ -| POST /eventListener/v6/eventBatch HTTP/1.1 | -| | -| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== | -| | -| content-type: application/json | -| | -| | content-length: 12345 | -| | { | -| | -| "eventList": [ | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": 3.0, | -| | -| "domain": "fault", | -| | -| "eventName": "Fault_Vscf:Acs-Ericcson_PilotNumberPoolExhaustion", | -| | -| "eventId": "fault0000250", | -| | -| "sequence": 1, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "EricssonOamVf", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000000, | -| | -| "lastEpochMicrosec": 1413378172000000, | -| | -| "timeZoneOffset": -5.0 | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 3.0, | -| | -| "alarmCondition": "PilotNumberPoolExhaustion", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Calls cannot complete - pilot numbers are | -| unavailable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active", | -| | -| "alarmAdditionalInformation": { | -| | -| "PilotNumberPoolSize": "1000" | -| | -| } | -| | -| } | -| | -| }, | -| | -| { | -| | -| "commonEventHeader": { | -| | -| "version": 3.0, | -| | -| "domain": "fault", | -| | -| "eventName": " Fault_Vscf:Acs-Ericcson_RecordingServerUnreachable", | -| | -| "eventId": "ab305d54-85b4-a31b-7db2-fb6b9e546025", | -| | -| "sequence": 0, | -| | -| "priority": "High", | -| | -| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", | -| | -| "reportingEntityName": "EricssonOamVf", | -| | -| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", | -| | -| "sourceName": "scfx0001vm002cap001", | -| | -| "nfNamingCode": "scfx", | -| | -| "nfcNamingCode": "ssc", | -| | -| "startEpochMicrosec": 1413378172000010, | -| | -| "lastEpochMicrosec": 1413378172000010, | -| | -| "timeZoneOffset": -5.0 | -| | -| }, | -| | -| "faultFields": { | -| | -| "faultFieldsVersion": 3.0, | -| | -| "alarmCondition": "RecordingServerUnreachable", | -| | -| "eventSourceType": "other", | -| | -| "specificProblem": "Recording server unreachable", | -| | -| "eventSeverity": "CRITICAL", | -| | -| "vfStatus": "Active" | -| | -| } | -| | -| } | -| | -| ] | -| | -| } | -+-----------------------------------------------------------------------+ - -.. _sample-success-response-2: - -Sample Success Response -^^^^^^^^^^^^^^^^^^^^^^^ - -+------------------------+ -| HTTPS/1.1 202 Accepted | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -+------------------------+ - -9. .. rubric:: Sample Error Responses - :name: sample-error-responses-1 - - 3. .. rubric:: Sample Policy Exception - :name: sample-policy-exception-1 - -+-------------------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -| | -| { | -| | -| “requestError”: { | -| | -| “policyException”: { | -| | -| “messageId”: “POL9003”, | -| | -| “text”: “Message content size exceeds the allowable limit”, | -| | -| } | -| | -| } | -| | -| } | -+-------------------------------------------------------------+ - -.. _sample-service-exception-1: - -Sample Service Exception -'''''''''''''''''''''''' - -+---------------------------------------------------+ -| HTTPS/1.1 400 Bad Request | -| | -| content-type: application/json | -| | -| content-length: 12345 | -| | -| Date: Thu, 04 Jun 2009 02:51:59 GMT | -| | -| X-MinorVersion: 0 | -| | -| X-PatchVersion: 0 | -| | -| X-LatestVersion: 6.0.0 | -| | -| { | -| | -| “requestError”: { | -| | -| “serviceException”: { | -| | -| “messageId”: “SVC2000”, | -| | -| “text”: “Missing Parameter: %1. Error code is %2” | -| | -| “variables”: [ | -| | -| “severity”, | -| | -| “400” | -| | -| ] | -| | -| } | -| | -| } | -| | -| } | -+---------------------------------------------------+ - -Terminology -=========== - -Terminology used in this document is summarized below: - -**A&AI**. Active & Available Inventory is the ONAP component that -provides data views of Customer Subscriptions, Products, Services, -Resources, and their relationships. - -**Alarm Condition**. Short name of the alarm condition/problem, such as -a trap name. - -**APPC (formerly APP-C)**. Application Controller. Handles the life -cycle management of Virtual Network Functions (VNFs). - -**ASDC**. AT&T Service Design and Creation Platform: the original name -for the SDC. Replaced by SDC. - -**Common Event Format**. A JSON schema describing events sent to the VES -Event Listener. - -**Common Event Header**. A component of the Common Event Format JSON -structure. This datatype consists of fields common to all events. - -**DCAE**. Data Collection Analysis and Events. DCAE is the ONAP -subsystem that supports closed loop control and higher-level correlation -for business and operations activities. DCAE collects performance, -usage, and configuration data, provides computation of analytics, aids -in trouble-shooting and management, and publishes event, data, and -analytics to the rest of the ONAP system for FCAPS functionality. - -**DMaaP.** Data Movement as a Platform. A set of common services -provided by ONAP, including a Message Router, Data Router, and a Data -Bus Controller. - -**Domain**. In VES, an event ‘domain’ identifies a broad category of -events (e.g., ‘fault’ or ‘measurement’), each of which is associated -with a VES domain field block, which is sent with the commonEventHeader -when events of that category are generated. - -**ECOMP**. Enhanced Control, Orchestration, Management and Policy -preceded ONAP and is the name given to AT&T’s instance of the ONAP -platform. - -**Epoch**. The number of seconds that have elapsed since -00:00:00 \ `Coordinated Universal -Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC), -Thursday, 1 January 1970. Every day is treated as if it contains exactly -86400 seconds, so \ `leap -seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied -to seconds since the Epoch. In VES Epoch times are measured in -microseconds. - -**Event.** A well-structured packet of network management information -identified by an eventName which is asynchronously communicated to one -or more instances of an Event Listener service to subscribers interested -in that eventName. Events can convey measurements, faults, syslogs, -threshold crossing alerts, and others types of information. - -**Event Id**. Event key that is unique to the event source. The key must -be unique within notification life cycle similar to EventID from 3GPP. -It could be a sequential number, or a composite key formed from the -event fields, such as sourceName_alarmCondition_startEpoch. The eventId -should not include whitespace. For fault events, eventId is the eventId -of the initial alarm; if the same alarm is raised again for changed, -acknowledged or cleared cases, eventId must be the same as the initial -alarm (along with the same startEpochMicrosec and an incremental -sequence number. - -**Event Name**. Identifier for specific types of events. Specific -eventNames registered by the YAML may require that certain fields, which -are optional in the Common Event Format, be present when events with -that eventName are published. - -**Event Streaming**. The delivery of network management event -information in real time. - -**Extensible Data Structures**. Data structures (e.g., hashMap) that -allow event sources to send information not specifically identified in -the VES schema. - -**Hash Map**. A hash table, or data structure, used to implement an -associative array, a structure than can map keys to values. In VES 6.0, -all name-value pair structures were changed to hash maps (i.e., {‘name’: -‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’: -‘keyValue’}). - -**ICE**. Incubation and Certification Environment. Facilitates vendors -and third-party in developing virtual network functions using ONAP and a -network cloud. - -**IPMI**. The `Intelligent Platform Management -Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__. - -**JSON**. Java Script Object Notation. JSON is an -`open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file -format <https://en.wikipedia.org/wiki/File_format>`__ that uses -`human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__ -text to transmit data objects consisting of `attribute–value -pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__ -and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__ -(or any other -`serializable <https://en.wikipedia.org/wiki/Serialization>`__ value). -It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format -used for -`asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__ -browser–server communication. - -**NF**. Network Function. Generalized name for a VNF or PNF. - -**NFC**. Network Function Component. Generalized name for a VNFC or a -component of a PNF. - -**ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__. - -**PNF**. Physical Network Function. - -**Policy**. Course of action for the management of the network. The ONAP -Policy Framework is a comprehensive policy design, deployment, and -execution environment. The Policy Framework is the **decision making** -component in `an ONAP -system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__. -It allows you to specify, deploy, and execute the governance of the -features and functions in your ONAP system, be they closed loop, -orchestration, or more traditional open loop use case implementations. -The Policy Framework is the component that is the source of truth for -all policy decisions. - -**Reporting Entity Name**. Name of the entity reporting the event or -detecting a problem in another vnf/vm or pnf which is experiencing the -problem. May be the same as the sourceName. Not used for performance -measurements currently. - -**SDC**. Service Design and Creation Platform: The ONAP visual modeling -and design tool. It creates internal metadata that describes assets used -by all ONAP components, both at design time and run time. The SDC -manages the content of a catalog, and assemblies of selected catalog to -define how and when VNFs are realized in a target environment. - -**Source Name**: Name of the entity experiencing the event issue, which -may be detected and reported by a separate reporting entity. The -sourceName identifies the device for which data is collected. A valid -sourceName must be inventoried in A&AI. - -**Specific Problem**. Description of the alarm or problem. - -**VES**. Virtual Function Event Stream. In 6.0, the definition of VES -was expanded to include event streaming for VNF, PNF and infrastructure. -The VES Event Listener can receive any event sent in the VES Common -Event Format. - -**VES Event Listener**. A RESTful connectionless push event listener -capable of receiving single events or batches of events sent in the -Common Event Format. - -**VM**. Virtual Machine. - -**VNF**. Virtual Network Function. A VNF is a virtualized task formerly -carried out by proprietary, dedicated network hardware. (Examples: -virtual firewall, virtual DNS). A VNF can also be defined as a specific -kind of Vendor Software Product. - -**YAML**. A `data serialization -language <https://en.wikipedia.org/wiki/Data_serialization_language>`__ -and superset of JSON. - -**VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF. -It is a stand-alone executable that is loosely-coupled, granular, -re-usable, and responsible for a single capability. - -Appendix: Historical Change Log -=============================== - -For the latest changes, see the Change Block just before the Table of -Contents. - -+-----------------------+-----------------------+-----------------------+ -| Date | Revision | Description | -+-----------------------+-----------------------+-----------------------+ -| 5/22/2015 | 0.1 | Initial Release - | -| | | Draft | -+-----------------------+-----------------------+-----------------------+ -| 5/29/2015 | 0.2 | - Introduction: | -| | | removed all | -| | | system names | -| | | and references | -| | | to internal | -| | | AT&T components | -| | | | -| | | - Security: changed | -| | | ‘event | -| | | publisher’ to | -| | | ‘event source’ | -| | | | -| | | - Generic Event | -| | | Format: updated | -| | | the JSON schema | -| | | per the below: | -| | | | -| | | - eventHeader: | -| | | clarified the | -| | | description of | -| | | id, made | -| | | sourceId a | -| | | required field, | -| | | changed the | -| | | datatype of | -| | | timestamps to | -| | | timestamp [ ] | -| | | | -| | | - performanceFields: | -| | | removed | -| | | overflowFields | -| | | | -| | | - tmestamp: added a | -| | | description of | -| | | this datatype | -| | | | -| | | - Exceptions: fixed | -| | | indentation of | -| | | sections | -| | | | -| | | - Approvers: updated | -| | | the list of | -| | | approvers and | -| | | added attuids | -+-----------------------+-----------------------+-----------------------+ -| 6/3/2015 | 0.3 | - Updated the | -| | | security | -| | | section to use | -| | | HTTP Basic | -| | | Authentication | -| | | per AT&T REST | -| | | standards. | -| | | Updated the | -| | | input | -| | | parameters and | -| | | messaging | -| | | examples to use | -| | | the new | -| | | security | -| | | scheme. | -+-----------------------+-----------------------+-----------------------+ -| 6/5/2015 | 0.4 | - Added otherFields | -| | | sub section to | -| | | the defined | -| | | datatypes | -| | | | -| | | - Added locale field | -| | | to the | -| | | eventHeader. | -+-----------------------+-----------------------+-----------------------+ -| 6/5/2015 | 0.5 | - Updated the | -| | | embedded event | -| | | format json | -| | | schema to match | -| | | the changes | -| | | made in v0.4 | -+-----------------------+-----------------------+-----------------------+ -| 6/10/2015 | 0.6 | - Updated the | -| | | {ServerRoot} | -| | | format to | -| | | contain an | -| | | optional | -| | | routing path | -| | | (for D2 service | -| | | modules). | -+-----------------------+-----------------------+-----------------------+ -| 7/7/2015 | 0.7 | Common Event | -| | | Format updates: | -| | | | -| | | - EventHeader: added | -| | | ‘measurement’ | -| | | to the ‘domain’ | -| | | enumeration; | -| | | changed | -| | | ‘locale’ to | -| | | ‘location’ and | -| | | clarified in | -| | | the description | -| | | that this | -| | | should be a | -| | | clli code | -| | | | -| | | - Added a | -| | | MeasurementFiel | -| | | ds | -| | | datatype, which | -| | | required the | -| | | addition of the | -| | | following | -| | | datatypes: | -| | | codecsInUse, | -| | | cpuUsage, | -| | | diskUsage, | -| | | featuresInUse, | -| | | memoryUsage | -+-----------------------+-----------------------+-----------------------+ -| 7/15/2015 | 1.0 | - Changed | -| | | sourceInstance in | -| | | the eventHeader to | -| | | be an array of | -| | | name value pairs | -| | | | -| | | - Changed the | -| | | performanceFields | -| | | block to | -| | | thresholdCrossingA | -| | | lertFields. | -| | | Updated the domain | -| | | field of the | -| | | eventHeader to | -| | | match. | -+-----------------------+-----------------------+-----------------------+ -| 7/23/2015 | v1.1 | Changes to | -| | | eventHeader data | -| | | format: | -| | | | -| | | - moved | -| | | sourceInstance | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved | -| | | serviceInstance | -| | | Id | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved productId to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved subscriberId | -| | | to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - moved location to | -| | | internalHeaderF | -| | | ields | -| | | | -| | | - added the | -| | | following new | -| | | fields in | -| | | internalHeaderF | -| | | ields: | -| | | policyType, | -| | | policyName, | -| | | correlationEven | -| | | tType, | -| | | correlationType | -| | | , | -| | | correlationName | -| | | , | -| | | correlationRoot | -| | | EventId | -| | | | -| | | - Changes to | -| | | faultFields | -| | | data format: | -| | | | -| | | - moved the | -| | | eventSourceDevi | -| | | ceDescription | -| | | to | -| | | internalFaultFi | -| | | elds | -| | | and renamed it | -| | | equipmentVendor | -| | | Model | -| | | | -| | | - moved | -| | | eventSourceHost | -| | | name | -| | | to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - changed | -| | | alarmObjectInte | -| | | rface | -| | | to | -| | | alarmInterfaceA | -| | | | -| | | - changed | -| | | alarmRemoteObje | -| | | ct | -| | | to | -| | | alarmRemoteObje | -| | | ctZ | -| | | and moved it to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - changed | -| | | alarmRemoteObje | -| | | ctInterface | -| | | to | -| | | alarmInterfaceZ | -| | | and moved it to | -| | | internalFaultFi | -| | | elds | -| | | | -| | | - Changes to | -| | | thresholdCrossi | -| | | ngFields | -| | | data format: | -| | | | -| | | - changed several | -| | | references from | -| | | the old | -| | | ‘performanceFie | -| | | lds’ | -| | | block to the | -| | | new | -| | | ‘thresholdCross | -| | | ingFields’ | -| | | block | -| | | | -| | | - Other: | -| | | | -| | | - Fixed several | -| | | comma and colon | -| | | syntax errors | -| | | in the JSON | -| | | schema as | -| | | detected by a | -| | | JSON schema | -| | | syntax checker. | -+-----------------------+-----------------------+-----------------------+ -| 8/11/2015 | v1.2 | Timestamp format: | -| | | | -| | | - Section 4.18: | -| | | added a note in | -| | | the datetime | -| | | field of the | -| | | Timestamp | -| | | datatype | -| | | specifying the | -| | | (GMT) format | -| | | required | -| | | | -| | | - Updated the JSON | -| | | schema with the | -| | | same | -| | | information | -| | | | -| | | .. | -| | | | -| | | Event Header | -| | | Severity | -| | | Enumeration: | -| | | | -| | | - Section 4.8: | -| | | modified the | -| | | severity | -| | | enumeration to | -| | | remove the | -| | | numbers in | -| | | parentheses | -| | | that followed | -| | | the names. The | -| | | names were not | -| | | changed. | -| | | | -| | | - Updated the JSON | -| | | schema with the | -| | | same | -| | | information. | -+-----------------------+-----------------------+-----------------------+ -| 8/20/2015 | v1.3 | JSON Schema rev’d to | -| | | v9: | -| | | | -| | | - Alphabetized all | -| | | fields in the | -| | | JSON schema | -| | | | -| | | - Fixed the way | -| | | arrays were | -| | | specified (JSON | -| | | schema syntax | -| | | issue) | -| | | | -| | | Sample Responses: | -| | | | -| | | - 2.1.1.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.2.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.3.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -| | | | -| | | - 6.4.6.1: | -| | | alphabetized | -| | | fields, fixed | -| | | timestamps | -| | | array | -| | | depiction, | -| | | fixed eventList | -| | | array | -| | | depection, | -| | | fixed severity | -| | | enum value to | -| | | conform to | -| | | latest format | -+-----------------------+-----------------------+-----------------------+ -| 9/16/2015 | v1.4 | JSON Schema rev’d to | -| | | v10: | -| | | | -| | | - Fixed an error in | -| | | the way that | -| | | the top level | -| | | “event” object | -| | | was specified | -| | | in the v9 json | -| | | schema. This | -| | | was discovered | -| | | when validating | -| | | examples | -| | | against the | -| | | schema using | -| | | this site: | -| | | http://json-sch | -| | | ema-validator.herokua | -| | | pp.com/index.jsp. | -| | | | -| | | - Changed the | -| | | embedded json | -| | | file in section | -| | | 4 | -| | | | -| | | Sample Responses: | -| | | | -| | | - Removed an extra | -| | | comma after the | -| | | timestamp brace | -| | | in section | -| | | 6.2.6 and | -| | | 6.3.6. | -+-----------------------+-----------------------+-----------------------+ -| 11/11/2015 | v1.5 | Section 4 was the | -| | | only section changed: | -| | | JSON Schema rev’d to | -| | | v11 and Datatype | -| | | tables were updated | -| | | to match. Numerous | -| | | data structure | -| | | changes were made | -| | | based on VNF vendor | -| | | proof of concept | -| | | feedback. Modified | -| | | sample requests and | -| | | responses to match. | -+-----------------------+-----------------------+-----------------------+ -| 11/12/2015 | v1.6 | - The | -| | | internalFaultFi | -| | | elds | -| | | were merged | -| | | into the | -| | | internalHeaderF | -| | | ields; | -| | | then the | -| | | internalFaultFi | -| | | elds | -| | | datatype was | -| | | deleted. | -| | | | -| | | - Updated the JSON | -| | | schema to v12. | -| | | | -| | | - Also corrected | -| | | some background | -| | | color issues in | -| | | the sample | -| | | requests and | -| | | responses. | -+-----------------------+-----------------------+-----------------------+ -| 1/18/2016 | v1.7 | - Section 2 changes: | -| | | updated the | -| | | sample request | -| | | to conform with | -| | | the changes | -| | | below | -| | | | -| | | - Section 4 datatype | -| | | changes: | -| | | | -| | | - Changed | -| | | 'eventHeader' | -| | | to | -| | | 'commonEventHea | -| | | der' | -| | | | -| | | - Moved | -| | | 'eventSeverity' | -| | | from the | -| | | 'commonEventHea | -| | | der' | -| | | to | -| | | 'faultFields' | -| | | | -| | | - Added 'priority' | -| | | to | -| | | 'commonEventHea | -| | | der' | -| | | | -| | | - moved 'vFstatus' | -| | | to | -| | | 'faultFields' | -| | | | -| | | - removed | -| | | 'firstDateTime' | -| | | and | -| | | 'lastDateTime' | -| | | and changed | -| | | 'firstEpoch' to | -| | | 'startEpochMicr | -| | | osec' | -| | | and changed | -| | | 'lastEpoch' to | -| | | 'lastEpochMicro | -| | | sec'. | -| | | | -| | | - Added | -| | | 'functionalRole | -| | | ' | -| | | to the | -| | | commonEventHead | -| | | er | -| | | | -| | | - In the | -| | | commonEventHead | -| | | er, | -| | | changed the | -| | | 'eventDomain' | -| | | enumeration to | -| | | remove | -| | | 'measurements' | -| | | and add | -| | | 'measurementsFo | -| | | rVfScaling'. | -| | | | -| | | - Changed the | -| | | 'measurementFie | -| | | lds' | -| | | to | -| | | 'measurementsFo | -| | | rVfScalingFields' | -| | | | -| | | - In the | -| | | commonEventHead | -| | | er, | -| | | changed the | -| | | following | -| | | fields: | -| | | | -| | | - 'eventDomain' to | -| | | 'domain' | -| | | | -| | | - 'eventSequence' to | -| | | 'sequence' | -| | | | -| | | - 'eventSourceId' to | -| | | 'sourceId' | -| | | | -| | | - 'eventSounceName' | -| | | to 'sourceName' | -| | | | -| | | - Updated the JSON | -| | | schema to v13 | -| | | | -| | | - Section 6 changes: | -| | | updated the | -| | | input | -| | | parameters and | -| | | sample requests | -| | | to conform to | -| | | the changes | -| | | above. | -| | | | -| | | - Section 7: changed | -| | | the section | -| | | from Approvers | -| | | to | -| | | Contributors. | -+-----------------------+-----------------------+-----------------------+ -| 1/22/2016 | v1.8 | - Section 4: Added | -| | | support for | -| | | ‘mobileFlow’ in | -| | | the | -| | | commonEventHead | -| | | er | -| | | ‘domain’ | -| | | enumeration. | -| | | Added the | -| | | mobileFlowField | -| | | s | -| | | datatype and | -| | | the | -| | | gtpPerFlowMetri | -| | | cs | -| | | datatype | -| | | referenced by | -| | | that datatype. | -| | | | -| | | - Section 7: | -| | | alphabetized | -| | | the | -| | | contributors | -+-----------------------+-----------------------+-----------------------+ -| 2/11/2016 | v1.9 | - Added section 1.3: | -| | | Naming Standard | -| | | for Event Types | -+-----------------------+-----------------------+-----------------------+ -| 2/12/2016 | v2.0 | - Updated request – | -| | | response | -| | | examples to | -| | | reflect the | -| | | naming | -| | | standards for | -| | | event types | -| | | introduced in | -| | | v1.9. | -| | | | -| | | - Added a paragraph | -| | | on use of Avro | -| | | as a transport | -| | | in section 1.4 | -+-----------------------+-----------------------+-----------------------+ -| 3/11/2016 | v2.1 | - Updated the | -| | | embedded JSON | -| | | schema to v15 | -| | | to fix a typo | -| | | in the required | -| | | fields for the | -| | | measurementsFor | -| | | VfScalingFields, | -| | | namely, changed | -| | | ‘configuredEnti | -| | | tes’ | -| | | to | -| | | ‘configuredEnti | -| | | ties’. | -| | | Additionally, | -| | | added an ‘Event | -| | | Listener’ title | -| | | block at the | -| | | bottom of the | -| | | file with a | -| | | single required | -| | | event object. | -+-----------------------+-----------------------+-----------------------+ -| 3/15/2016 | v2.2 | - Added | -| | | mobileFlowField | -| | | s | -| | | to the event | -| | | datatype | -| | | definition in | -| | | section 4.7 and | -| | | updated the | -| | | embedded json | -| | | schema at the | -| | | top of section | -| | | 4 to v16. | -+-----------------------+-----------------------+-----------------------+ -| 4/26/2016 | v2.3 | - Generic Event | -| | | Format updates: | -| | | 1) made | -| | | ‘priority’ | -| | | lowercase in | -| | | the Word doc | -| | | table for | -| | | commonEventHead | -| | | er; | -| | | 2) added | -| | | ‘requestError’ | -| | | data structure | -| | | to the Word doc | -| | | and JSON schema | -| | | (which is now | -| | | at v17) | -+-----------------------+-----------------------+-----------------------+ -| 4/27/2016 | v2.4 | - JSON Schema: In | -| | | the 'event' | -| | | data structure, | -| | | changed | -| | | 'thresholdCross | -| | | ingFields' | -| | | to | -| | | 'thresholdCross | -| | | ingAlertFields' | -| | | to product v18 | -| | | of the schema. | -| | | | -| | | - 'codecsInUse' data | -| | | structure: | -| | | changed | -| | | 'numberInUse' | -| | | to | -| | | 'codecUtilizati | -| | | on’ | -+-----------------------+-----------------------+-----------------------+ -| 5/26/2016 | v2.5 | - Changed responses | -| | | from ‘204 No | -| | | Content’ to | -| | | ‘202 Accepted’ | -| | | and added a | -| | | body to the | -| | | response that | -| | | enable AT&T to | -| | | throttle the | -| | | events being | -| | | sent and/or to | -| | | request the | -| | | current state | -| | | of throttling | -| | | at the event | -| | | source. | -| | | | -| | | - Added new | -| | | datatypes to | -| | | support the | -| | | above: | -| | | eventDomainThro | -| | | ttleSpecification, | -| | | eventDomainThro | -| | | ttleSpecificationList | -| | | , | -| | | eventThrottling | -| | | State, | -| | | suppressedNvPai | -| | | rs | -| | | | -| | | - Modifed the | -| | | commonEventForm | -| | | at | -| | | json schema to | -| | | v19 | -| | | | -| | | - Note: for the | -| | | VendorEventList | -| | | ener: | -| | | added new | -| | | licensing | -| | | language on the | -| | | back of the | -| | | title page; | -| | | added an | -| | | “attCopyrightNo | -| | | tice” | -| | | definition at | -| | | the top of the | -| | | commonEventForm | -| | | at_Vendors.json | -| | | file; also | -| | | removed all | -| | | references to | -| | | internalHeaderF | -| | | ields | -| | | from this file | -| | | and from the | -| | | VendorEventList | -| | | ener | -| | | spec. | -+-----------------------+-----------------------+-----------------------+ -| 8/9/2016 | v2.6 | - commonHeader: | -| | | added a note on | -| | | the description | -| | | of sourceId and | -| | | sourceName in | -| | | the | -| | | commonHeader: | -| | | "use | -| | | reportingEntity | -| | | for domains | -| | | that provide | -| | | more detailed | -| | | source info" | -| | | | -| | | - commonHeader: | -| | | deleted the | -| | | capacity, | -| | | measurementsFor | -| | | VfScaling | -| | | and usage | -| | | domains in the | -| | | domain | -| | | enumeration | -| | | | -| | | - commonHeader: | -| | | added the | -| | | following | -| | | domains to the | -| | | domain | -| | | enumeration: | -| | | licensingKci, | -| | | scalingKpi, | -| | | stateChange | -| | | | -| | | - event: removed | -| | | references to | -| | | capacityFields, | -| | | measurementsFor | -| | | VfScalingFields | -| | | and usageFields | -| | | and added | -| | | references to | -| | | licensingKciFie | -| | | lds, | -| | | scalingKpiField | -| | | s, | -| | | stateChangeFiel | -| | | ds | -| | | | -| | | - licensingKciFields | -| | | : | -| | | added this | -| | | section along | -| | | with | -| | | 'additionalMeas | -| | | urements', | -| | | which is an | -| | | optional list | -| | | of | -| | | measurementGrou | -| | | p | -| | | structures. | -| | | Changed the | -| | | name of | -| | | kciFieldsVersio | -| | | n | -| | | to | -| | | licensingKciFie | -| | | ldsVersion. | -| | | | -| | | - scalingKpiFields: | -| | | added this | -| | | section but | -| | | changed | -| | | measurementFiel | -| | | dsVersion | -| | | to | -| | | scalingKpiField | -| | | sVersion | -| | | | -| | | - stateChangeFields: | -| | | added this | -| | | section along | -| | | with | -| | | 'additionalFiel | -| | | ds', | -| | | which is an | -| | | optional list | -| | | of name-value | -| | | pairs. Other | -| | | fields included | -| | | newState and | -| | | oldState which | -| | | were | -| | | enumerations of | -| | | the following | -| | | possible | -| | | states: | -| | | 'inService', | -| | | 'maintenance', | -| | | 'outOfService' | -| | | | -| | | - sysLogFields: | -| | | added | -| | | 'additionalFiel | -| | | ds', | -| | | which is an | -| | | optional list | -| | | of name-value | -| | | pairs | -| | | | -| | | - vNicUsage: added | -| | | two required | -| | | fields to the | -| | | vNicUsage data | -| | | structure: | -| | | packetsIn and | -| | | packetsOut | -+-----------------------+-----------------------+-----------------------+ -| 8/10/2016 | v2.7 | - commonHeader: | -| | | removed the | -| | | note on the | -| | | description of | -| | | sourceId and | -| | | sourceName in | -| | | the | -| | | commonHeader: | -| | | "use | -| | | reportingEntity | -| | | for domains | -| | | that provide | -| | | more detailed | -| | | source info" | -| | | | -| | | - commonHeader: | -| | | added | -| | | measurementsFor | -| | | VfScaling | -| | | domain back and | -| | | removed the | -| | | licensingKci | -| | | and scalingKpi | -| | | domains | -| | | | -| | | - event: removed | -| | | references to | -| | | licensingKciFie | -| | | lds | -| | | and | -| | | scalingKpiField | -| | | s; | -| | | added | -| | | references to | -| | | measurementsFor | -| | | VfScalingFields | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | combined the | -| | | kciDetail and | -| | | kpiDetail | -| | | structures into | -| | | the | -| | | measurementsFor | -| | | VfScalingFields | -| | | structure; | -| | | referenced the | -| | | errors | -| | | structure | -| | | | -| | | - errors: added a | -| | | new structure | -| | | to capture the | -| | | receive and | -| | | transmit errors | -| | | for the | -| | | measurements | -| | | domain | -| | | | -| | | - removed the | -| | | following | -| | | structures: | -| | | kci, kpi, | -| | | scalingKpiField | -| | | s | -| | | and | -| | | licensingKciFie | -| | | lds | -| | | | -| | | - eventDomainThrottl | -| | | eSpecification: | -| | | updated the | -| | | reference to | -| | | commonEventHead | -| | | er | -| | | domain field | -| | | | -| | | - faultFields: | -| | | removed the | -| | | numbers from | -| | | the enumerated | -| | | strings for | -| | | eventSourceType | -| | | | -| | | - vNicUsage: made | -| | | the broadcast, | -| | | multicast and | -| | | unicast fields | -| | | optional | -| | | | -| | | - contributors: | -| | | updated Alok’s | -| | | organizational | -| | | area | -+-----------------------+-----------------------+-----------------------+ -| 8/12/2016 | v2.8 | - commonHeader: | -| | | copied the | -| | | descriptions of | -| | | sourceId and | -| | | sourceName from | -| | | the JSON schema | -| | | into the word | -| | | document | -| | | tables. | -| | | | -| | | - sample request | -| | | examples: moved | -| | | the | -| | | reportingEntity | -| | | Id | -| | | and | -| | | reportingEntity | -| | | Names | -| | | to the same | -| | | relative place | -| | | in all sample | -| | | requests in the | -| | | document | -| | | | -| | | - Fixed the sample | -| | | request shown | -| | | for | -| | | publishEventBat | -| | | ch | -| | | to take an | -| | | eventList as | -| | | input. | -| | | | -| | | - Fixed the sample | -| | | request shown | -| | | for | -| | | publishSpecific | -| | | Topic | -| | | to put the | -| | | topic in the | -| | | URL | -| | | | -| | | - errors: changed | -| | | the | -| | | receiveErrors | -| | | and | -| | | transmitErrors | -| | | fields to be | -| | | datatype number | -| | | | -| | | - codesInUse: | -| | | changed | -| | | 'codecUtilizati | -| | | on' | -| | | to | -| | | 'numberinUse' | -| | | | -| | | - vNicUsage: updated | -| | | the description | -| | | of the fields | -+-----------------------+-----------------------+-----------------------+ -| 8/27/2016 | v2.9 | - Added a note | -| | | "(currently: | -| | | 1.1)" in the | -| | | descriptions of | -| | | the following | -| | | fields: | -| | | commonEventHead | -| | | er:version, | -| | | faultFields:fau | -| | | ltFieldsVersion, | -| | | measurementsFor | -| | | VfScalingFields:measu | -| | | rementsForVfScalingFi | -| | | eldsVersion, | -| | | stateChangeFiel | -| | | ds:stateChangeFieldsV | -| | | ersion, | -| | | sysLogFields:sy | -| | | slogFieldsVersion, | -| | | thresholdCrossi | -| | | ngAlertFields:thresho | -| | | ldCrossingFieldsVersi | -| | | on | -| | | | -| | | - stateChangeFields: | -| | | made | -| | | stateInterface | -| | | mandatory | -| | | | -| | | - changed 'enum' to | -| | | 'enumeration' | -| | | throughout | -| | | section 4 of | -| | | the document | -| | | (note: this | -| | | can't be done | -| | | in the JSON | -| | | schema). | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | made the | -| | | following | -| | | fields | -| | | optional: | -| | | conurrentSessio | -| | | ns, | -| | | configuredEntit | -| | | ites, | -| | | cpuUsageArray, | -| | | fileSystemUsage | -| | | Array, | -| | | memoryConfigure | -| | | d, | -| | | memoryUsed, | -| | | requestRate, | -| | | vNicUsageArray | -| | | | -| | | - measurementsForVfS | -| | | calingFields: | -| | | concurrentSessi | -| | | ons | -| | | and | -| | | configuredEntit | -| | | ies: | -| | | changed the | -| | | description to | -| | | support both | -| | | VMs and VNFs | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | : | -| | | clarified the | -| | | descriptions of | -| | | latencyDistribu | -| | | tion, | -| | | measurementInve | -| | | rval | -| | | and requestRate | -| | | | -| | | - syslogFields: | -| | | clarified the | -| | | descriptions of | -| | | syslogSData, | -| | | syslogTag, | -| | | syslogVer | -| | | | -| | | - thresholdCrossingA | -| | | lertFields: | -| | | made the | -| | | following | -| | | fields optional | -| | | and clarified | -| | | their | -| | | descriptions: | -| | | elementType, | -| | | networkService | -| | | | -| | | - command and | -| | | commandList: | -| | | created a list | -| | | of command | -| | | structures to | -| | | enable the | -| | | event collector | -| | | to request | -| | | changes of | -| | | event sources. | -| | | Commands | -| | | consist of a | -| | | commandType | -| | | along with | -| | | optional fields | -| | | (whose presence | -| | | is indicated by | -| | | the | -| | | commandType). | -| | | Three command | -| | | types are | -| | | currently | -| | | supported: | -| | | 'measurementInt | -| | | evalChange', | -| | | ‘provideThrottl | -| | | ingState’ | -| | | and | -| | | 'throttlingSpec | -| | | ification'. | -| | | | -| | | - eventDomainThrottl | -| | | eSpecificationList: | -| | | removed this | -| | | and replaced it | -| | | with | -| | | commandList. | -| | | | -| | | - Operations and | -| | | Sample | -| | | Requests: | -| | | modified the | -| | | operations and | -| | | samples to | -| | | support the new | -| | | command and | -| | | commandList | -| | | structures. | -+-----------------------+-----------------------+-----------------------+ -| 9/1/2016 | v2.10 | - measurementsForVfS | -| | | caling | -| | | block: made the | -| | | following | -| | | fields | -| | | optional: | -| | | latencyDistribu | -| | | tion | -| | | (which is an | -| | | array of | -| | | latencyBucketMe | -| | | asure | -| | | structures) and | -| | | meanRequestLate | -| | | ncy. | -| | | Updated the | -| | | JSON schemas | -| | | (now v24) to | -| | | match. | -+-----------------------+-----------------------+-----------------------+ -| 9/16/2016 | v2.11 | - 1 Introduction: | -| | | updated the | -| | | introduction to | -| | | clarify the | -| | | usage of | -| | | eventTypes and | -| | | the possibility | -| | | of support for | -| | | other | -| | | protocols. | -| | | | -| | | - 6.1 REST Operation | -| | | Overview: added | -| | | two new | -| | | subsections | -| | | (6.1.2 and | -| | | 6.1.3) | -| | | discussing Api | -| | | Version and | -| | | Commands Toward | -| | | Event Source | -| | | Clients. | -| | | | -| | | - 6.2 | -| | | publishAnyEvent | -| | | : | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.3 | -| | | publishSpecific | -| | | Topic: | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.4 | -| | | publishEventBat | -| | | ch: | -| | | fixed the | -| | | sample to | -| | | conform to the | -| | | latest changes | -| | | | -| | | - 6.5 | -| | | provideThrottli | -| | | ngState | -| | | operation: | -| | | added the Input | -| | | Parameters | -| | | section heading | -| | | back and fixed | -| | | the sample | -| | | request to | -| | | provide | -| | | eventThrottling | -| | | State | -| | | (instead of | -| | | eventThrottling | -| | | ClientState). | -| | | | -| | | - The remaining | -| | | bullets | -| | | describe | -| | | changes made to | -| | | section 4 | -| | | datatypes in | -| | | alphabetical | -| | | order: | -| | | | -| | | - command datatype: | -| | | referenced the | -| | | new section | -| | | 6.1.3 which | -| | | provides an | -| | | explanation of | -| | | command state | -| | | expectations | -| | | and | -| | | requirements | -| | | for a given | -| | | eventSource: | -| | | | -| | | - commonEventHeader | -| | | datatype: | -| | | | -| | | - made sourceId | -| | | and | -| | | reportingEnt | -| | | ityId | -| | | fields | -| | | optional | -| | | (although | -| | | the internal | -| | | Generic | -| | | Event | -| | | Listener | -| | | spec | -| | | indicates, | -| | | in the field | -| | | descriptions | -| | | , | -| | | that the | -| | | AT&T | -| | | enrichment | -| | | process | -| | | shall ensure | -| | | that these | -| | | fields are | -| | | populated) | -| | | | -| | | - domain | -| | | enumeration: | -| | | changed | -| | | measurements | -| | | ForVfScalingFields | -| | | to | -| | | measurements | -| | | ForVfScaling | -| | | | -| | | - eventDomainThrottl | -| | | eSpecificationList: | -| | | added this | -| | | array of | -| | | eventDomainThro | -| | | ttleSpecification | -| | | stuctures back | -| | | to the schema | -| | | because it is | -| | | used by the | -| | | provideThrottli | -| | | ngState | -| | | operation. | -| | | | -| | | - eventList: added | -| | | eventList back | -| | | to the vendor | -| | | version of the | -| | | commonEventForm | -| | | at. | -| | | This is used by | -| | | the | -| | | publishEventBat | -| | | ch | -| | | operation. | -| | | | -| | | - faultFields | -| | | datatype: | -| | | | -| | | - eventSourceType | -| | | : | -| | | made this a | -| | | string (and | -| | | provided the | -| | | previous | -| | | enumerated | -| | | values as | -| | | examples) | -| | | | -| | | - filesystemUsage | -| | | datatype: | -| | | | -| | | - changed | -| | | vmIdentifier | -| | | to | -| | | filesystemNa | -| | | me | -| | | | -| | | - gtpPerFlowMetrics | -| | | datatype: | -| | | | -| | | - flowActivationT | -| | | ime: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - flowDeactivatio | -| | | nTime: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - internalHeaderFiel | -| | | ds | -| | | datatype: | -| | | | -| | | - Added the | -| | | following | -| | | optional | -| | | fields: | -| | | firstDateTim | -| | | e, | -| | | lastDateTime | -| | | compliant | -| | | with RFC | -| | | 2822. Noted | -| | | in the | -| | | description | -| | | that these | -| | | fields must | -| | | be supplied | -| | | for events | -| | | in the | -| | | following | -| | | domains: | -| | | fault, | -| | | thresholdCro | -| | | ssingAlerts | -| | | and | -| | | measurements | -| | | ForVfScaling. | -| | | | -| | | - ticketingTimest | -| | | amp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - syslogFields | -| | | datatype: | -| | | | -| | | - eventSourceType | -| | | : | -| | | made this a | -| | | string (and | -| | | provided the | -| | | previous | -| | | enumerated | -| | | values, | -| | | without the | -| | | numbers, as | -| | | examples) | -| | | | -| | | - thresholdCrossingA | -| | | lerts | -| | | dataypte: | -| | | | -| | | - collectionTimes | -| | | tamp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - eventStartTimes | -| | | tamp: | -| | | changed the | -| | | format and | -| | | description | -| | | to be | -| | | compliant | -| | | with RFC | -| | | 2822. | -| | | | -| | | - added the same | -| | | eventSeverit | -| | | y | -| | | field as | -| | | from the | -| | | faultFields | -| | | and made it | -| | | required | -+-----------------------+-----------------------+-----------------------+ -| 9/23/2016 | v2.12 | - Section 4 | -| | | Datatypes: | -| | | commonEventHead | -| | | er: | -| | | made | -| | | reportingEntity | -| | | Name | -| | | a required | -| | | field (note: | -| | | the JSON schema | -| | | already had | -| | | this field as | -| | | required) | -+-----------------------+-----------------------+-----------------------+ -| 11/29/2016 | v3.0 | - Introduction: | -| | | | -| | | - Introductory | -| | | paragraph: | -| | | changed | -| | | '...Common | -| | | Event Header | -| | | Block | -| | | followed by | -| | | zero or more | -| | | event domain | -| | | blocks' to | -| | | '...Common | -| | | Event Header | -| | | Block | -| | | accompanied | -| | | by zero or | -| | | more event | -| | | domain | -| | | blocks' | -| | | since the | -| | | order of the | -| | | blocks on | -| | | the wire is | -| | | not | -| | | guaranteed. | -| | | | -| | | - Added Section | -| | | 1.5 | -| | | Versioning | -| | | | -| | | - Section 4: codec | -| | | processing: | -| | | | -| | | - CommonEventForm | -| | | at_Vendors | -| | | schema only: | -| | | codesInUse: | -| | | changed | -| | | required | -| | | field from | -| | | "codecUtiliz | -| | | ation" | -| | | which was | -| | | removed | -| | | previously | -| | | to | -| | | "numberInUse | -| | | " | -| | | which is the | -| | | new field | -| | | name. | -| | | | -| | | - added | -| | | ‘codecSelect | -| | | ed’ | -| | | datatype | -| | | | -| | | - added | -| | | ‘codecSelect | -| | | edTranscoding’ | -| | | datatype | -| | | | -| | | - Section 4 and | -| | | section 6: | -| | | command | -| | | processing: | -| | | | -| | | - Added | -| | | commandListE | -| | | ntry | -| | | which is an | -| | | object that | -| | | references | -| | | the command | -| | | object. | -| | | | -| | | - commandList: | -| | | changed | -| | | commandList | -| | | to contain | -| | | an array of | -| | | commandListE | -| | | ntry | -| | | objects. | -| | | | -| | | - Updated sample | -| | | responses in | -| | | section 6 | -| | | where | -| | | commands are | -| | | used | -| | | | -| | | - Section 4: | -| | | commonEventHead | -| | | er: | -| | | | -| | | - Incremented | -| | | version to | -| | | 1.2 | -| | | | -| | | - added two new | -| | | values to | -| | | the ‘domain’ | -| | | enumeration: | -| | | ‘serviceEven | -| | | ts’ | -| | | and | -| | | ‘signaling | -| | | | -| | | - Section 4: added | -| | | endOfCallVqmSum | -| | | maries | -| | | datatype | -| | | | -| | | - Section 4: | -| | | ‘event’: added | -| | | two fields: | -| | | ‘serviceEventsF | -| | | ields’ | -| | | and | -| | | ‘signalingField | -| | | s’ | -| | | | -| | | - Section 4: added | -| | | ‘eventInstanceI | -| | | dentifier’datatype | -| | | | -| | | - Section 4: | -| | | CommonEventList | -| | | ener | -| | | only: | -| | | internalHeaderF | -| | | ields: | -| | | | -| | | - added | -| | | ‘internalHea | -| | | derFieldsVersion’(ini | -| | | tially | -| | | set to 1.1) | -| | | | -| | | - added | -| | | ‘correlation | -| | | FirstEpoch’ | -| | | | -| | | - added | -| | | 'closedLoopC | -| | | ontrolName' | -| | | | -| | | - added | -| | | 'closedLoopF | -| | | lag' | -| | | | -| | | - added | -| | | 'collectorTi | -| | | meStamp' | -| | | | -| | | - added | -| | | 'eventTag' | -| | | | -| | | - added | -| | | ‘tenantName’ | -| | | | -| | | - changed | -| | | 'operational | -| | | Status' | -| | | to 'inMaint' | -| | | | -| | | - added required | -| | | fields in | -| | | the schema | -| | | to match the | -| | | word doc: | -| | | 'equipmentNa | -| | | meCode', | -| | | 'equipmentTy | -| | | pe', | -| | | 'equipmentVe | -| | | ndor', | -| | | 'inMaint', | -| | | 'provStatus' | -| | | | -| | | - Section 4: added | -| | | ‘marker’datatyp | -| | | e | -| | | | -| | | - Section 4: added | -| | | ‘midCallRtcp’ | -| | | datatype | -| | | | -| | | - Section 4: | -| | | mobileFlowField | -| | | s: | -| | | | -| | | - added | -| | | ‘mobileFlowF | -| | | ieldsVersion’(initial | -| | | ly | -| | | set to 1.1) | -| | | | -| | | - Section 4: added | -| | | ‘serviceEventsF | -| | | ields’datatype | -| | | | -| | | - Section 4: added | -| | | ‘signalingField | -| | | s’ | -| | | datatype | -| | | | -| | | - Section 4: | -| | | syslogFields: | -| | | | -| | | - Incremented | -| | | syslogFields | -| | | Version | -| | | to 1.2 | -| | | | -| | | - added | -| | | 'syslogPri' | -| | | | -| | | - added | -| | | 'syslogSev' | -| | | | -| | | - added | -| | | ‘syslogSdId’ | -| | | | -| | | - Section 4: | -| | | thresholdCrossi | -| | | ngAlertFields: | -| | | | -| | | - Incremented | -| | | thresholdCro | -| | | ssingFieldsVersion | -| | | to 1.2 | -| | | | -| | | - added | -| | | 'additionalF | -| | | ields' | -| | | which is an | -| | | optional | -| | | list of name | -| | | value pairs. | -| | | | -| | | - Section 4: schema | -| | | v26.0 embedded | -| | | reflecting the | -| | | above changes. | -| | | | -| | | - Section 6 and | -| | | Section 2: | -| | | changed all | -| | | sample requests | -| | | to use /v3 in | -| | | the REST | -| | | Resource URL. | -+-----------------------+-----------------------+-----------------------+ -| 12/1/2016 | v3.1 | - Section 6: Updated | -| | | the call flow | -| | | diagrams to | -| | | show ‘v3’ | -+-----------------------+-----------------------+-----------------------+ -| 1/5/2017 | v4.0 | - Combined the | -| | | Generic Event | -| | | Listener and | -| | | Vendor Event | -| | | Listener into a | -| | | single API | -| | | service | -| | | specification | -| | | with version | -| | | 4.0. | -| | | | -| | | - Changed the title | -| | | to VES (Virtual | -| | | Function Event | -| | | Streaming) | -| | | Listener. | -| | | | -| | | - Changed references | -| | | to 'generic | -| | | event' to | -| | | 'common event' | -| | | or 'VES event' | -| | | (depending on | -| | | the context) | -| | | throughout the | -| | | document. | -| | | | -| | | - Used the Legal | -| | | Disclaimer from | -| | | the Vendor | -| | | Event Listener | -| | | on the back of | -| | | the title page. | -| | | | -| | | - Section 1: | -| | | Introduction | -| | | changes: | -| | | | -| | | - modified | -| | | wording to | -| | | reference | -| | | 'VES' | -| | | | -| | | - removed the | -| | | 'Audience' | -| | | section, | -| | | which | -| | | described | -| | | various AT&T | -| | | groups the | -| | | documented | -| | | was intended | -| | | for | -| | | | -| | | - tweaked the | -| | | naming | -| | | standards | -| | | for event | -| | | types to | -| | | clarify the | -| | | purpose of | -| | | the naming | -| | | conventions | -| | | | -| | | - Section 3: | -| | | Resource | -| | | Structure: | -| | | added a | -| | | sentence | -| | | describing the | -| | | FQDN and port | -| | | used in the | -| | | resource URL. | -| | | | -| | | - Section 4: Common | -| | | Event Format | -| | | changes: | -| | | | -| | | - renamed the | -| | | section to | -| | | 'Common | -| | | Event | -| | | Format' from | -| | | 'Generic | -| | | Event | -| | | Format' | -| | | | -| | | - reorganized the | -| | | datatypes | -| | | into | -| | | separate | -| | | sections; | -| | | sections | -| | | were defined | -| | | for each of | -| | | the domains | -| | | as well as | -| | | for common | -| | | event, | -| | | common event | -| | | header and | -| | | command list | -| | | processing | -| | | | -| | | - codecSelected | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - codecSelectedTr | -| | | anscoding | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - command | -| | | datatype: | -| | | added an | -| | | enumerated | -| | | value to | -| | | commandType: | -| | | 'heartbeatIn | -| | | tervalChange' | -| | | | -| | | - commonEventHead | -| | | er: | -| | | added | -| | | internalHead | -| | | erFields | -| | | to the | -| | | commonEventH | -| | | eader, | -| | | defined as | -| | | "Fields (not | -| | | supplied by | -| | | event | -| | | sources) | -| | | that the VES | -| | | Event | -| | | Listener | -| | | service can | -| | | use to | -| | | enrich the | -| | | event if | -| | | needed for | -| | | efficient | -| | | internal | -| | | processing. | -| | | This is an | -| | | empty object | -| | | which is | -| | | intended to | -| | | be defined | -| | | separately | -| | | by each | -| | | provider | -| | | implementing | -| | | the VES | -| | | Event | -| | | Listener." | -| | | | -| | | - commonEventHead | -| | | er: | -| | | removed two | -| | | enumerated | -| | | values, | -| | | 'serviceEven | -| | | ts' | -| | | and | -| | | 'signaling' | -| | | from the | -| | | domain | -| | | enumeration | -| | | | -| | | - commonEventHead | -| | | er | -| | | version: | -| | | incremented | -| | | the version | -| | | to 2.0 | -| | | | -| | | - endOfCallVqmSum | -| | | maries | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - event: changed | -| | | the | -| | | description | -| | | of the event | -| | | datatype to: | -| | | "fields | -| | | which | -| | | constitute | -| | | the ‘root | -| | | level’ of | -| | | the common | -| | | event | -| | | format" | -| | | | -| | | - event: removed | -| | | 'serviceEven | -| | | tFields' | -| | | and | -| | | 'signalingFi | -| | | elds' | -| | | from the | -| | | definition | -| | | | -| | | - event: fixed a | -| | | misspelling | -| | | of | -| | | ‘thresholdCr | -| | | ossingAlertFields’, | -| | | which was | -| | | only present | -| | | in the Word | -| | | document | -| | | | -| | | - eventInstanceId | -| | | entifier | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - internalHeaderF | -| | | Ields | -| | | datatype: | -| | | defined this | -| | | as follows: | -| | | "The | -| | | internalHead | -| | | erFields | -| | | datatype is | -| | | an undefined | -| | | object which | -| | | can contain | -| | | arbitrarily | -| | | complex JSON | -| | | structures. | -| | | It is | -| | | intended to | -| | | be defined | -| | | separately | -| | | by each | -| | | provider | -| | | implementing | -| | | the VES | -| | | Event | -| | | Listener. | -| | | The fields | -| | | in | -| | | internalHead | -| | | erFields | -| | | are not | -| | | provided by | -| | | any event | -| | | source but | -| | | instead are | -| | | added by the | -| | | VES Event | -| | | Listener | -| | | service | -| | | itself as | -| | | part of an | -| | | event | -| | | enrichment | -| | | process | -| | | necessary | -| | | for | -| | | efficient | -| | | internal | -| | | processing | -| | | of events | -| | | received by | -| | | the VES | -| | | Event | -| | | Listener" | -| | | | -| | | - marker | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - measurementsFor | -| | | VfScalingFields | -| | | datatype: | -| | | clarified | -| | | that | -| | | memoryConfig | -| | | ured | -| | | and | -| | | memoryUsed | -| | | are measured | -| | | in MB | -| | | | -| | | - midCallRtcp | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - mobileFlowField | -| | | s | -| | | datatype: | -| | | added | -| | | ‘additionalF | -| | | ields’ | -| | | | -| | | - mobileFlowField | -| | | s | -| | | datatype: | -| | | incremented | -| | | the version | -| | | number for | -| | | this field | -| | | block to 1.2 | -| | | | -| | | - serviceEventsFi | -| | | elds | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - signalingFields | -| | | datatype: | -| | | removed this | -| | | datatype | -| | | | -| | | - syslogFields: | -| | | added three | -| | | fields to | -| | | the schema | -| | | that were | -| | | previously | -| | | described in | -| | | the document | -| | | but not | -| | | incorporated | -| | | into the | -| | | schema: | -| | | syslogPri, | -| | | syslogSev, | -| | | syslogSdId | -| | | | -| | | - syslogFields | -| | | version: | -| | | incremented | -| | | the version | -| | | to 2.0 | -| | | | -| | | - Modified the | -| | | Common Event | -| | | Format JSON | -| | | schema to v27.0 | -| | | to incorporate | -| | | the above | -| | | changes. Also, | -| | | added the AT&T | -| | | Copyright | -| | | Notice from the | -| | | top of the | -| | | retired | -| | | CommonEventForm | -| | | at_Vendors | -| | | schema. | -| | | | -| | | - Section 6 and 2: | -| | | changed all | -| | | sample requests | -| | | to use /v4 in | -| | | the REST | -| | | Resource URL | -| | | and call flow | -| | | diagrams. | -| | | | -| | | - Section 6.1.3: | -| | | added a row to the | -| | | table in this | -| | | section describing | -| | | the | -| | | ‘heartbeatInterval | -| | | Change’ | -| | | command. | -| | | | -| | | - Section 6.1.4: | -| | | added this new | -| | | section describing | -| | | expectations for | -| | | buffering of | -| | | events should all | -| | | REST resource URL | -| | | FQDNs be | -| | | unreachable. | -| | | | -| | | - Section 6 Sample | -| | | Requests: modified | -| | | all sample | -| | | requests showing | -| | | the return of a | -| | | commandList toward | -| | | the event source | -| | | to incorporate a | -| | | heartbeatIntervalC | -| | | hange | -| | | command; also | -| | | corrected the | -| | | spelling in the | -| | | samples for the | -| | | measurementInterva | -| | | lChange | -| | | command. | -| | | | -| | | - Section 7: | -| | | Contributors: | -| | | removed this | -| | | section | -+-----------------------+-----------------------+-----------------------+ -| 3/21/2017 | v4.1 | - JSON Schema | -| | | changes to produce | -| | | v27.2 (note: an | -| | | earlier draft | -| | | version of v27.1 | -| | | had been | -| | | distributed to a | -| | | few individuals): | -| | | | -| | | - To support use | -| | | of the schema | -| | | with event | -| | | batches, | -| | | removed the | -| | | following | -| | | statement near | -| | | the end of the | -| | | schema file: | -| | | | -| | | .. | -| | | | -| | | “required”: [ | -| | | “event” ] | -| | | | -| | | - Fixed the | -| | | characters used in | -| | | some of the quotes | -| | | | -| | | - Fixed some typos | -| | | in the | -| | | descriptions. | -| | | | -| | | - Removed the | -| | | booleans, which | -| | | were non-essential | -| | | and which were | -| | | causing problems | -| | | across different | -| | | implementations. | -| | | | -| | | - Section 4.5.7 | -| | | measurementsFor | -| | | VfScalingFields: | -| | | | -| | | - Fixed the | -| | | spelling of | -| | | measurements | -| | | ForVfScalingFields | -| | | in the Word | -| | | document | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses: | -| | | | -| | | - Removed quotes | -| | | from | -| | | numbers: | -| | | sequence, | -| | | and | -| | | first/lastEp | -| | | ochMicrosec. | -| | | | -| | | - Fixed all quote | -| | | characters, | -| | | some of | -| | | which were | -| | | using | -| | | unusual | -| | | symbols that | -| | | wouldn’t | -| | | validate | -| | | with the | -| | | json-schema | -| | | Python | -| | | package. | -| | | | -| | | - Section 6.2.6.1, | -| | | 6.3.6.1, | -| | | 6.4.6.1 sample | -| | | requests: | -| | | | -| | | - Added an | -| | | alarmAdditio | -| | | nalInformation | -| | | field array | -| | | to the | -| | | sample | -| | | requests. | -| | | | -| | | - Added missing | -| | | commas. | -| | | | -| | | - Section 6.5.6.1 | -| | | provideThrottli | -| | | ngState | -| | | sample | -| | | requests: | -| | | | -| | | - Fixed the | -| | | eventDomainT | -| | | hrottleSpecificationL | -| | | ist | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | eventDomainT | -| | | hrottleSpecification | -| | | objects. | -| | | | -| | | - Added missing | -| | | quotes. | -| | | | -| | | - Fixed the | -| | | suppressedNvPai | -| | | rsList | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | suppressedNvPai | -| | | rs | -| | | objects. | -+-----------------------+-----------------------+-----------------------+ -| 4/14/2017 | v5.0 | - Section 1 | -| | | Introduction: | -| | | | -| | | - Clarified the | -| | | Introduction | -| | | (Section 1). | -| | | | -| | | - Changed Section | -| | | 1.1 title from | -| | | ‘Terminology’ | -| | | to 'Event | -| | | Registration' | -| | | and referenced | -| | | the YAML event | -| | | registration | -| | | format, defined | -| | | in a separate | -| | | document. | -| | | | -| | | - Clarified | -| | | naming | -| | | standards for | -| | | eventName. | -| | | | -| | | - Section 3: updated | -| | | the REST | -| | | resource | -| | | structure | -| | | | -| | | - Section 4.1 | -| | | command list | -| | | processing | -| | | datatypes: | -| | | | -| | | - Got rid of | -| | | commandListE | -| | | ntry | -| | | and returned | -| | | commandList | -| | | to a simple | -| | | array of | -| | | commands. | -| | | | -| | | - Added | -| | | heartbeatInt | -| | | erval | -| | | to the | -| | | command | -| | | datatype. | -| | | | -| | | - Changed the | -| | | datatype of | -| | | measurementI | -| | | nterval | -| | | from number | -| | | to integer. | -| | | | -| | | - Section 4.2 common | -| | | event | -| | | datatypes: | -| | | | -| | | - event dataType: | -| | | Added | -| | | heartbeatFie | -| | | lds, | -| | | sipSignaling | -| | | Fields | -| | | and | -| | | voiceQuality | -| | | Fields | -| | | to the event | -| | | datatype as | -| | | optional | -| | | field blocks | -| | | | -| | | - Added | -| | | jsonObject | -| | | which | -| | | provides a | -| | | json object | -| | | schema, name | -| | | and other | -| | | meta-informa | -| | | tion | -| | | along with | -| | | one or more | -| | | object | -| | | instances. | -| | | | -| | | - Added | -| | | jsonObjectIn | -| | | stance | -| | | which | -| | | provides | -| | | meta-informa | -| | | tion | -| | | about an | -| | | instance of | -| | | a jsonObject | -| | | along with | -| | | the actual | -| | | object | -| | | instance | -| | | | -| | | - Added the ‘key’ | -| | | datatype | -| | | | -| | | - Added the | -| | | namedArrayOf | -| | | Fields | -| | | datatype | -| | | | -| | | - Added | -| | | vendorVnfNam | -| | | eFields | -| | | | -| | | - Section 4.3 common | -| | | event header | -| | | fields: | -| | | | -| | | - Add two new | -| | | enumerations | -| | | to domain: | -| | | ‘sipSignalin | -| | | g’ | -| | | and | -| | | ‘voiceQualit | -| | | y’ | -| | | | -| | | - Renamed | -| | | eventType to | -| | | eventName. | -| | | Note that | -| | | the original | -| | | usage of | -| | | eventType | -| | | was formally | -| | | described in | -| | | the | -| | | Introduction | -| | | back on | -| | | 2/11/2016 | -| | | with v1.9. | -| | | | -| | | - Made eventName | -| | | a required | -| | | field | -| | | | -| | | - Created a new | -| | | field called | -| | | eventType | -| | | with a | -| | | meaning that | -| | | is different | -| | | than the old | -| | | eventType. | -| | | | -| | | - Removed | -| | | functionalRo | -| | | le, | -| | | which was | -| | | replaced by | -| | | the | -| | | following | -| | | two fields. | -| | | | -| | | - Added | -| | | nfNamingCode | -| | | | -| | | - Added | -| | | nfcNamingCod | -| | | e | -| | | | -| | | - Changed version | -| | | to 3.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field | -| | | | -| | | - Section 4.4: | -| | | faultFields: | -| | | | -| | | - added one | -| | | optional | -| | | field: | -| | | eventCategor | -| | | y | -| | | | -| | | - made | -| | | faultFieldsV | -| | | ersion | -| | | a required | -| | | field | -| | | | -| | | - changed | -| | | faultFieldsV | -| | | ersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change) | -| | | | -| | | - fixed a typo on | -| | | the spelling | -| | | of | -| | | alarmInterfa | -| | | ceA | -| | | | -| | | - clarified field | -| | | descriptions | -| | | | -| | | - Section 4.5: added | -| | | heartbeatFields | -| | | datatype which | -| | | can be used to | -| | | communicate | -| | | heartbeatInterv | -| | | al. | -| | | Note: this | -| | | change was | -| | | previously made | -| | | in v4.2 | -| | | | -| | | - Section 4.6 | -| | | measurements | -| | | for vf scaling | -| | | datatypes: | -| | | changed the | -| | | following | -| | | datatypes from | -| | | number to | -| | | integer: | -| | | | -| | | - In | -| | | measurements | -| | | ForVfScalingFields: | -| | | concurrentSe | -| | | ssions, | -| | | configuredEn | -| | | tities, | -| | | numberOfMedi | -| | | aPortsInUse, | -| | | vnfcScalingM | -| | | etric | -| | | | -| | | - In codecsInUse: | -| | | numberInUse | -| | | | -| | | - In | -| | | featuresInUs | -| | | e: | -| | | featureUtili | -| | | zation | -| | | | -| | | - Section 4.6.2 | -| | | modified | -| | | cpuUsage | -| | | | -| | | - Section 4.6.3 | -| | | added diskUsage | -| | | | -| | | - Section 4.6.7 | -| | | measurementsFor | -| | | VfScalingFields: | -| | | | -| | | - fixed the | -| | | spelling of | -| | | the | -| | | measurements | -| | | ForVfScalingFields | -| | | in the Word | -| | | document | -| | | | -| | | - added | -| | | additionalFi | -| | | elds, | -| | | which is an | -| | | array of | -| | | fields | -| | | (i.e., | -| | | name-value | -| | | pairs) | -| | | | -| | | - changed | -| | | additionalMe | -| | | asurements | -| | | to reference | -| | | the common | -| | | datatype | -| | | namedArrayOf | -| | | Fields | -| | | (instead of | -| | | referencing | -| | | measurementG | -| | | roup) | -| | | | -| | | - added | -| | | additionalOb | -| | | jects | -| | | which is an | -| | | array of | -| | | jsonObjects | -| | | described by | -| | | name, keys | -| | | and schema | -| | | | -| | | - deleted | -| | | aggregateCpu | -| | | Usage | -| | | | -| | | - added | -| | | diskUsageArr | -| | | ay | -| | | | -| | | - deleted | -| | | measurementG | -| | | roup | -| | | (which was | -| | | replaced by | -| | | the common | -| | | datatype: | -| | | namedArrayOf | -| | | Fields | -| | | | -| | | - added | -| | | memoryUsageA | -| | | rray | -| | | | -| | | - deleted | -| | | memoryConfig | -| | | ured | -| | | and | -| | | memoryUsed | -| | | | -| | | - deleted errors | -| | | and | -| | | vNicUsageArr | -| | | ay | -| | | | -| | | - added | -| | | vNicPerforma | -| | | nceArray | -| | | | -| | | - changed the | -| | | measurements | -| | | ForVfScalingVersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field. Also | -| | | changed the | -| | | name of this | -| | | version | -| | | field in the | -| | | Word | -| | | document to | -| | | match that | -| | | in the JSON | -| | | schema. | -| | | | -| | | - Section 4.6.8 | -| | | added | -| | | memoryUsage | -| | | | -| | | - Section 4.6.9 | -| | | vNicPerformance | -| | | : | -| | | replaced | -| | | vNicUsage and | -| | | errors with | -| | | vNicPerformance | -| | | | -| | | - Section 4.7 mobile | -| | | flow fields | -| | | changes: | -| | | | -| | | - Made | -| | | mobileFlowFi | -| | | eldsVersion | -| | | a required | -| | | field and | -| | | changed the | -| | | mobileFlowFi | -| | | eldsVersion | -| | | to 2.0 | -| | | (major | -| | | version | -| | | change). | -| | | | -| | | - Changed the | -| | | datatype of | -| | | flowActivati | -| | | onTime | -| | | and | -| | | flowDeactiva | -| | | tionTime | -| | | in the Word | -| | | doc to | -| | | string. | -| | | | -| | | - changed the | -| | | following | -| | | datatypes | -| | | from number | -| | | to integer: | -| | | otherEndpoin | -| | | tPort, | -| | | reportingEnd | -| | | pointPort, | -| | | samplingAlgo | -| | | rithm | -| | | | -| | | - Section 4.8: | -| | | otherFields: | -| | | | -| | | - Added | -| | | otherFieldsV | -| | | ersion | -| | | (set at 1.1) | -| | | | -| | | - Added | -| | | hashOfNameVa | -| | | luePairArrays | -| | | | -| | | - Added | -| | | jsonObjects | -| | | | -| | | - Added | -| | | nameValuePai | -| | | rs | -| | | | -| | | - Section 4.9: added | -| | | sipSignaling | -| | | domain | -| | | datatypes with | -| | | 4.8.1 | -| | | sipSignalingFie | -| | | lds. | -| | | sipSignalingFie | -| | | ldsVersion | -| | | is set at 1.0 | -| | | | -| | | - Section 4.10 | -| | | stateChangeFiel | -| | | ds: | -| | | made | -| | | stateChangeFiel | -| | | dsVersion | -| | | a required | -| | | field and set | -| | | it to 2.0 | -| | | (major version | -| | | change). | -| | | | -| | | - Section 4.11 | -| | | syslogFields: | -| | | | -| | | - Changed the | -| | | following | -| | | datatypes | -| | | from number | -| | | to integer: | -| | | syslogFacili | -| | | ty, | -| | | syslogPri | -| | | | -| | | - Changed | -| | | additionalFi | -| | | elds | -| | | from a field | -| | | [ ] to a | -| | | string which | -| | | takes | -| | | name=value | -| | | pairs | -| | | delimited by | -| | | a pipe | -| | | symbol. | -| | | | -| | | - Changed | -| | | syslogFields | -| | | Version | -| | | to 3.0 | -| | | (major | -| | | version | -| | | change) and | -| | | made it a | -| | | required | -| | | field | -| | | | -| | | - Made syslogSev | -| | | an | -| | | enumerated | -| | | string | -| | | (previously | -| | | just a | -| | | string) | -| | | | -| | | - Section 4.12 | -| | | thresholdCrossi | -| | | ngAlertFields: | -| | | made | -| | | thresholdCrossi | -| | | ngFieldsVersion | -| | | a required | -| | | field and set | -| | | it to 2.0 | -| | | (major version | -| | | change). | -| | | | -| | | - Section 4.132: | -| | | added voice | -| | | quality domain | -| | | datatypes with | -| | | 4.13.1 | -| | | endOfCallVqmSum | -| | | maries | -| | | and 4.13.2 | -| | | voiceQualityFie | -| | | lds. | -| | | voiceQualityFie | -| | | ldsVersion | -| | | is set at 1.0 | -| | | | -| | | - JSON Schema: | -| | | changed the schema | -| | | to v28.0 and | -| | | incorporated all | -| | | of the changes | -| | | above. | -| | | | -| | | - Additional JSON | -| | | Schema changes | -| | | that are part of | -| | | v28: Note: The | -| | | following changes | -| | | are provided | -| | | relative to API | -| | | Spec v4.0 (which | -| | | embedded JSON | -| | | schema v27.0), but | -| | | they were also | -| | | made in an interim | -| | | release v4.1 | -| | | (which embedded | -| | | JSON schema | -| | | v27.2): | -| | | | -| | | - To support use | -| | | of the schema | -| | | with event | -| | | batches, | -| | | removed the | -| | | following | -| | | statement near | -| | | the end of the | -| | | schema file: | -| | | | -| | | .. | -| | | | -| | | “required”: [ | -| | | “event” ] | -| | | | -| | | - Fixed the | -| | | characters used in | -| | | some of the quotes | -| | | | -| | | - Fixed some typos | -| | | in the | -| | | descriptions. | -| | | | -| | | - Removed the | -| | | booleans, which | -| | | were non-essential | -| | | and which were | -| | | causing problems | -| | | across different | -| | | implementations. | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses | -| | | (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Removed quotes | -| | | from | -| | | numbers: | -| | | sequence, | -| | | and | -| | | first/lastEp | -| | | ochMicrosec. | -| | | | -| | | - Fixed all quote | -| | | characters, | -| | | some of | -| | | which were | -| | | using | -| | | unusual | -| | | symbols that | -| | | wouldn’t | -| | | validate | -| | | with the | -| | | json-schema | -| | | Python | -| | | package. | -| | | | -| | | - Section 2 and 6 | -| | | sample requests | -| | | and responses | -| | | (only in v5.0): | -| | | | -| | | - Changed the | -| | | version | -| | | numbers in | -| | | the URL | -| | | string. | -| | | | -| | | - Added | -| | | nfNamingCode | -| | | and | -| | | nfcNamingCod | -| | | e | -| | | and removed | -| | | functionalRo | -| | | le | -| | | | -| | | - Section 6 call | -| | | flows: updated | -| | | the version | -| | | number (only in | -| | | v5.0). | -| | | | -| | | - Section 6: removed | -| | | the | -| | | publishSpecific | -| | | Topic | -| | | operation | -| | | | -| | | - Section 6.1.4: | -| | | Buffering: | -| | | clarified event | -| | | source | -| | | expectations | -| | | for buffering | -| | | (only in v5.0). | -| | | | -| | | - Section 6.2.6.1, | -| | | 6.3.6.1 sample | -| | | requests (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Added an | -| | | alarmAdditio | -| | | nalInformation | -| | | field array | -| | | to the | -| | | sample | -| | | requests. | -| | | | -| | | - Added missing | -| | | commas. | -| | | | -| | | - Section 6.2.6.3, | -| | | 6.3.6.3 | -| | | commandList | -| | | sample | -| | | responses (only | -| | | in v5.0): | -| | | | -| | | - Fixed the | -| | | commandList | -| | | sample | -| | | responses to | -| | | pass an | -| | | array of | -| | | anonymous | -| | | command | -| | | objects | -| | | (rather than | -| | | an array of | -| | | commandListE | -| | | ntry | -| | | objects). | -| | | | -| | | - Fixed the | -| | | heartbeatInt | -| | | ervalChange | -| | | commandType | -| | | to pass a | -| | | heartbeatInt | -| | | erval | -| | | value | -| | | instead of a | -| | | measurementI | -| | | nterval | -| | | value. | -| | | | -| | | - Removed quotes | -| | | from the | -| | | measurementI | -| | | nterval | -| | | and | -| | | heartbeatInt | -| | | erval | -| | | values since | -| | | they are | -| | | numbers. | -| | | | -| | | - Section 6.4.6.1 | -| | | provideThrottli | -| | | ngState | -| | | sample requests | -| | | (also | -| | | incorporated in | -| | | interim release | -| | | 4.1): | -| | | | -| | | - Fixed the | -| | | eventDomainT | -| | | hrottleSpecificationL | -| | | ist | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | eventDomainT | -| | | hrottleSpecification | -| | | objects. | -| | | | -| | | - Added missing | -| | | quotes. | -| | | | -| | | - Fixed the | -| | | suppressedNvPai | -| | | rsList | -| | | to pass an | -| | | array of | -| | | anonymous | -| | | suppressedNvPai | -| | | rs | -| | | objects (also | -| | | incorporated in | -| | | interim release | -| | | 4.1). | -+-----------------------+-----------------------+-----------------------+ -| 5/22/2017 | v5.1 | - Footers: removed | -| | | proprietary | -| | | markings and | -| | | updated copyrights | -| | | to 2017 | -| | | | -| | | - Section 4.2.3: | -| | | field: | -| | | | -| | | - Changed the API | -| | | spec to make | -| | | ‘name’ and | -| | | ‘value’ start | -| | | with lowercase | -| | | letters. Note: | -| | | this did not | -| | | affect the | -| | | schema, which | -| | | already had | -| | | them as | -| | | lowercase. | -| | | | -| | | - JSON Schema: | -| | | | -| | | - measurementGrou | -| | | p: | -| | | deleted this | -| | | object since it | -| | | was replaced | -| | | with | -| | | ‘namedArrayOfFi | -| | | elds’ | -| | | in v28.0 and | -| | | was no longer | -| | | being used. | -| | | | -| | | - namedArrayOfFie | -| | | lds: | -| | | Fixed an error | -| | | in the | -| | | specification | -| | | of required | -| | | fields: from | -| | | ‘measurements’ | -| | | to | -| | | ‘arrayOfFields’ | -| | | . | -| | | | -| | | - Changed the | -| | | version of the | -| | | JSON schema to | -| | | 28.1 | -+-----------------------+-----------------------+-----------------------+ -| 6/14/2017 | v5.2 | - JSON Schema: | -| | | created v28.2 by | -| | | changing the field | -| | | descriptions in | -| | | the memoryUsage | -| | | object to refer to | -| | | ‘kibibytes’ | -| | | instead of | -| | | ‘kilobytes’. There | -| | | were no changes to | -| | | the 28.1 | -| | | structure. | -| | | | -| | | - Word Document: | -| | | measurementsForVfS | -| | | caling | -| | | Domain: | -| | | memoryUsage | -| | | object: changed | -| | | the field | -| | | descriptions in | -| | | this object to | -| | | refer to | -| | | ‘kibibytes’ | -| | | instead of | -| | | ‘kilobytes’. There | -| | | were no changes to | -| | | the memoryUsage | -| | | structure. | -| | | | -| | | - Reorganized the | -| | | Word document to | -| | | group the data | -| | | structures in | -| | | Section 4 into | -| | | three broad | -| | | categories to | -| | | better align with | -| | | the VNF Guidelines | -| | | documentation that | -| | | has been prepared | -| | | for vendors: | -| | | | -| | | - Common Event | -| | | Datatypes: | -| | | | -| | | - Command List | -| | | Processing | -| | | Datatypes | -| | | | -| | | - Common Event | -| | | Datatypes | -| | | | -| | | - Common Event | -| | | Header | -| | | Datatypes | -| | | | -| | | - Technology | -| | | Independent | -| | | Datatypes: | -| | | | -| | | - ‘Fault | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Heartbeat’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Measurement | -| | | s | -| | | For Vf | -| | | Scaling’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Other’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘State | -| | | Change’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Syslog’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Threshold | -| | | Crossing | -| | | Alert’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - Technology | -| | | Specify | -| | | Datatypes: | -| | | | -| | | - ‘Mobile | -| | | Flow’ Domain | -| | | Datatypes | -| | | | -| | | - ‘Sip | -| | | Signaling’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - ‘Voice | -| | | Quality’ | -| | | Domain | -| | | Datatypes | -| | | | -| | | - Section 6.1.3: | -| | | Commands Toward | -| | | Event Source | -| | | Clients: Added a | -| | | statement: “Note: | -| | | Vendors are not | -| | | currently required | -| | | to implement | -| | | support for | -| | | command | -| | | processing; in | -| | | addition, command | -| | | processing may be | -| | | supported by an | -| | | App-C interface in | -| | | future.” | -+-----------------------+-----------------------+-----------------------+ -| 6/22/2017 | v5.3 | - JSON Schema: | -| | | created v28.3 by | -| | | correcting an | -| | | error in the | -| | | sipSignalingFields | -| | | : | -| | | changed | -| | | vnfVendorNameField | -| | | s | -| | | to | -| | | vendorVnfNameField | -| | | s. | -| | | Embedded the new | -| | | schema at the top | -| | | of section 4. | -+-----------------------+-----------------------+-----------------------+ -| 9/12/2017 | v5.4 | - Note: There no | -| | | changes to any | -| | | data structures or | -| | | operations in this | -| | | version. | -| | | | -| | | - JSON Schema: | -| | | created v28.4 | -| | | embedded at the | -| | | top of section 4: | -| | | | -| | | - Added a | -| | | reference to | -| | | eventList in | -| | | the properties | -| | | defined under | -| | | the schema | -| | | title. This | -| | | enables the | -| | | schema to | -| | | correctly | -| | | validate event | -| | | batches in | -| | | addition to | -| | | just events. | -| | | | -| | | - Moved the | -| | | schema title to | -| | | the top of the | -| | | schema and | -| | | changed the | -| | | text from | -| | | “Event | -| | | Listener” to | -| | | “VES Event | -| | | Listener” | -| | | | -| | | - Added a schema | -| | | header block | -| | | under the title | -| | | to clearly | -| | | communicate the | -| | | schema version, | -| | | associated API | -| | | and | -| | | last-modified | -| | | information | -| | | | -| | | - Changed the date | -| | | in the copyright | -| | | notice to 2017 | -+-----------------------+-----------------------+-----------------------+ -| 9/19/2017 | v5.4.1 | - Note: There no | -| | | changes to any | -| | | data structures or | -| | | operations in this | -| | | version. | -| | | | -| | | - Back of Cover | -| | | Page: updated the | -| | | license and | -| | | copyright notice | -| | | to comply with | -| | | ONAP guidelines | -| | | | -| | | - JSON Schema: | -| | | updated the JSON | -| | | schema to v28.4.1: | -| | | updated the | -| | | copyright notice | -| | | and license to | -| | | comply with ONAP | -| | | guidelines | -+-----------------------+-----------------------+-----------------------+ - -.. |image0| image:: media/image3.png - :width: 6.48926in - :height: 4.86694in -.. |image1| image:: media/image4.png - :width: 6.5in - :height: 4.8745in -.. |image2| image:: media/image5.png - :width: 3.76033in - :height: 1.16677in -.. |image3| image:: media/image7.png - :width: 4.75347in - :height: 2.57361in -.. |image4| image:: media/image8.png - :width: 4.74722in - :height: 2.56667in diff --git a/docs/files/ice-report.png b/docs/files/ice-report.png Binary files differdeleted file mode 100644 index 74f6e98..0000000 --- a/docs/files/ice-report.png +++ /dev/null diff --git a/docs/files/publish-event-flow.png b/docs/files/publish-event-flow.png Binary files differdeleted file mode 100644 index 3ae9c05..0000000 --- a/docs/files/publish-event-flow.png +++ /dev/null diff --git a/docs/files/rest-resource.png b/docs/files/rest-resource.png Binary files differdeleted file mode 100644 index ecfad9c..0000000 --- a/docs/files/rest-resource.png +++ /dev/null diff --git a/docs/files/ves-client-guidelines.rst b/docs/files/ves-client-guidelines.rst deleted file mode 100644 index ec92ffd..0000000 --- a/docs/files/ves-client-guidelines.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017-2018 Huawei Technologies Co., Ltd. - -VES Client Guidelines -===================== - - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - VES_Registraion_3_2.rst - ves7_1spec.rst - :download:`common event format json <files/CommonEventFormat_30.1_ONAP.json>` diff --git a/docs/files/ves-providethrottlingstate.png b/docs/files/ves-providethrottlingstate.png Binary files differdeleted file mode 100644 index d7081df..0000000 --- a/docs/files/ves-providethrottlingstate.png +++ /dev/null diff --git a/docs/files/ves-publishanyevent.png b/docs/files/ves-publishanyevent.png Binary files differdeleted file mode 100644 index c143079..0000000 --- a/docs/files/ves-publishanyevent.png +++ /dev/null diff --git a/docs/files/ves-publisheventbatch.png b/docs/files/ves-publisheventbatch.png Binary files differdeleted file mode 100644 index c0bbde7..0000000 --- a/docs/files/ves-publisheventbatch.png +++ /dev/null diff --git a/docs/files/ves-rest-resource-structure.png b/docs/files/ves-rest-resource-structure.png Binary files differdeleted file mode 100644 index df7674f..0000000 --- a/docs/files/ves-rest-resource-structure.png +++ /dev/null diff --git a/docs/files/ves7_1spec.rst b/docs/files/ves7_1spec.rst deleted file mode 100644 index fd4c7fd..0000000 --- a/docs/files/ves7_1spec.rst +++ /dev/null @@ -1,4515 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2017 AT&T Intellectual Property, All rights reserved
-.. Copyright 2017-2018 Huawei Technologies Co., Ltd.
-
-===============================
-Service: VES Event Listener 7.1
-===============================
-
-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Legal Disclaimer** |
-| |
-| 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 |
-| |
-| http://www.apache.org/licenses/LICENSE-2.0 |
-| |
-| 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. See the License for the specific language governing permissions and limitations under the License. |
-+=====================================================================================================================================================================================================================================================================================================================+
-+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-
-:Document: VES Event Listner
-:Revision: 7.1
-:Revision Date: December 10th, 2018
-:Author: Rich Erickson
-
-+-----------------+-----------------------------+
-| Contributors: | **Min Chen – AT&T** |
-| | |
-| | **Fred Delaplace - AT&T** |
-| | |
-| | **Andrew Egan – AT&T** |
-| | |
-| | **Alok Gupta – AT&T** |
-| | |
-| | **Marge Hillis – Nokia** |
-| | |
-| | **Gerard Hynes – AT&T** |
-| | |
-| | **Ken Kelly – AT&T** |
-| | |
-| | **Mark Scott – Ericsson** |
-| | |
-| | **Tim Verall – Intel** |
-| | |
-| | **Sumit Verdi – VMWare** |
-+-----------------+-----------------------------+
-
-.. contents:: Table of Contents
-Introduction
-============
-
-This document describes the RESTful interface for the VES Event
-Listener. The VES acronym originally stood for Virtual-function Event
-Streaming, but VES has been generalized to support network-function
-event streaming, whether virtualized or not. The VES Event Listener is
-capable of receiving any event sent in the VES Common Event Format. The
-Common Event Format is expressed in JSON schema in section 4 of this
-document. In the Common Event Format, an event consists of a required
-Common Event Header block (i.e., object) accompanied by zero or more
-event domain blocks.
-
-It should be understood that events are well structured packages of
-information, identified by an eventName, which are asynchronously
-communicated to subscribers who are interested in the eventName. Events
-can convey measurements, faults, syslogs, threshold crossing alerts and
-other types of information. Events are simply a way of communicating
-well-structured packages of information to one or more instances of an
-Event Listener service.
-
-This document describes a RESTful connectionless push event listener
-that is capable of receiving single events or batches of events in the
-Common Event Format. In future, additional documents may describe other
-transports which make use of persistent TCP connections for high volumes
-of streaming events.
-
-Event Registration
-------------------
-
-All events must be compliant with the common event format, but specific
-events identified by their eventNames, may require that certain fields,
-which are optional in the common event format, be present when they are
-published. For example, a specific eventName may require that specific
-name-value pairs be present in the extensible structures provided within
-the Common Event Format.
-
-Events are registered using an extensible YAML format (defined in a
-separate document), which specifies, for each eventName, the fields that
-are required, what field values may be sent, and any special handling
-that should be performed on those eventNames.
-
-Naming Standards for eventName
-------------------------------
-
-To prevent naming collisions, eventNames sent as part of the
-commonEventHeader, should conform to the following naming convention
-designed to summarize the purpose and type of the event, and to ensure
-the uniqueness of the eventName:
-
- {DomainAbbreviation}\_{PublisherName}\_{Description}
-
-Each underscore-separated subfield above must start with a capital
-letter and use camel-casing to separate words and acronyms. Acronyms
-must capitalize only the first letter of the acronym. Spaces and
-underscores should not appear within any subfield.
-
-The DomainAbbreviation subfield derives from the ‘domain’ field in the
-commonEventHeader, as specified below:
-
-- ‘Fault’ for the fault domain
-
-- ‘Heartbeat’ for the heartbeat domain
-
-- ‘Measurement’ for the measurement domain
-
-- ‘MobileFlow’ for the mobileFlow domain
-
-- ‘Notification’ for the notification domain
-
-- ‘Other’ for the other domain
-
-- ‘Perf3gpp’ for the perf3gpp domain
-
-- ‘PnfReg’ for the pnfRegistration domain
-
-- ‘SipSignaling’ for the sipSignaling domain
-
-- ‘StateChange’ for the stateChange domain
-
-- ‘Syslog’ for the syslog domain
-
-- ‘Tca’ for the thresholdCrossingAlert domain
-
-- ‘VoiceQuality’ for the voiceQuality domain
-
-The PublisherName subfield describes the vendor product or application
-publishing the event. This subfield conforms to the following
-conventions:
-
-- Vendor products are specified as:
-
- {productName}-{vendorName}
-
- For example: Visbc-Metaswitch or Vdbe-Juniper, where a hyphen is
- used to separate the productName and vendorName subfields. Note that
- the productName and vendorName subfields must not include hyphens
- themselves.
-
- Organizing the information in this way will cause an alphabetical
- listing of eventNames to sort similar network functions together,
- rather than to sort them by vendor.
-
- The productName subfield may describe a NF or a NFC. Where NFC names
- may be reused across different NF’s, they should be specified as:
-
- {NfName}:{NfcName}
-
- where a colon is used to separate the NfName and NfcName subfields.
- Note that the NfName and NfcName subfields must not include colons
- themselves.
-
- The ProductName may also describe other types of vendor modules or
- components such as a VM, application or hostname. As with NFs and
- NFCs, parent:child relationships may be communicated using colon as
- a subfield delimiter.
-
-- Service providers who adopt the VES Common Event Format for internal
- use, may provide PublisherName without the vendorName subfield. They
- would typically identify an application, system, service or
- microservice publishing the event (e.g., ‘Policy’, ‘So’,
- ‘MobileCallRecording’ or ‘Dkat’). As with NFs and NFCs, parent:child
- relationships may be communicated using colon as a subfield delimiter
- (e.g., ApplicationName:ApplicationComponent).
-
-The final subfield of the eventName name should describe, in a compact
-camel case format the specific information being conveyed by the event.
-In some cases, this final subfield may not be required (e.g., in the
-case of certain heartbeats).
-
-Examples of eventNames following the naming standards are provided
-below:
-
-- Tca\_Vdbe-Ericsson\_CpuThresholdExceeded
-
-- Heartbeat\_Visbc:Mmc-Metaswitch
-
-- Syslog\_Vdbe-Ericsson
-
-- Fault\_MobileCallRecording\_PilotNumberPoolExhaustion
-
-- Other\_So:WanBonding\_InstantiationPart1Complete
-
-EventId Use Cases Examples
---------------------------
-
-[Author: Alok Gupta]:
-
-eventId Examples:
-
-Example 1: assumes a unique key for each domain consisting of domain
-followed by an integer domainnnnnnn e.g. fault000001, heartbeat000001,
-mfvs000005
-
-Example 2: assumes an integer key for all events nnnnnnnnn: 000000001,
-00000002, 000000003
-
-Rules:
-
-1. All domains except Fault: each time a subsequent event is sent the
- integer part of eventId will increment by 1. Repeat of eventId
- assumes duplicate event. Sequence number is set to 0 for all domains
- except fault.
-
-2. eventId construction for Fault Events:
-
- a. Most likely scenario
-
- i. The sourceName on each Fault event is the NF Instance Name
- (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
- identifying this instance of the NF.
-
- ii. The eventId on Fault events is the same every time a given
- fault is raised (onset), re-raised at fixed time interval,
- until it is cleared. Once the fault is cleared, a new eventId
- is used.
-
- iii. The startEpochMicrosec value for the Fault event is the
- timestamp for when that event is generated until a clear is
- sent.
-
- iv. lastEpochMicrosec indicates the current event time.
-
- v. The sequence number for each Fault event is set to 1 when the
- event is first raised, and increments each time the same
- Fault event is raised, until a clear is sent.
-
- .. image:: Use-Case-1.png
-
- b. Alternative scenario: for vNF when fault event status is not
- maintained.
-
- i. The sourceName on each Fault event is the NF Instance Name
- (pnf-name or vnf-name or vm-name) as entered in A&AI uniquely
- identifying this instance of the NF.
-
- ii. The eventId on Fault events is the same every time a given
- fault is raised or cleared, even if it is re-raised after it
- had previously cleared. So, for example, if EMS loses
- contact with a particular device then a Fault event might be
- sent for a raise, re-raise (because EMS has re-tried and
- still can’t contact the device), clear (because EMS has
- re-tried and it can contact the device) and then raise again
- (because EMS has lost contact with the device again). The
- same eventId is used for all 4 of those Fault events.
-
- iii. The startEpochMicrosec value for each Fault event is the
- timestamp for when that event is generated, not when the
- fault first occurred. So all 4 of the Fault events in the
- previous bullet point would have a different timestamp.
-
- iv. lastEpochMicrosec indicates the current event time.
-
- v. The sequence number for each Fault event is currently set to
- 0 on a raise and 1 on a clear. We could change that so that
- each Fault event is given a new monotonically increasing
- sequence number whether it is a raise or a clear if that is
- helpful (which is reset to 0 if the VM restarts) but they
- won’t be consecutive.
-
- .. image:: Use-Case-2.png
-
-Measurement Expansion Fields
-----------------------------
-
-When expansion fields are used, the goal is to avoid custom development
-by the service provider collecting the fields, since custom development
-adds obvious cost, delay and resource overhead. In the domain of
-measurements, it is expected that a high percentage (perhaps as high as
-90 percent) of use cases for extensible fields can be satisfied by using
-the additionalMeasurements arrayOfNamedHashMap data structure in
-combination with a YAML registration file (provided at design time). The
-YAML registration file conveys meta-information about the processing of
-additionalMeasurements. For more information, please see the VES Event
-Registration specification and in particular the aggregationRole, castTo
-and isHomogeneous keywords.
-
-Syslogs
--------
-
-Syslog’s can be classified as either Control or Session/Traffic. They
-differ by message content and expected volume:
-
-- Control logs are generally free-form human-readable text used for
- reporting errors or warnings supporting the operation and
- troubleshooting of NFs. The volume of these logs is typically less
- than 2k per day.
-
-- Session logs use common structured fields to report normal NF
- processing such as DNS lookups or firewall rules processed. The
- volume of these logs is typically greater than 1k per hour (and
- sometimes as high as 10k per second).
-
-VES supports both classes of syslog, however VES is only recommended for
-control logs or for lower volume session logs, less than 60k per hour.
-High volume session logging should use a file-based transport solution.
-
-Support for Protocols Other Than HTTPS
---------------------------------------
-
-This API specification describes an HTTPS RESTful interface using the
-JSON content-type.
-
-Alternative API specifications may be provided in future using Google
-Protobuf, websockets, or Apache Avro.
-
-Versioning
-----------
-
-Three types of version numbers supported by this specification:
-
-- The API specification itself is versioned. Going forward, the major
- number of the specification version will be incremented whenever any
- change could break an existing client (e.g., a field name is deleted
- or changed). All other changes to the spec (e.g., a field name is
- added, or text changes are made to the specification itself) will
- increment only the minor number or patch number. Note that the major
- number appears in REST resource URLs as v# (where ‘#’ is the major
- number). Minor and patch numbers are communicated in HTTP headers.
- For more information, see the API Versioning writeup in section 6.1.
-
-- The JSON schema is versioned. Going forward, the major number of the
- JSON schema will be incremented whenever any change could break an
- existing client (e.g., a field name is deleted or changed). All other
- changes to the schema (e.g., a field name is added or text changes
- are made to the field descriptions) will increment only the minor
- number or patch number.
-
-- The field blocks are versioned. Field blocks include the
- commonEventHeader and the domain blocks (e.g., the faultFields
- block). Going forward, the major number of each field block will be
- incremented whenever any change to that block could break an existing
- client (e.g., a field name is deleted or changed). All other changes
- to that block (e.g., a field name is added or text changes are made
- to the field descriptions) will increment only the minor number.
-
-Field Block Versions
-~~~~~~~~~~~~~~~~~~~~
-
-A summary of the latest field block version enums as of this version of
-the API spec is provided below:
-
-- commonEventHeader version 4.1 (note: the enum with support 4.0,
- 4.0.1, 4.1 to avoid breaking clients of earlier versions of major
- version 4)
-
-- commonEventHeader vesEventListenerVersion enum: 7.1 (note: the enum
- will support 7.0, 7.0.1, 7.1 to avoid breaking clients of earlier
- versions of major version 7)
-
-- faultFieldsVersion:4.0
-
-- heartbeatFieldsVersion: 3.0
-
-- measurementFieldsVersion: 4.0
-
-- mobileFlowFieldsVersion: 4.0
-
-- notificationFieldsVersion: 2.0
-
-- otherFieldsVersion: 3.0
-
-- perf3gppFieldsVersion: 1.0
-
-- pnfRegistrationFieldsVersion: 2.0
-
-- sigSignalingFieldsVersion: 3.0
-
-- stateChangeFieldsVersion: 4.0
-
-- syslogFieldsVersion: 4.0
-
-- thresholdCrossingFieldsVersion: 4.0
-
-- voiceQualityFieldsVersion: 4.0
-
-Security
-========
-
-Event sources must identify themselves to the VES Event Listener.
-
-In the future, support for 2-way SSL certificate authentication (aka
-mutual SSL) may be provided (see the end of this Security section for
-additional information) otherwise, event source credentials must be
-passed using HTTP `Basic
-Authentication <http://tools.ietf.org/html/rfc2617>`__.
-
-Credentials must not be passed on the query string. Credentials must be
-sent in an Authorization header as follows:
-
-1. The username and password are formed into one string as
- “username:password”
-
-2. The resulting string is Base64 encoded to produce the encoded
- credential.
-
-3. The encoded credential is communicated in the header after the string
- “Authorization: Basic “
-
-Because the credentials are merely encoded but not encrypted, HTTPS
-(rather than HTTP) should be used. HTTPS will also encrypt and protect
-event contents. TLS 1.2 or higher must be used.
-
-Examples are provided below.
-
-Sample Request and Response
----------------------------
-
-Sample Request
-~~~~~~~~~~~~~~
-
-+-----------------------------------------------------------------+
-| POST /eventListener/v7 HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| | content-length: 12345 |
-| | { |
-| |
-| "event": { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "heartbeat", |
-| |
-| "eventName": "Heartbeat\_vIsbcMmc", |
-| |
-| "eventId": "heartbeat0000249", |
-| |
-| "sequence": 0, |
-| |
-| "priority": "Normal", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam001", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "ibcx0001vm002ssc001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "ibcx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------------------+
-
-Sample Success Response
-~~~~~~~~~~~~~~~~~~~~~~~
-
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 0 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
-
-Mutual SSL Certificate Authentication
--------------------------------------
-
-If service provider VES Event Listener support for Mutual SSL
-Certification Authentication is available, event sources must initialize
-the HTTPS connection with TLS 1.2 or higher and execute mutual
-authentication procedures according to
-`RFC5246 <https://tools.ietf.org/html/rfc5246#section-7.4.6>`__. If
-event source certificates cannot be verified or if certificate subject
-(identity) is unknown to the VES Event Listener, then HTTP Basic
-Authentication must be used as described above.
-
-Resource Structure
-==================
-
-REST resources are defined with respect to a ServerRoot:
-
-ServerRoot = /{optionalRoutingtPath}
-
-The resource structure is provided below:
-
-.. image:: rest-resource.png
-
-Figure – REST Resource Structure
-
-The {Domain} or FQDN above is typically provisioned into each
-eventsource when it is instantiated. The {Port} above is typically 8443.
-
-Common Event Format
-===================
-
-A JSON schema describing the Common Event Format is provided below and
-is reproduced in the tables that follow.
-
-:download:`JSON <CommonEventFormat_30.1_ONAP.json>`
-
-
-Note on optional fields:
-
- If the event publisher collects a field that is identified as
- optional in the data structures below, then the event publisher
- *must* send that field.
-
-Note on extensible fields:
-
- VES contains various extensible structures (e.g., hashMap) that
- enable event publishers to send information that has not been
- explicitly defined in VES data structures.
-
-- Event publishers *must not* send information through extensible
- structures where VES has explicitly defined fields for that
- information. For example, event publishers *must not* send
- information like cpuIdle, through an extensible structure, because
- VES has explicitly defined a cpuUsage.cpuIdle field for the
- communication of that information.
-
-- Keys sent through extensible fields must use camel casing to separate
- words and acronyms; only the first letter of each acronym shall be
- capitalized.
-
-Common Event Datatypes
-~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: arrayOfJsonObject
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The arrayOfJsonObject datatype provides an array of json objects, each
-of which is described by name, schema and other meta-information. It
-consists of the following fields:
-
-+---------------------+------------------+-------------+-----------------------+
-| Field | Type | Required? | Description |
-+=====================+==================+=============+=======================+
-| arrayOfJsonObject | jsonObject [ ] | Yes | Array of jsonObject |
-+---------------------+------------------+-------------+-----------------------+
-
-Datatype: arrayOfNamedHashMap
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The arrayOfNamedHashMap datatype provides an array of hashMaps, each of
-which is associated with a descriptive name. It consists of the
-following fields:
-
-+-----------------------+--------------------+-------------+-------------------------+
-| Field | Type | Required? | Description |
-+=======================+====================+=============+=========================+
-| arrayOfNamedHashMap | namedHashMap [ ] | Yes | Array of namedHashMap |
-+-----------------------+--------------------+-------------+-------------------------+
-
-Datatype: event
-^^^^^^^^^^^^^^^
-
-The event datatype consists of the following fields which constitute the
-‘root level’ of the common event format:
-
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| Field | Type | Required? | Description |
-+================================+================================+=============+======================================================+
-| commonEventHeader | commonEventHeader | Yes | Fields common to all events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| faultFields | faultFields | No | Fields specific to fault events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| heartbeatFields | heartbeatFields | No | Fields specific to heartbeat events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| measurementFields | measurementFields | No | Fields specific to measurement events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| mobileFlowFields | mobileFlowFields | No | Fields specific to mobility flow events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| notificationFields | notificationFields | No | Fields specific to notification events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| otherFields | otherFields | No | Fields specific to other types of events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| pnfRegistrationFields | pnfRegistrationFields | No | Fields specific to pnfRegistration events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| sipSignalingFields | sipSignalingFields | No | Fields specific to sipSignaling events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| stateChangeFields | stateChangeFields | No | Fields specific to state change events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| syslogFields | syslogFields | No | Fields specific to syslog events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| thresholdCrossingAlertFields | thresholdCrossingAlertFields | No | Fields specific to threshold crossing alert events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-| voiceQualityFields | voiceQualityFields | No | Fields specific to voiceQuality events |
-+--------------------------------+--------------------------------+-------------+------------------------------------------------------+
-
-Datatype: eventList
-^^^^^^^^^^^^^^^^^^^
-
-The eventList datatype consists of the following fields:
-
-+-------------+-------------+-------------+-------------------+
-| Field | Type | Required? | Description |
-+=============+=============+=============+===================+
-| eventList | event [ ] | Yes | Array of events |
-+-------------+-------------+-------------+-------------------+
-
-Datatype: hashMap
-^^^^^^^^^^^^^^^^^
-
-The hashMap datatype is an ‘associative array’, which is an unordered
-collection of key-value pairs of the form “key”: “value”, where each key
-and value are strings. Keys must use camel casing to separate words and
-acronyms; only the first letter of each acronym shall be capitalized.
-
-Datatype: jsonObject
-^^^^^^^^^^^^^^^^^^^^
-
-The jsonObject datatype provides a json object schema, name and other
-meta-information along with one or more object instances that conform to
-the schema:
-
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==========================+==========================+=============+===========================================================================================================================================================================+
-| objectInstances | JsonObjectInstance [ ] | Yes | Contains one or more instances of the json object |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| objectName | string | Yes | Name of the json object |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| objectSchema | string | No | json schema for the object |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| objectSchemaUrl | string | No | URL to the json schema for the object |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfSubscribedObjectName | string | No | Name of the object associated with the nfSubscriptionId |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfSubscriptionId | string | No | Identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject |
-+--------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: jsonObjectInstance
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The jsonObjectInstance datatype provides meta-information about an
-instance of a jsonObject along with the actual object instance:
-
-+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===============================+==============+=============+===========================================================================================================================================+
-| jsonObject | jsonObject | No | Optional recursive specification of jsonObject |
-+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| objectInstance | object | No | Contains an instance conforming to the jsonObject schema |
-+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| objectInstanceEpochMicrosec | number | No | the unix time, aka epoch time, associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds |
-+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-| objectKeys | key [ ] | No | An ordered set of keys that identifies this particular instance of jsonObject (e.g., that places it in a hierarchy) |
-+-------------------------------+--------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: key
-^^^^^^^^^^^^^
-
-The key datatype is a tuple which provides the name of a key along with
-its value and relative order; it consists of the following fields:
-
-+------------+-----------+-------------+----------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+============+===========+=============+======================================================================+
-| keyName | string | Yes | Name of the key |
-+------------+-----------+-------------+----------------------------------------------------------------------+
-| keyOrder | Integer | No | Relative sequence or order of the key (with respect to other keys) |
-+------------+-----------+-------------+----------------------------------------------------------------------+
-| keyValue | string | No | Value of the key |
-+------------+-----------+-------------+----------------------------------------------------------------------+
-
-Datatype: namedHashMap
-^^^^^^^^^^^^^^^^^^^^^^
-
-The namedHashMap datatype is a hashMap which is associated with and
-described by a name; it consists of the following fields:
-
-+-----------+-----------+-------------+--------------------------------------------------+
-| Field | Type | Required? | Description |
-+===========+===========+=============+==================================================+
-| name | string | Yes | Name associated with or describing the hashmap |
-+-----------+-----------+-------------+--------------------------------------------------+
-| hashMap | hashMap | Yes | One or more key:value pairs |
-+-----------+-----------+-------------+--------------------------------------------------+
-
-Datatype: requestError
-^^^^^^^^^^^^^^^^^^^^^^
-
-The requestError datatype defines the standard request error data
-structure:
-
-+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============+==========+=============+================================================================================================================================================================================================================================================================================================+
-| messageId | string | Yes | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception. Exception numbers may be in the range of 0001 to 9999 where 0001 to 2999 are defined by OMA (see section 5.1) and 3000-9999 are available and undefined. |
-+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| text | string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 |
-+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| url | string | No | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents |
-+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| variables | string | No | List of zero or more strings that represent the contents of the variables used by the message text |
-+-------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: vendorNfNameFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The vendorNfNameFields provides vendor, nf and nfModule identifying
-information:
-
-+----------------+----------+-------------+-----------------------------------------------------+
-| Field | Type | Required? | Description |
-+================+==========+=============+=====================================================+
-| vendorName | string | Yes | Network function vendor name |
-+----------------+----------+-------------+-----------------------------------------------------+
-| nfModuleName | string | No | Name of the nfModule generating the event |
-+----------------+----------+-------------+-----------------------------------------------------+
-| nfName | string | No | Name of the network function generating the event |
-+----------------+----------+-------------+-----------------------------------------------------+
-
-‘Common Event Header’ Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: commonEventHeader
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The commonEventHeader datatype consists of the following fields common
-to all events:
-
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | |
-+===========================+=========================+=============+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+
-| domain | string | Yes | Event domain enumeration: ‘fault’, ‘heartbeat’, ‘measurement’, ‘mobileFlow’, ‘notification’, ‘other’, ‘perf3gpp’, ‘pnfRegistration’, ‘sipSignaling’, ‘stateChange’, ‘syslog’, ‘thresholdCrossingAlert’, ‘voiceQuality’ |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventId | string | Yes | Event key that is unique to the event source. The key must be unique within notification life cycle similar to EventID from 3GPP. It could be a sequential number, or a composite key formed from the event fields, such as domain\_sequence. The eventId should not include whitespace. For fault events, eventId is the eventId of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, eventId must be the same as the initial alarm (along with the same startEpochMicrosec but with a different sequence number). Note: see section 1.3 for eventId use case examples. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventName | string | Yes | |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventType | string | No | |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| internalHeader Fields | internalHeader Fields | No | Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each service provider (e.g., AT&T) implementing the VES Event Listener. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| lastEpochMicrosec | number | Yes | 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 |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfcNamingCode | string | No | Network function component type: 3 characters (aligned with vfc naming standards) |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfNamingCode | string | No | Network function type: 4 characters (aligned with vnf and pnf naming standards) |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfVendorName | string | No | |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| priority | string | Yes | |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| reportingEntityId | string | No | UUID identifying the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. (Note: the AT&T internal enrichment process shall ensure that this field is populated). The reportingEntityId is an id for the reportingEntityName. See ‘reportingEntityName’ for more information. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| reportingEntityName | string | Yes | Name of the entity reporting the event or detecting a problem in another vnf/vm or pnf which is experiencing the problem. May be the same as the sourceName. For synthetic events generated by DCAE, it is the name of the app generating the event. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sequence | integer | Yes | Ordering of events communicated by an event source instance (or 0 if not needed) |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sourceId | string | No | UUID identifying the entity experiencing the event issue, which may be detected and reported by a separate reporting entity (note: the AT&T internal enrichment process shall ensure that this field is populated). The sourceId is an id for the sourceName. See ‘sourceName’ for more information. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sourceName | string | Yes | Name of the entity experiencing the event issue, which may be detected and reported by a separate reporting entity. The sourceName identifies the device for which data is collected. A valid sourceName must be inventoried in A&AI. If sourceName is a xNF (vnf or pnf), xNFC or VM, then the event must be reporting data for that particular xNF, xNFC or VM. If the sourceName is a xNF, comprised of multiple xNFCs, the data must be reported/aggregated at the xNF leveI. Data for individual xNFC must not be included in the xNF sourceName event. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| startEpochMicrosec | number | Yes | 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. For measurements and heartbeats, where events are collected over predefined intervals, startEpochMicrosec shall be rounded to the nearest interval boundary (e.g., the epoch equivalent of 3:00PM, 3:10PM, 3:20PM, etc…). For fault events, startEpochMicrosec is the timestamp of the initial alarm; if the same alarm is raised again for changed, acknowledged or cleared cases, startEpoch Microsec must be the same as the initial alarm (along with the same eventId and an incremental sequence number). For devices with no timing source (clock), the default value will be 0 and the VES collector will replace it with Collector time stamp (when the event is received) |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| timeZoneOffset | string | No | Offset to GMT to indicate local time zone for device formatted as ‘UTC+/-hh:mm’; see https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations for UTC offset examples |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| version | string | Yes | Version of the event header as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| vesEventListenerVersion | string | Yes | Version of the ves event listener api spec that this event is compliant with (as “#” or “#.#” or “#.#.#” where # is a digit; see section 1 for the correct digits to use). |
-+---------------------------+-------------------------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: internalHeaderFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The internalHeaderFields datatype is an undefined object which can
-contain arbitrarily complex JSON structures. It is intended to be
-defined separately by each service provider (e.g., AT&T) implementing
-the VES Event Listener. The fields in internalHeaderFields are not
-provided by any event source but instead are added by the VES Event
-Listener service itself as part of an event enrichment process necessary
-for efficient internal processing of events received by the VES Event
-Listener.
-
-Technology Independent Datatypes
---------------------------------
-
-‘Fault’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: faultFields
-^^^^^^^^^^^^^^^^^^^^^
-
-The faultFields datatype consists of the following fields:
-
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===============================+===========+=============+====================================================================================================================================================================================+
-| alarmAdditional Information | hashMap | No | Additional alarm information. |
-| | | | |
-| | | | - Note1: for SNMP mapping to VES, for hash key use OID of varbind, for value use incoming data for that varbind). |
-| | | | |
-| | | | - Note2: Alarm ID for 3GPP should be included (if applicable) in alarmAdditonalInformation as ‘alarmId’:’alarmIdValue’. |
-| | | | |
-| | | | Could contain managed object instance as separate key:value; could add probable cause as separate key:value. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| alarmCondition | string | Yes | Short name of the alarm condition/problem, such as a trap name. Should not have white space (e.g., tpLgCgiNotInConfig, BfdSessionDown, linkDown, etc…) |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| alarmInterfaceA | string | No | Card, port, channel or interface name of the device generating the alarm. This could reflect managed object. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventCategory | string | No | Event category, for example: ‘license’, ‘link’, ‘routing’, ‘security’, ‘signaling’ |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventSeverity | string | Yes | Event severity enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’. NORMAL is used to represent clear. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventSourceType | string | Yes | Examples: ‘card’, ‘host’, ‘other’, ‘port’, ‘portThreshold’, ‘router’, ‘slotThreshold’, ‘switch’, ‘virtualMachine’, ‘virtualNetworkFunction’. This could be managed object class. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| faultFieldsVersion | string | Yes | Version of the faultFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| specificProblem | string | Yes | Description of the alarm or problem (e.g., ‘eNodeB 155197 in PLMN 310-410 with eNodeB name KYL05197 is lost’). 3GPP probable cause would be included in this field. |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| vfStatus | string | Yes | Virtual function status enumeration: ‘Active’, ‘Idle’, ‘Preparing to terminate’, ‘Ready to terminate’, ‘Requesting Termination’ |
-+-------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Heartbeat’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: heartbeatFields
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The heartbeatFields datatype is an optional field block for fields
-specific to heartbeat events; it consists of the following fields:
-
-+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==========================+===========+=============+==================================================================================================================+
-| additionalFields | hashMap | No | Additional expansion fields if needed |
-+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
-| heartbeatFieldsVersion | string | Yes | Version of the heartbeatFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
-| heartbeatInterval | Integer | Yes | Current heartbeatInterval in seconds |
-+--------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------+
-
-‘Measurements’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Note: NFs are required to report exactly one Measurement event per
-period per sourceName.
-
-Datatype: codecsInUse
-^^^^^^^^^^^^^^^^^^^^^
-
-The codecsInUse datatype consists of the following fields describing the
-number of times an identified codec was used over the
-measurementInterval:
-
-+------------------+-----------+-------------+--------------------------------+
-| Field | Type | Required? | Description |
-+==================+===========+=============+================================+
-| codecIdentifer | string | Yes | Description of the codec |
-+------------------+-----------+-------------+--------------------------------+
-| numberInUse | integer | Yes | Number of such codecs in use |
-+------------------+-----------+-------------+--------------------------------+
-
-Datatype: cpuUsage
-^^^^^^^^^^^^^^^^^^
-
-The cpuUsage datatype defines the usage of an identifier CPU and
-consists of the following fields:
-
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=========================+==========+=============+=====================================================================================================================================+
-| cpuCapacityContention | number | No | The amount of time the CPU cannot run due to contention, in milliseconds over the measurementInterval |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuDemandAvg | number | No | The total CPU time that the NF/NFC/VM could use if there was no contention, in milliseconds over the measurementInterval |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuDemandMhz | number | No | CPU demand in MHz |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuDemandPct | number | No | CPU demand as a percentage of the provisioned capacity |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuIdentifier | string | Yes | CPU Identifier |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuIdle | number | No | Percentage of CPU time spent in the idle task |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuLatencyAvg | number | No | Percentage of time the VM is unable to run because it is contending for access to the physical CPUs |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuOverheadAvg | number | No | The overhead demand above available allocations and reservations, in milliseconds over the measurementInterval |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuSwapWaitTime | number | No | Swap wait time, in milliseconds over the measurementInterval |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageInterrupt | number | No | Percentage of time spent servicing interrupts |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageNice | number | No | Percentage of time spent running user space processes that have been niced |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageSoftIrq | number | No | Percentage of time spent handling soft irq interrupts |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageSteal | number | No | Percentage of time spent in involuntary wait which is neither user, system or idle time and is effectively time that went missing |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageSystem | number | No | Percentage of time spent on system tasks running the kernel |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageUser | number | No | Percentage of time spent running un-niced user space processes |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| cpuWait | number | No | Percentage of CPU time spent waiting for I/O operations to complete |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| percentUsage | number | Yes | Aggregate cpu usage of the virtual machine on which the xNFC reporting the event is running |
-+-------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: diskUsage
-^^^^^^^^^^^^^^^^^^^
-
-The diskUsage datatype defines the usage of a disk and consists of the
-following fields:
-
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============================+==========+=============+===============================================================================================================================================================================================================================+
-| diskBusResets | number | No | Number of bus resets over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskCommandsAborted | number | No | Number of disk commands aborted over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskCommandsAvg | number | No | Average number of commands per second over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskFlushRequests | number | No | Total flush requests of the disk cache over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskFlushTime | number | No | Milliseconds spent on disk cache flushing over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskIdentifier | string | Yes | Disk Identifier |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskIoTimeAvg | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskIoTimeLast | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskIoTimeMax | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskIoTimeMin | number | No | Milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedReadAvg | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedReadLast | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedReadMax | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedReadMin | number | No | Number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedWriteAvg | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedWriteLast | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedWriteMax | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskMergedWriteMin | number | No | Number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsRead Avg | number | No | Number of octets per second read from a disk or partition; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsRead | number | No | Number of octets per second read from a disk or partition; provide the last measurement within the measurement interval |
-| | | | |
-| Last | | | |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsRead Max | number | No | Number of octets per second read from a disk or partition; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsRead Min | number | No | Number of octets per second read from a disk or partition; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsWrite Avg | number | No | Number of octets per second written to a disk or partition; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsWrite Last | number | No | Number of octets per second written to a disk or partition; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsWriteMax | number | No | Number of octets per second written to a disk or partition; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOctetsWriteMin | number | No | Number of octets per second written to a disk or partition; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsReadAvg | number | No | Number of read operations per second issued to the disk; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsReadLast | number | No | Number of read operations per second issued to the disk; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsReadMax | number | No | Number of read operations per second issued to the disk; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsReadMin | number | No | Number of read operations per second issued to the disk; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsWriteAvg | number | No | Number of write operations per second issued to the disk; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsWriteLast | number | No | Number of write operations per second issued to the disk; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsWrite Max | number | No | Number of write operations per second issued to the disk; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskOpsWriteMin | number | No | Number of write operations per second issued to the disk; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskPendingOperationsAvg | number | No | Queue size of pending I/O operations per second; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskPendingOperationsLast | number | No | Queue size of pending I/O operations per second; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskPendingOperationsMax | number | No | Queue size of pending I/O operations per second; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskPendingOperationsMin | number | No | Queue size of pending I/O operations per second; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskReadCommandsAvg | number | No | Average number of read commands issued per second to the disk over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTime | number | No | Nanoseconds spent on disk cache reads/writes within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeReadAvg | number | No | Milliseconds a read operation took to complete; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeRead Last | number | No | Milliseconds a read operation took to complete; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeRead Max | number | No | Milliseconds a read operation took to complete; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeRead Min | number | No | Milliseconds a read operation took to complete; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeWrite Avg | number | No | Milliseconds a write operation took to complete; provide the average measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeWrite Last | number | No | Milliseconds a write operation took to complete; provide the last measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeWrite Max | number | No | Milliseconds a write operation took to complete; provide the maximum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTimeWrite Min | number | No | Milliseconds a write operation took to complete; provide the minimum measurement within the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTotalReadLatencyAvg | number | No | Average read time from the perspective of a Guest OS: sum of the Kernel Read Latency and Physical Device Read Latency in milliseconds over the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskTotalWriteLatencyAvg | number | No | Average write time from the perspective of a Guest OS: sum of the Kernel Write Latency and Physical Device Write Latency in milliseconds over the measurement interval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskWeightedIoTimeAvg | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the average within the collection interval. |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskWeightedIoTimeLast | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the last within the collection interval. |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskWeightedIoTimeMax | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the maximum within the collection interval. |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskWeightedIoTimeMin | number | No | Measure in ms over 1 sec of both I/O completion time and the backlog that may be accumulating. Value is the minimum within the collection interval. |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskWriteCommandsAvg | number | No | Average number of write commands issued per second to the disk over the measurementInterval |
-+-----------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: filesystemUsage
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The filesystemUsage datatype consists of the following fields:
-
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=======================+==========+=============+========================================================+
-| filesystemName | string | Yes | File system name |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| blockConfigured | number | Yes | Configured block storage capacity in GB |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| blockIops | number | Yes | Block storage input-output operations per second |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| blockUsed | number | Yes | Used block storage capacity in GB |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| ephemeralConfigured | number | Yes | Configured ephemeral storage capacity in GB |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| ephemeralIops | number | Yes | Ephemeral storage input-output operations per second |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-| ephemeralUsed | number | Yes | Used ephemeral storage capacity in GB |
-+-----------------------+----------+-------------+--------------------------------------------------------+
-
-Datatype: hugePages
-^^^^^^^^^^^^^^^^^^^
-
-The hugePages datatype provides metrics on system hugePages; it consists
-of the following fields:
-
-+-----------------------+----------+-------------+---------------------------------------+
-| Field | Type | Required? | Description |
-+=======================+==========+=============+=======================================+
-| bytesFree | number | No | Number of free hugePages in bytes |
-+-----------------------+----------+-------------+---------------------------------------+
-| bytesUsed | number | No | Number of used hugePages in bytes |
-+-----------------------+----------+-------------+---------------------------------------+
-| hugePagesIdentifier | string | Yes | HugePages identifier |
-+-----------------------+----------+-------------+---------------------------------------+
-| percentFree | number | No | Number of free hugePages in percent |
-+-----------------------+----------+-------------+---------------------------------------+
-| percentUsed | number | No | Number of used hugePages in percent |
-+-----------------------+----------+-------------+---------------------------------------+
-| vmPageNumberFree | number | No | Number of free vmPages in numbers |
-+-----------------------+----------+-------------+---------------------------------------+
-| vmPageNumberUsed | number | No | Number of used vmPages in numbers |
-+-----------------------+----------+-------------+---------------------------------------+
-
-Datatype: ipmi (Intelligent Platform Management Interface)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmi datatype provides intelligent platform management interface
-metrics; it consists of the following fields:
-
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| Field | Type | Required? | Description |
-+=======================================+======================================+=============+===================================================+
-| exitAirTemperature | number | No | System fan exit air flow temperature in Celsius |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| frontPanelTemperature | number | No | Front panel temp in Celsius |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ioModuleTemperature | number | No | Io module temp in Celsius |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiBaseboardTemperatureArray | ipmiBaseboard Temperature [ ] | No | Array of ipmiBaseboard Temperature objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiBaseboardVoltageRegulator Array | ipmiBaseboard VoltageRegulator [ ] | No | Array of ipmiBaseboard VoltageRegulator objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiBatteryArray | ipmiBattery [ ] | No | Array of ipmiBattery objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiFanArray | ipmiFan [ ] | No | Array of ipmiFan objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiGlobalAggregateTemperature | ipmiGlobalAggregate | No | ipmi global aggregate temperature margin |
-| | | | |
-| MarginArray | TemperatureMargin [ ] | | |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiHsbpArray | ipmiHsbp [ ] | No | Array of ipmiHsbp objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiNicArray | ipmiNic [ ] | No | Array of ipmiNic objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiPowerSupplyArray | ipmiPowerSupply [ ] | No | Array of ipmiPowerSupply objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| ipmiProcessorArray | ipmiProcessor [ ] | No | Array of ipmiProcessor objects |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-| systemAirflow | number | No | Airflow in cubic feet per minute (cfm) |
-+---------------------------------------+--------------------------------------+-------------+---------------------------------------------------+
-
-Datatype: ipmiBaseboardTemperature
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiBaseboardTemperature datatype consists of the following fields
-which describe ipmi baseboard temperature metrics:
-
-+-----------------------------------+----------+-------------+--------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===================================+==========+=============+==============================================================+
-| baseboardTemperature | number | No | Baseboard temperature in celsius |
-+-----------------------------------+----------+-------------+--------------------------------------------------------------+
-| baseboardTemperature Identifier | string | Yes | Identifier for the location where the temperature is taken |
-+-----------------------------------+----------+-------------+--------------------------------------------------------------+
-
-Datatype: ipmiBaseboardVoltageRegulator
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiBaseboardVoltageRegulator datatype consists of the following
-fields which describe ipmi baseboard voltage regulator metrics:
-
-+----------------------------------------+----------+-------------+--------------------------------------------------+
-| Field | Type | Required? | Description |
-+========================================+==========+=============+==================================================+
-| baseboardVoltage RegulatorIdentifier | string | Yes | Identifier for the baseboard voltage regulator |
-+----------------------------------------+----------+-------------+--------------------------------------------------+
-| voltageRegulator Temperature | number | No | Voltage regulator temperature in celsius |
-+----------------------------------------+----------+-------------+--------------------------------------------------+
-
-Datatype: ipmiBattery
-^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiBattery datatype consists of the following fields which describe
-ipmi battery metrics:
-
-+-----------------------+----------+-------------+------------------------------+
-| Field | Type | Required? | Description |
-+=======================+==========+=============+==============================+
-| batteryIdentifier | string | Yes | Identifier for the battery |
-+-----------------------+----------+-------------+------------------------------+
-| batteryType | string | No | Type of battery |
-+-----------------------+----------+-------------+------------------------------+
-| batteryVoltageLevel | number | No | Battery voltage level |
-+-----------------------+----------+-------------+------------------------------+
-
-Datatype: ipmiFan
-^^^^^^^^^^^^^^^^^
-
-The ipmiFan datatype consists of the following fields which describe
-ipmi fan metrics:
-
-+-----------------+----------+-------------+---------------------------------------------+
-| Field | Type | Required? | Description |
-+=================+==========+=============+=============================================+
-| fanIdentifier | string | Yes | Identifier for the fan |
-+-----------------+----------+-------------+---------------------------------------------+
-| fanSpeed | number | No | Fan speed in revolutions per minute (rpm) |
-+-----------------+----------+-------------+---------------------------------------------+
-
-Datatype: ipmiGlobalAggregateTemperatureMargin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiGlobalAggregateTemperatureMargin datatype consists of the
-following fields:
-
-+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==============================================+==========+=============+=============================================================================+
-| globalAggregateTemperatureMargin | number | No | Temperature margin in Celsius relative to a throttling thermal trip point |
-+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+
-| globalAggregateTemperatureMarginIdentifier | string | Yes | Identifier for the ipmi global aggregate temperature margin metrics |
-+----------------------------------------------+----------+-------------+-----------------------------------------------------------------------------+
-
-Datatype: ipmiHsbp
-^^^^^^^^^^^^^^^^^^
-
-The ipmiHsbp datatype provides ipmi hot swap backplane power metrics; it
-consists of the following fields:
-
-+-------------------+----------+-------------+----------------------------------------------------+
-| Field | Type | Required? | Description |
-+===================+==========+=============+====================================================+
-| hsbpIdentifier | string | Yes | Identifier for the hot swap backplane power unit |
-+-------------------+----------+-------------+----------------------------------------------------+
-| hsbpTemperature | number | No | Hot swap backplane power temperature in celsius |
-+-------------------+----------+-------------+----------------------------------------------------+
-
-Datatype: ipmiNic
-^^^^^^^^^^^^^^^^^
-
-The ipmiNic datatype provides network interface control care metrics; it
-consists of the following fields:
-
-+------------------+----------+-------------+-----------------------------------------------------+
-| Field | Type | Required? | Description |
-+==================+==========+=============+=====================================================+
-| nicIdentifier | string | Yes | Identifier for the network interface control card |
-+------------------+----------+-------------+-----------------------------------------------------+
-| nicTemperature | number | No | nic temperature in Celsius |
-+------------------+----------+-------------+-----------------------------------------------------+
-
-Datatype: ipmiPowerSupply
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiPowerSupply datatype provides ipmi power supply metrics; it
-consists of the following fields:
-
-+------------------------------------+----------+-------------+------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+====================================+==========+=============+========================================================================+
-| powerSupplyCurrentOutput Percent | number | No | Current output voltage as a percentage of the design specified level |
-+------------------------------------+----------+-------------+------------------------------------------------------------------------+
-| powerSupplyIdentifier | string | Yes | Identifier for the power supply |
-+------------------------------------+----------+-------------+------------------------------------------------------------------------+
-| powerSupplyInputPower | number | No | Input power in watts |
-+------------------------------------+----------+-------------+------------------------------------------------------------------------+
-| powerSupplyTemperature | number | No | Power supply temperature in Celsius |
-+------------------------------------+----------+-------------+------------------------------------------------------------------------+
-
-Datatype: ipmiProcessor
-^^^^^^^^^^^^^^^^^^^^^^^
-
-The ipmiProcessor datatype provides ipmi processor metrics; it consists
-of the following fields:
-
-+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============================================+=============================================+=============+=========================================================+
-| processorDimmAggregate ThermalMarginArray | processorDimm AggregateThermal Margin [ ] | No | Array of processorDimmAggregate ThermalMargin objects |
-+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
-| processorDtsThermalMargin | number | No | Front panel temperature in celsius |
-+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
-| processorIdentifier | string | Yes | Identifier for the power supply |
-+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
-| processorThermalControl Percent | number | No | Io module temperatue in celsius |
-+---------------------------------------------+---------------------------------------------+-------------+---------------------------------------------------------+
-
-Datatype: latencyBucketMeasure
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The latencyBucketMeasure datatype consists of the following fields which
-describe the number of counts falling within a defined latency bucket:
-
-+--------------------------+----------+-------------+------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==========================+==========+=============+============================================================+
-| countsInTheBucket | number | Yes | Number of counts falling within a defined latency bucket |
-+--------------------------+----------+-------------+------------------------------------------------------------+
-| highEndOfLatencyBucket | number | No | High end of bucket range (typically in ms) |
-+--------------------------+----------+-------------+------------------------------------------------------------+
-| lowEndOfLatencyBucket | number | No | Low end of bucket range (typically in ms) |
-+--------------------------+----------+-------------+------------------------------------------------------------+
-
-Datatype: load
-^^^^^^^^^^^^^^
-
-The load datatype provides metrics on system cpu and io utilization
-obtained using /proc/loadavg; it consists of the following fields:
-
-+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============+==========+=============+=============================================================================================================================================================+
-| longTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 15 minutes using /proc/loadavg |
-+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| midTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 5 minutes using /proc/loadavg |
-+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| shortTerm | number | No | number of jobs in the run queue (state R, cpu utilization) or waiting for disk I/O (state D, io utilization) averaged over 1 minute using /proc/loadavg |
-+-------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: machineCheckException
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The machineCheckException datatype describes machine check exceptions;
-it consists of the following fields:
-
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=================================+==========+=============+===================================================================================================================================================================================================================================================================+
-| correctedMemoryErrors | number | No | Total hardware errors that were corrected by the hardware (e.g. data corruption corrected via ECC) over the measurementInterval. These errors do not require immediate software actions, but are still reported for accounting and predictive failure analysis |
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| correctedMemoryErrors In1Hr | number | No | Total hardware errors that were corrected by the hardware over the last one hour |
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| uncorrectedMemoryErrors | number | No | Total uncorrected hardware errors that were detected by the hardware (e.g., causing data corruption) over the measurementInterval. These errors require a software response. |
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| uncorrectedMemoryErrors In1Hr | number | No | Total uncorrected hardware errors that were detected by the hardware over the last one hour |
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| vmIdentifier | string | Yes | Virtual machine identifier associated with the machine check exception |
-+---------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: measurementFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measurementFields datatype consists of the following fields:
-
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==============================+=============================+=============+===========================================================================================================================================================================================================+
-| additionalFields | hashMap | No | Additional measurement fields if needed |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| additionalMeasurements | arrayOfNamedHashMap | No | Array of named hashMap if needed |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| additionalObjects | arrayOfJsonObject | No | Array of JSON objects described by name, schema and other meta-information, if needed |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| codecUsageArray | codecsInUse [] | No | Array of codecs in use |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| concurrentSessions | integer | No | Peak concurrent sessions for the VM or xNF (depending on the context) over the measurementInterval |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| configuredEntities | integer | No | Depending on the context over the measurementInterval: peak total number of users, subscribers, devices, adjacencies, etc., for the VM, or peak total number of subscribers, devices, etc., for the xNF |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| cpuUsageArray | cpuUsage [] | No | Usage of an array of CPUs |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| diskUsageArray | diskUsage [] | No | Usage of an array of disks |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| featureUsageArray | hashMap | No | The hashMap key should identify the feature, while the value defines the number of times the identified feature was used |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| filesystemUsageArray | filesystemUsage [ ] | No | Filesystem usage of the VM on which the xNFC reporting the event is running |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| hugePagesArray | hugePages [ ] | No | Array of metrics on hugePages |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ipmi | ipmi | No | Intelligent platform management interface metrics |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| latencyDistribution | latencyBucketMeasure [ ] | No | Array of integers representing counts of requests whose latency in milliseconds falls within per-xNF configured ranges; where latency is the duration between a service request and its fulfillment. |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| loadArray | load [ ] | No | Array of system load metrics |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| machineCheckExceptionArray | machineCheckException [ ] | No | Array of machine check exceptions |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| meanRequestLatency | number | No | Mean seconds required to respond to each request for the VM on which the xNFC reporting the event is running |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measurementFieldsVersion | string | Yes | Version of the measurementFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| measurementInterval | number | Yes | Interval over which measurements are being reported in seconds |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| memoryUsageArray | memoryUsage [] | No | Memory usage of an array of VMs |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nfcScalingMetric | integer | No | Represents busy-ness of the network function from 0 to 100 as reported by the nfc |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nicPerformanceArray | nicPerformance [ ] | No | Performance metrics of an array of network interface cards |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numberOfMediaPortsInUse | integer | No | Number of media ports in use |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| processStatsArray | processStats [ ] | No | Array of metrics on system processes |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| requestRate | number | No | Peak rate of service requests per second to the xNF over the measurementInterval |
-+------------------------------+-----------------------------+-------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: memoryUsage
-^^^^^^^^^^^^^^^^^^^^^
-
-The memoryUsage datatype defines the memory usage of a virtual machine
-and consists of the following fields:
-
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+========================+==========+=============+===================================================================================================================================+
-| memoryBuffered | number | No | Kibibytes of temporary storage for raw disk blocks |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryCached | number | No | Kibibytes of memory used for cache |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryConfigured | number | No | Kibibytes of memory configured in the virtual machine on which the xNFC reporting the event is running |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryDemand | number | No | Host demand in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryFree | number | Yes | Kibibytes of physical RAM left unused by the system |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryLatencyAvg | number | No | Percentage of time the VM is waiting to access swapped or compressed memory |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySharedAvg | number | No | Shared memory in kilobytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySlabRecl | number | No | The part of the slab that can be reclaimed such as caches measured in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySlabUnrecl | number | No | The part of the slab that cannot be reclaimed even when lacking memory measure in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySwapInAvg | number | No | Amount of memory swapped-in from host cache in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySwapInRateAvg | number | No | Rate at which memory is swapped from disk into active memory during the interval in kilobytes per second |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySwapOutAvg | number | No | Amount of memory swapped-out to host cache in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySwapOutRateAvg | number | No | Rate at which memory is being swapped from active memory to disk during the current interval in kilobytes per second |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memorySwapUsedAvg | number | No | Space used for caching swapped pages in the host cache in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| memoryUsed | number | Yes | Total memory minus the sum of free, buffered, cached and slab memory measured in kibibytes |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| percentMemoryUsage | number | No | Percentage of memory usage; value = (memoryUsed / (memoryUsed + memoryFree) x 100 if denomintor is nonzero, or 0, if otherwise. |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| vmIdentifier | string | Yes | Virtual Machine identifier associated with the memory metrics |
-+------------------------+----------+-------------+-----------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: nicPerformance
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-The nicPerformance datatype consists of the following fields which
-describe the performance and errors of an of an identified virtual
-network interface card:
-
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==========================================+==========+=============+======================================================================================================================================================================================+
-| administrativeState | string | No | Administrative state: enum: ‘inService’, ‘outOfService’ |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| nicIdentifier | string | Yes | Network interface card identifier |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| operationalState | string | No | Operational state: enum: ‘inService’, ‘outOfService’ |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedBroadcastPacketsDelta | number | No | Count of broadcast packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedDiscardedPacketsDelta | number | No | Count of discarded packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedErrorPacketsAccumulated | number | No | Cumulative count of error packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedErrorPacketsDelta | number | No | Count of error packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedMulticastPacketsDelta | number | No | Count of multicast packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedOctetsAccumulated | number | No | Cumulative count of octets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedOctetsDelta | number | No | Count of octets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedPercentDiscard | number | No | Percentage of discarded packets received; value = (receivedDiscardedPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedPercentError | number | No | Percentage of error packets received; value = (receivedErrorPacketsDelta / receivedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedTotalPacketsAccumulated | number | No | Cumulative count of all packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedTotalPacketsDelta | number | No | Count of all packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets received as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedUnicastPacketsDelta | number | No | Count of unicast packets received within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| receivedUtilization | number | No | Percentage of utilization received; value = (receivedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| speed | number | No | Speed configured in mbps. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedBroadcastPacketsAccumulated | number | No | Cumulative count of broadcast packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedBroadcastPacketsDelta | number | No | Count of broadcast packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedDiscardedPacketsAccumulated | number | No | Cumulative count of discarded packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedDiscardedPacketsDelta | number | No | Count of discarded packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedErrorPacketsAccumulated | number | No | Cumulative count of error packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedErrorPacketsDelta | number | No | Count of error packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedMulticastPacketsAccumulated | number | No | Cumulative count of multicast packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedMulticastPacketsDelta | number | No | Count of multicast packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedOctetsAccumulated | number | No | Cumulative count of octets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedOctetsDelta | number | No | Count of octets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedPercentDiscard | number | No | Percentage of discarded packets transmitted; value = (transmittedDiscardedPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedPercentError | number | No | Percentage of error packets received; value = (transmittedErrorPacketsDelta / transmittedTotalPacketsDelta) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedTotalPacketsAccumulated | number | No | Cumulative count of all packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedTotalPacketsDelta | number | No | Count of all packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedUnicastPacketsAccumulated | number | No | Cumulative count of unicast packets transmitted as read at the end of the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedUnicastPacketsDelta | number | No | Count of unicast packets transmitted within the measurement interval |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| transmittedUtilization | number | No | Percentage of utilization transmitted; value = (transmittedOctetsDelta / (speed x (lastEpochMicrosec - startEpochMicrosec))) x 100, if denominator is nonzero, or 0, if otherwise. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| valuesAreSuspect | string | Yes | Enumeration: ‘true’ or ‘false’. If ‘true’ then the vNicPerformance values are likely inaccurate due to counter overflow or other conditions. |
-+------------------------------------------+----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: processorDimmAggregateThermalMargin
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The processorDimmAggregateThermalMargin datatype provides intelligent
-platform management interface (ipmi) processor dual inline memory module
-aggregate thermal margin metrics; it consists of the following fields:
-
-+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==================================================+==========+=============+===================================================================================================================+
-| processorDimmAggregateThermal MarginIdentifier | string | Yes | identifier for the aggregate thermal margin metrics from the processor dual inline memory module |
-+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+
-| thermalMargin | number | Yes | the difference between the DIMM's current temperature, in celsius, and the DIMM's throttling thermal trip point |
-+--------------------------------------------------+----------+-------------+-------------------------------------------------------------------------------------------------------------------+
-
-Datatype: processStats
-^^^^^^^^^^^^^^^^^^^^^^
-
-The processStats datatype provides metrics on system processes; it
-consists of the following fields:
-
-+---------------------+----------+-------------+-------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=====================+==========+=============+=======================================================+
-| forkRate | number | No | The number of threads created since the last reboot |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| processIdentifier | string | Yes | processIdentifier |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStateBlocked | number | No | The number of processes in a blocked state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStatePaging | number | No | The number of processes in a paging state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStateRunning | number | No | The number of processes in a running state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStateSleeping | number | No | The number of processes in a sleeping state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStateStopped | number | No | The number of processes in a stopped state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-| psStateZombie | number | No | The number of processes in a zombie state |
-+---------------------+----------+-------------+-------------------------------------------------------+
-
-‘Notification’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: notificationFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The notificationFields datatype consists of the following fields:
-
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============================+====================+=============+========================================================================================================================+
-| additionalFields | hashMap | No | Additional notification fields if needed |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| arrayOfNamedHashMap | namedHashMap [ ] | No | Array of named hashMaps |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| changeContact | string | No | Identifier for a contact related to the change |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| changeIdentifier | string | Yes | System or session identifier associated with the change |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| changeType | string | Yes | Describes what has changed for the entity, for example: configuration changed, capability added, capability removed… |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| newState | string | No | New state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| notificationFieldsVersion | string | Yes | Version of the notificationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| oldState | string | No | Previous state of the entity, for example: ‘inService’, ‘maintenance’, ‘outOfService’ |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| stateInterface | string | No | Card or port name of the entity that changed state |
-+-----------------------------+--------------------+-------------+------------------------------------------------------------------------------------------------------------------------+
-
-The fileReady notification event is used by 3GPP-compliant NFs to notify
-ONAP that a PM file is available for upload. The notificationFields are
-populated as follows:
-
-**arrayOfNamedHashMap:** The array is named for the PM file as defined
-in 3GPP TS 28.550. The array contains the following key value pairs:
-
-- **location** in the form protocol://ipAddress:port/path/filename;
- e.g. “location” :
- “ftpes://135.3.1.44:21/pmfiles/A20180531.1030+0600-1045+0600\_5gBts213.bin.gz”
-
-- **compression** containing the compression type used for the PM file;
- e.g. “compression” : “gzip”
-
-- **fileFormatType** containing the format type of the PM file; e.g.
- “fileFormatType” : “org.3GPP.32.435#measCollec”
-
-- **fileFormatVersion** containing the format version of the PM file;
- e.g. “fileFormatVersion” : “V10”
-
-- other vendor-defined key-value pairs as needed
-
-**changeIdentifier:** set to PM\_MEAS\_FILES
-
-**changeType:** set to fileReady
-
-Other notificationFields are not used for fileReady.
-
-‘Other’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: otherFields
-^^^^^^^^^^^^^^^^^^^^^
-
-The otherFields datatype defines fields for events belonging to the
-'other' domain of the commonEventHeader domain enumeration; it consists
-of the following fields:
-
-+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=======================+=======================+=============+==============================================================================================================+
-| arrayOfNamedHashMap | arrayOfNamedHashMap | No | Array of named hashMaps |
-+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
-| hashMap | hashMap | No | Array of name-value pairs |
-+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
-| jsonObjects | arrayOfJsonObject | No | Array of JSON objects described by name, schema and other meta-information |
-+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
-| otherFieldsVersion | string | Yes | Version of the otherFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------+-----------------------+-------------+--------------------------------------------------------------------------------------------------------------+
-
-‘perf3gpp’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: measDataCollection
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measDataCollection datatype defines a 3GPP measurement collection
-structure aligned with the 3GPP PM format; it consists of the following
-fields:
-
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=================================+================+=============+====================================================================================+
-| formatVersion | string | No | 3GPP PM reporting file format version from pre-standard TS 28.550 v2.0.0 |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| granularityPeriod | string | Yes | Granularity period for the PM report in seconds |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| measInfoList | measInfo [ ] | Yes | Array of measInfo measurements |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| measObjInstIdList | string [ ] | No | Array of monitored object local distinguished name ids per 3GPP TS 32.300 |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| measuredEntityDn | string | Yes | Distinguished name per 3GPP TS 28.550 |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| measuredEntitySoftwareVersion | string | No | Software version for the NF providing the PM data as specified in 3GPP TS 28.550 |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-| measuredEntityUserName | string | No | User Definable name for the measured object per 3GPP TS 28.550 |
-+---------------------------------+----------------+-------------+------------------------------------------------------------------------------------+
-
- Datatype: measInfo
-^^^^^^^^^^^^^^^^^^^
-
-The measInfo datatype provides measurement information; it consists of
-the following fields:
-
-+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==============+=================================================+=============+=====================================================================================================================================+
-| jobId | string | No | Name of the measurement job |
-+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| measInfoId | oneOf [ measInfoIdInteger, measInfoIdString ] | No | Measurement group Identifier |
-+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| measTypes | oneOf [ measTypesInteger, measTypesString ] | Yes | Array of measurement identifiers associated with the measurement results expressed as integers for efficiency rather than strings |
-+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-| measValues | measValues [ ] | Yes | Array of measValues |
-+--------------+-------------------------------------------------+-------------+-------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: measInfoIdInteger
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measInfoIdInteger datatype provides an integer measurement group
-identifier; it consists of the following fields:
-
-+---------------+-----------+-------------+----------------------------------------+
-| Field | Type | Required? | Description |
-+===============+===========+=============+========================================+
-| iMeasInfoId | integer | Yes | Integer measurement group Identifier |
-+---------------+-----------+-------------+----------------------------------------+
-
-Datatype: measInfoIdString
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measInfoIdString datatype provides a string measurement group
-identifier; it consists of the following fields:
-
-+---------------+-----------+-------------+---------------------------------------+
-| Field | Type | Required? | Description |
-+===============+===========+=============+=======================================+
-| sMeasInfoId | integer | Yes | String measurement group Identifier |
-+---------------+-----------+-------------+---------------------------------------+
-
-Datatype: measResultInteger
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measResultInteger datatype provides an integer 3GPP PM measurement
-result; it consists of the following fields:
-
-+----------+-----------+-------------+------------------------------------+
-| Field | Type | Required? | Description |
-+==========+===========+=============+====================================+
-| p | integer | Yes | Integer reference to the counter |
-+----------+-----------+-------------+------------------------------------+
-| iValue | integer | Yes | Integer counter value |
-+----------+-----------+-------------+------------------------------------+
-
-Datatype: measResultNull
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measResultNull datatype provides a null 3GPP PM measurement result;
-it consists of the following fields:
-
-+----------+-----------+-------------+------------------------------------+
-| Field | Type | Required? | Description |
-+==========+===========+=============+====================================+
-| p | integer | Yes | Integer reference to the counter |
-+----------+-----------+-------------+------------------------------------+
-| isNull | string | Yes | Enumeration: ‘true’ or ‘false’ |
-+----------+-----------+-------------+------------------------------------+
-
-Datatype: measResultNumber
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measResultNumber datatype provides a number 3GPP PM measurement
-result; it consists of the following fields:
-
-+----------+-----------+-------------+------------------------------------+
-| Field | Type | Required? | Description |
-+==========+===========+=============+====================================+
-| p | integer | Yes | Integer reference to the counter |
-+----------+-----------+-------------+------------------------------------+
-| rValue | number | Yes | Number counter value |
-+----------+-----------+-------------+------------------------------------+
-
-Datatype: measResultString
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measResultString datatype provides a string 3GPP PM measurement
-result; it consists of the following fields:
-
-+----------+-----------+-------------+------------------------------------+
-| Field | Type | Required? | Description |
-+==========+===========+=============+====================================+
-| p | integer | Yes | Integer reference to the counter |
-+----------+-----------+-------------+------------------------------------+
-| sValue | string | Yes | String counter value |
-+----------+-----------+-------------+------------------------------------+
-
-Datatype: measTypesInteger
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measTypesInteger datatype provides an array of integer measurement
-identifiers associated with the measurement results; it consists of the
-following fields:
-
-+------------------+---------------+-------------+------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==================+===============+=============+====================================================================================+
-| iMeasTypesList | integer [ ] | Yes | Array of integer measurement identifiers associated with the measurement results |
-+------------------+---------------+-------------+------------------------------------------------------------------------------------+
-
-Datatype: measTypesString
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The measTypesString datatype provides an array of string measurement
-identifiers associated with the measurement results; it consists of the
-following fields:
-
-+------------------+--------------+-------------+-----------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+==================+==============+=============+===================================================================================+
-| sMeasTypesList | string [ ] | Yes | Array of string measurement identifiers associated with the measurement results |
-+------------------+--------------+-------------+-----------------------------------------------------------------------------------+
-
-Datatype: measValues
-^^^^^^^^^^^^^^^^^^^^
-
-The measValues datatype provides 3GPP measurement values; it consists of
-the following fields:
-
-+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===================+=====================================================================================================================+=============+===================================================================================+
-| measObjAddlFlds | hashMap | No | Additional key-value pairs if needed |
-+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
-| measObjInstId | measDataCollection | Yes | Monitored object local distinguished name per 3GPP TS 32.300 and 3GPP TS 32.432 |
-+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
-| measResults | Array of items where each item is oneOf [ measResultInteger, measResultNull, measResultNumber, measResultString ] | Yes | Array of results |
-+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
-| suspectFlag | string | No | Enumeration: ‘true’, ‘false’. Indicates if the values are suspect |
-+-------------------+---------------------------------------------------------------------------------------------------------------------+-------------+-----------------------------------------------------------------------------------+
-
-Datatype: perf3gppFields
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-The perf3gppFields datatype defines fields for 3GPP PM format events,
-based on 3GPP TS 28.550, belonging to the 'perf3gpp' domain of the
-commonEventHeader domain enumeration; it consists of the following
-fields:
-
-+-------------------------+----------------------+-------------+-----------------------------------------+
-| Field | Type | Required? | Description |
-+=========================+======================+=============+=========================================+
-| eventAddlFields | hashMap | No | Additional key-value pairs if needed |
-+-------------------------+----------------------+-------------+-----------------------------------------+
-| measDataCollection | measDataCollection | Yes | 3GPP measurement collection structure |
-+-------------------------+----------------------+-------------+-----------------------------------------+
-| perf3gppFieldsVersion | string | Yes | Version of the perf3gpp event |
-+-------------------------+----------------------+-------------+-----------------------------------------+
-
-‘pnfRegistration’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: pnfRegistrationFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The pnfRegistrationFields datatype defines fields for events belonging
-to the 'pnfRegistration' domain of the commonEventHeader domain
-enumeration; it consists of the following fields:
-
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+================================+===========+=============+========================================================================================================================+
-| additionalFields | hashMap | No | Additional pnfRegistration fields if needed |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| lastServiceDate | string | No | TS 32.692 dateOfLastService = date of last service; e.g. 15022017 |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| macAddress | string | No | MAC address of OAM interface of the unit |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| manufactureDate | string | No | TS 32.692 dateOfManufacture = manufacture date of the unit; 24032016 |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| modelNumber | string | No | TS 32.692 versionNumber = version of the unit from vendor; e.g. AJ02. Maps to AAI equip-model |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| oamV4IpAddress | string | No | IPv4 m-plane IP address to be used by the manager to contact the PNF |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| oamV6IpAddress | string | No | IPv6 m-plane IP address to be used by the manager to contact the PNF |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| pnfRegistrationFieldsVersion | string | Yes | Version of the pnfRegistrationFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| serialNumber | string | No | TS 32.692 serialNumber = serial number of the unit; e.g. 6061ZW3 |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| softwareVersion | string | No | TS 32.692 swName = active SW running on the unit; e.g. 5gDUv18.05.201 |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| unitFamily | string | No | TS 32.692 vendorUnitFamilyType = general type of HW unit; e.g. BBU |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| unitType | string | No | TS 32.692 vendorUnitTypeNumber = vendor name for the unit; e.g. Airscale |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-| vendorName | string | No | TS 32.692 vendorName = name of manufacturer; e.g. Nokia. Maps to AAI equip-vendor |
-+--------------------------------+-----------+-------------+------------------------------------------------------------------------------------------------------------------------+
-
-‘State Change’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: stateChangeFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The stateChangeFields datatype consists of the following fields:
-
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+============================+===========+=============+====================================================================================================================+
-| additionalFields | hashMap | No | Additional stateChange fields if needed |
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-| newState | string | Yes | New state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-| oldState | string | Yes | Previous state of the entity: ‘inService’, ‘maintenance’, ‘outOfService’ |
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-| stateChangeFieldsVersion | string | Yes | Version of the stateChangeFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-| stateInterface | string | Yes | Card or port name of the entity that changed state |
-+----------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------+
-
-‘Syslog’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: syslogFields
-^^^^^^^^^^^^^^^^^^^^^^
-
-The syslogFields datatype consists of the following fields:
-
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=======================+===========+=============+======================================================================================================================================================================================+
-| additionalFields | hashMap | No | Additional syslog fields if needed Ex: {“name1”: ”value1”, “name2: “value2” … } |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventSourceHost | string | No | Hostname of the device |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| eventSourceType | string | Yes | Examples: ‘other’, ‘router’, ‘switch’, ‘host’, ‘card’, ‘port’, ‘slotThreshold’, ‘portThreshold’, ‘virtualMachine’, ‘virtualNetworkFunction’ |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogFacility | integer | No | Numeric code from 0 to 23 for facility: |
-| | | | |
-| | | | 0 kernel messages |
-| | | | |
-| | | | 1 user-level messages |
-| | | | |
-| | | | 2 mail system |
-| | | | |
-| | | | 3 system daemons |
-| | | | |
-| | | | 4 security/authorization messages |
-| | | | |
-| | | | 5 messages generated internally by syslogd |
-| | | | |
-| | | | 6 line printer subsystem |
-| | | | |
-| | | | 7 network news subsystem |
-| | | | |
-| | | | 8 UUCP subsystem |
-| | | | |
-| | | | 9 clock daemon |
-| | | | |
-| | | | 10 security/authorization messages |
-| | | | |
-| | | | 11 FTP daemon |
-| | | | |
-| | | | 12 NTP subsystem |
-| | | | |
-| | | | 13 log audit |
-| | | | |
-| | | | 14 log alert |
-| | | | |
-| | | | 15 clock daemon (note 2) |
-| | | | |
-| | | | 16 local use 0 (local0) |
-| | | | |
-| | | | 17 local use 1 (local1) |
-| | | | |
-| | | | 18 local use 2 (local2) |
-| | | | |
-| | | | 19 local use 3 (local3) |
-| | | | |
-| | | | 20 local use 4 (local4) |
-| | | | |
-| | | | 21 local use 5 (local5) |
-| | | | |
-| | | | 22 local use 6 (local6) |
-| | | | |
-| | | | 23 local use 7 (local7 ) |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogFieldsVersion | string | Yes | Version of the syslogFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogMsg | string | Yes | Syslog message |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogMsgHost | string | No | Hostname parsed from non-VES syslog message |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogPri | integer | No | 0-192 |
-| | | | |
-| | | | Combined Severity and Facility (see rfc5424) |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogProc | string | No | Identifies the application that originated the message |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogProcId | number | No | The process number assigned by the OS when the application was started |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogSData | string | No | A <space> separated list of key=”value” pairs following the rfc5424 standard for SD-ELEMENT. |
-| | | | |
-| | | | ***Deprecated *** |
-| | | | |
-| | | | The entire rfc5424 syslogSData object, including square brackets [ ], SD-ID and list of SD-PARAMs |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogSdId | string | No | 0-32 char in format name@number, |
-| | | | |
-| | | | i.e., ourSDID@32473 |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogSev | string | No | Level-of-severity text enumeration defined below: |
-| | | | |
-| | | | *Text* *Sev* *Description* |
-| | | | |
-| | | | Emergency 0 system is unusable |
-| | | | |
-| | | | Alert 1 action must be taken immediately |
-| | | | |
-| | | | Critical 2 critical conditions |
-| | | | |
-| | | | Error 3 error conditions |
-| | | | |
-| | | | Warning 4 warning conditions |
-| | | | |
-| | | | Notice 5 normal but significant condition |
-| | | | |
-| | | | Info 6 Informational messages |
-| | | | |
-| | | | Debug 7 debug-level messages |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogTag | string | Yes | Also known as MsgId. Brief non-spaced text indicating the type of message such as ‘TCPOUT’ or ‘BGP\_STATUS\_CHANGE’; ‘NILVALUE’ should be used when no other value can be provided |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogTs | string | No | Timestamp parsed from non-VES syslog message |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| syslogVer | number | No | IANA assigned version of the syslog protocol specification: |
-| | | | |
-| | | | 0: VES |
-| | | | |
-| | | | 1: IANA RFC5424 |
-+-----------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Examples of syslogSData :
-
-Preferred
-
- ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN” msg=”The BGP
- session to neighbor 10.10.10.10 is down”
-
-Deprecated
-
- [attinc@1234 ts=”1985-04-12T23:20:50.52Z” tag=”BGP\_NEIGHBOR\_DOWN”
- msg=”The BGP session to neighbor 10.10.10.10 is down”]
-
-Syslog references:
-
-https://tools.ietf.org/html/rfc5424#section-6
-
- https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xhtml
-
-‘Threshold Crossing Alert’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: counter
-^^^^^^^^^^^^^^^^^
-
-The counter datatype consists of the following fields:
-
-+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=====================+===========+=============+================================================================================+
-| criticality | string | Yes | Enumeration: ‘CRIT’, ‘MAJ’ |
-+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
-| hashMap | hashMap | Yes | Key is the name of the counter and value is the current value of the counter |
-+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
-| threshholdCrossed | string | Yes | Last threshold that was crossed |
-+---------------------+-----------+-------------+--------------------------------------------------------------------------------+
-
-Datatype: thresholdCrossingAlertFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The thresholdCrossingAlertFields datatype consists of the following
-fields:
-
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===================================+===============+=============+===============================================================================================================================+
-| additionalFields | hashMap | No | Additional threshold crossing alert fields if needed |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| additionalParameters | counter [ ] | Yes | Array of performance counters |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| alertAction | string | Yes | Enumeration: ‘SET’, ‘CONT’, ‘CLEAR’ |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| alertDescription | string | Yes | Unique short alert description (e.g., NE-CPUMEM) |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| alertType | string | Yes | Enumeration: ‘CARD-ANOMALY’, ‘INTERFACE-ANOMALY’, ELEMENT-ANOMALY’, ‘SERVICE-ANOMALY’ |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| alertValue | string | No | Calculated API value (if applicable) |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| associatedAlertIdList | string [ ] | No | List of eventIds associated with the event being reported |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| collectionTimestamp | string | Yes | Time when the performance collector picked up the data; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| dataCollector | string | No | Specific performance collector instance used |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| elementType | string | No | Type of network element (internal AT&T field) |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| eventSeverity | string | Yes | Event severity or priority enumeration: ‘CRITICAL’, ‘MAJOR’, ‘MINOR’, ‘WARNING’, ‘NORMAL’ |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| eventStartTimestamp | string | Yes | Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’ |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| interfaceName | string | No | Physical or logical port or card (if applicable) |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| networkService | string | No | Network name (internal AT&T field) |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| possibleRootCause | string | No | Reserved for future use |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-| thresholdCrossing FieldsVersion | string | Yes | Version of the thresholdCrossingAlertFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------------------+---------------+-------------+-------------------------------------------------------------------------------------------------------------------------------+
-
-Technology Specific Datatypes
------------------------------
-
-Mobile Flow’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: gtpPerFlowMetrics
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The gtpPerFlowMetrics datatype consists of the following fields:
-
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+====================================+===========+=============+===================================================================================================================================================================================================================+
-| avgBitErrorRate | number | Yes | Average bit error rate |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| avgPacketDelayVariation | number | Yes | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| avgPacketLatency | number | Yes | Average delivery latency |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| avgReceiveThroughput | number | Yes | Average receive throughput |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| avgTransmitThroughput | number | Yes | Average transmit throughput |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| durConnectionFailedStatus | number | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| durTunnelFailedStatus | number | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowActivatedBy | string | No | Endpoint activating the flow |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowActivationEpoch | number | Yes | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowActivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowActivationTime | string | No | 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’ |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowDeactivatedBy | string | No | Endpoint deactivating the flow |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowDeactivationEpoch | number | Yes | Time for the start of the flow connection, in integer UTC epoch time aka UNIX time |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowDeactivationMicrosec | number | Yes | Integer microseconds for the start of the flow connection |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowDeactivationTime | string | Yes | 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’ |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowStatus | string | Yes | Connection status at reporting time as a working / inactive / failed indicator value |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| gtpConnectionStatus | string | No | Current connection state at reporting time |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| gtpTunnelStatus | string | No | Current tunnel state at reporting time |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ipTosCountList | hashMap | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ipTosList | string | No | Array of unique IP Type-of-Service values observed in the flow where values range from '0' to '255' |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| largePacketRtt | number | No | large packet round trip time |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| largePacketThreshold | number | No | large packet threshold being applied |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| maxPacketDelayVariation | number | Yes | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| maxReceiveBitRate | number | No | maximum receive bit rate" |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| maxTransmitBitRate | number | No | maximum transmit bit rate |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mobileQciCosCountList | hashMap | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mobileQciCosList | string | No | Array of unique LTE QCI or UMTS class-of-service values observed in the flow |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numActivationFailures | number | Yes | Number of failed activation requests, as observed by the reporting node |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numBitErrors | number | Yes | number of errored bits |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numBytesReceived | number | Yes | number of bytes received, including retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numBytesTransmitted | number | Yes | number of bytes transmitted, including retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numDroppedPackets | number | Yes | number of received packets dropped due to errors per virtual interface |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numGtpEchoFailures | number | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numGtpTunnelErrors | number | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numHttpErrors | number | No | Http error count |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, including retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numL7BytesTransmitted | number | Yes | number of tunneled layer 7 bytes transmitted, excluding retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numLostPackets | number | Yes | number of lost packets |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numOutOfOrderPackets | number | Yes | number of out-of-order packets |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numPacketErrors | number | Yes | number of errored packets |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numPacketsReceivedExclRetrans | number | Yes | number of packets received, excluding retransmission |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numPacketsReceivedInclRetrans | number | Yes | number of packets received, including retransmission |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numPacketsTransmittedInclRetrans | number | Yes | number of packets transmitted, including retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numRetries | number | Yes | number of packet retrie |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numTimeouts | number | Yes | number of packet timeouts |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| numTunneledL7BytesReceived | number | Yes | number of tunneled layer 7 bytes received, excluding retransmissions |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| roundTripTime | number | Yes | Round Trip time |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tcpFlagCountList | hashMap | No | 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 |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tcpFlagList | string | No | Array of unique TCP Flags observed in the flow |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| timeToFirstByte | number | Yes | Time in milliseconds between the connection activation and first byte received |
-+------------------------------------+-----------+-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: mobileFlowFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The mobileFlowFields datatype consists of the following fields:
-
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+===========================+======================+=============+==============================================================================================================================================================================================+
-| additionalFields | hashMap | No | Additional mobileFlow fields if needed |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| applicationType | string | No | Application type inferred |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| appProtocolType | string | No | Application protocol |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| appProtocolVersion | string | No | Application version |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| cid | string | No | Cell Id |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| connectionType | string | No | Abbreviation referencing a 3GPP reference point e.g., S1-U, S11, etc |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ecgi | string | No | Evolved Cell Global Id |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| flowDirection | string | Yes | Flow direction, indicating if the reporting node is the source of the flow or destination for the flow |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| gtpPerFlowMetrics | gtpPer FlowMetrics | Yes | Mobility GTP Protocol per flow metrics |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| gtpProtocolType | string | No | GTP protocol |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| gtpVersion | string | No | GTP protocol version |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| httpHeader | string | No | HTTP request header, if the flow connects to a node referenced by HTTP |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| imei | string | No | IMEI for the subscriber UE used in this flow, if the flow connects to a mobile device |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| imsi | string | No | IMSI for the subscriber UE used in this flow, if the flow connects to a mobile device |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ipProtocolType | string | Yes | IP protocol type e.g., TCP, UDP, RTP... |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ipVersion | string | Yes | IP protocol version e.g., IPv4, IPv6 |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| lac | string | No | Location area code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mcc | string | No | Mobile country code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mnc | string | No | Mobile network code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mobileFlowFieldsVersion | string | Yes | Version of the mobileFlowFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| msisdn | string | No | MSISDN for the subscriber UE used in this flow, as an integer, if the flow connects to a mobile device |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| otherEndpointIpAddress | string | Yes | IP address for the other endpoint, as used for the flow being reported on |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| otherEndpointPort | integer | Yes | IP Port for the reporting entity, as used for the flow being reported on |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| otherFunctionalRole | string | No | Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF... |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| rac | string | No | Routing area code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| radioAccessTechnology | string | No | Radio Access Technology e.g., 2G, 3G, LTE |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| reportingEndpointIpAddr | string | Yes | IP address for the reporting entity, as used for the flow being reported on |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| reportingEndpointPort | integer | Yes | IP port for the reporting entity, as used for the flow being reported on |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| sac | string | No | Service area code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| samplingAlgorithm | integer | No | 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 |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tac | string | No | Transport area code |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tunnelId | string | No | Tunnel identifier |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| vlanId | string | No | VLAN identifier used by this flow |
-+---------------------------+----------------------+-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-‘SipSignaling’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: sipSignalingFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The sipSignalingFields datatype communicates information about sip
-signaling messages, parameters and signaling state; it consists of the
-following fields:
-
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============================+======================+=============+=====================================================================================================================+
-| additionalInformation | hashMap | No | Additional sipSignaling fields |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| compressedSip | string | No | The full SIP request/response including headers and bodies |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| correlator | string | Yes | Constant across all events on this call |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| localIpAddress | string | Yes | Ip address on xNF |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| localPort | string | Yes | Port on xNF |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| remoteIpAddress | string | Yes | IP address of peer endpoint |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| remotePort | string | Yes | Port of peer endpoint |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| sipSignalingFieldsVersion | string | Yes | Version of the sipSignalingFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| summarySip | string | No | The SIP Method or Response (‘INVITE’, ‘200 OK’, ‘BYE’, etc) |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| vendorNfNameFields | vendorNfNameFields | Yes | Vendor, NF and nfModule names |
-+-----------------------------+----------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-
-‘Voice Quality’ Domain Datatypes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Datatype: endOfCallVqmSummaries
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The endOfCallVqmSummaries datatype provides end of call voice quality
-metrics; it consists of the following fields:
-
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=================================+==========+=============+==================================================================================================================================================================================================================+
-| adjacencyName | string | Yes | Adjacency name |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointAverageJitter | number | No | Endpoint average jitter |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointDescription | string | Yes | Enumeration: ‘Caller’, ‘Callee’ |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointMaxJitter | number | No | Endpoint maximum jitter |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpOctetsDiscarded | number | No | Endpoint RTP octets discarded |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpOctetsLost | number | No | Endpoint RTP octets lost |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpOctetsReceived | number | No | Endpoint RTP octets received |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpOctetsSent | number | No | Endpoint RTP octets sent |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpPacketsDiscarded | number | No | Endpoint RTP packets discarded |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpPacketsLost | number | No | Endpoint RTP packets lost |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpPacketsReceived | number | No | Endpoint RTP packets received |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| endpointRtpPacketsSent | number | No | Endpoint RTP packets sent |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localAverageJitter | number | No | Local average jitter |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localAverageJitterBufferDelay | number | No | Local average jitter buffer delay |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localMaxJitter | number | No | Local maximum jitter |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localMaxJitterBufferDelay | number | No | Local max jitter buffer delay |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpOctetsDiscarded | number | No | Local RTP octets discarded |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpOctetsLost | number | No | Local RTP octets lost |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpOctetsReceived | number | No | Local RTP octets received |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpOctetsSent | number | No | Local RTP octets sent |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpPacketsDiscarded | number | No | Local RTP packets discarded |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpPacketsLost | number | No | Local RTP packets lost |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpPacketsReceived | number | No | Local RTP packets received |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| localRtpPacketsSent | number | No | Local RTP packets sent |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| mosCqe | number | No | Decimal range from 1 to 5 (1 decimal place) |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| oneWayDelay | number | No | one-way path delay in milliseconds |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| packetLossPercent | number | No | Calculated percentage packet loss based on endpoint RTP packets lost (as reported in RTCP) and local RTP packets sent. Direction is based on endpoint description (Caller, Callee). Decimal (2 decimal places) |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| rFactor | number | No | rFactor from 0 to 100 |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| roundTripDelay | number | No | Round trip delay in milliseconds |
-+---------------------------------+----------+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Datatype: voiceQualityFields
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The voiceQualityFields datatype provides statistics related to customer
-facing voice products; consists of the following fields:
-
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| Field | Type | Required? | Description |
-+=============================+==========================+=============+=====================================================================================================================+
-| additionalInformation | hashMap | No | Additional voice quality fields |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| calleeSideCodec | string | Yes | Callee codec for the call |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| callerSideCodec | string | Yes | Caller codec for the call |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| correlator | string | Yes | Constant across all events on this call |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| endOfCallVqmSummaries | endOfCallVqm Summaries | No | End of call voice quality metric summaries |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| phoneNumber | string | No | Phone number associated with the correlator |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| midCallRtcp | string | Yes | Base64 encoding of the binary RTCP data (excluding Eth/IP/UDP headers) |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| vendorNfNameFields | vendorNfNameFields | Yes | Vendor, NF and nfModule names |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-| voiceQualityFieldsVersion | string | Yes | Version of the voiceQualityFields block as “#.#” where # is a digit; see section 1 for the correct digits to use. |
-+-----------------------------+--------------------------+-------------+---------------------------------------------------------------------------------------------------------------------+
-
-Exceptions
-==========
-
-RESTful Web Services Exceptions
--------------------------------
-
-RESTful services generate and send exceptions to clients in response to
-invocation errors. Exceptions send HTTP status codes (specified later in
-this document for each operation). HTTP status codes may be followed by
-an optional JSON exception structure described below. Two types of
-exceptions may be defined: service exceptions and policy exceptions.
-
-+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Field Name** | **Data Type** | **Required?** | **Description** |
-+==================+============================+=================+========================================================================================================================================================================================================================================================================+
-| messageId | xs:string | Yes | Unique message identifier of the format ‘ABCnnnn’ where ‘ABC’ is either ‘SVC’ for Service Exceptions or ‘POL’ for Policy Exception. |
-| | | | |
-| | | | Exception numbers may be in the range of 0001 to 9999 where : |
-| | | | |
-| | | | - 0001 to 2999 are defined by OMA (see OMA’s `Common definitions for RESTful Network APIs <http://technical.openmobilealliance.org/Technical/release_program/docs/REST_NetAPI_Common/V1_0-20120417-C/OMA-TS-REST_NetAPI_Common-V1_0-20120417-C.pdf>`__ for details) |
-| | | | |
-| | | | - 3000-9999 are available and undefined |
-+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| text | xs:string | Yes | Message text, with replacement variables marked with %n, where n is an index into the list of <variables> elements, starting at 1 |
-+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| variables | xs:string [0..unbounded] | No | List of zero or more strings that represent the contents of the variables used by the message text. |
-+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| url | xs:anyUrl | No | Hyperlink to a detailed error resource (e.g., an HTML page for browser user agents). |
-+------------------+----------------------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Service Exceptions
-------------------
-
- When a service is not able to process a request, and retrying the
- request with the same information will also result in a failure, and
- the issue is not related to a service policy issue, then the service
- will issue a fault using the service exception fault message.
- Examples of service exceptions include invalid input, lack of
- availability of a required resource or a processing error.
-
- A service exception uses the letters 'SVC' at the beginning of the
- message identifier. ‘SVC’ service exceptions used by the VES Event
- Listener API are defined below.
-
-+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
-| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* |
-+===============+=======================================+===============================================================+===============================================+======================+
-| SVC0001 | General service error (see SVC2000) | <custom error message> | None | 400 |
-+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
-| SVC0002 | Bad parameter | Invalid input value for message part %1 | %1: message part | 400 |
-+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
-| SVC1000 | No server resources | No server resources available to process the request | None | 500 |
-+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
-| SVC2000 | More elaborate version of SVC0001 | The following service error occurred: %1. Error code is %2. | %1: human readable description of the error | 400 |
-| | | | | |
-| | | | %2: error code | |
-+---------------+---------------------------------------+---------------------------------------------------------------+-----------------------------------------------+----------------------+
-
- Table - Service Exceptions
-
-Policy Exceptions
------------------
-
- When a service is not able to complete because the request fails to
- meet a policy criteria, then the service will issue a fault using the
- policy exception fault message. To clarify how a policy exception
- differs from a service exception, consider that all the input to an
- operation may be valid as meeting the required input for the
- operation (thus no service exception), but using that input in the
- execution of the service may result in conditions that require the
- service not to complete. Examples of policy exceptions include
- privacy violations, requests not permitted under a governing service
- agreement or input content not acceptable to the service provider.
-
- A Policy Exception uses the letters 'POL' at the beginning of the
- message identifier. ‘POL’ policy exceptions used by the VES Event
- Listener API are defined below.
-
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-| *MessageId* | *Description / Comment* | *Text* | *Variables* | *Parent HTTP Code* |
-+===============+======================================+==============================================================+===============================================+======================+
-| POL0001 | General policy error (see POL2000) | A policy error occurred. | None | 401 |
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-| POL1009 | User not provisioned for service | User has not been provisioned for service | None | 401 |
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-| POL1010 | User suspended from service | User has been suspended from service | None | 401 |
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-| POL2000 | More elaborate version of POL0001 | The following policy error occurred: %1. Error code is %2. | %1: human readable description of the error | 401 |
-| | | | | |
-| | | | %2: error code | |
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-| POL9003 | Message size exceeds limit | Message content size exceeds the allowable limit | None | 400 |
-+---------------+--------------------------------------+--------------------------------------------------------------+-----------------------------------------------+----------------------+
-
- Table - Policy Exceptions
-
-RESTful Web Services Definition
-===============================
-
-REST Operation Overview
------------------------
-
-REST Operation Summary
-~~~~~~~~~~~~~~~~~~~~~~
-
-+------------------------+------------+----------------------------------------------------------------------------+
-| **Operation Action** | **HTTP** | **Resource URL relative to {ServerRoot}, which is defined in section 3** |
-| | | |
-| | **Verb** | |
-+------------------------+------------+----------------------------------------------------------------------------+
-| publishAnyEvent | POST | /eventListener/v{apiVersion} |
-+------------------------+------------+----------------------------------------------------------------------------+
-| publishEventBatch | POST | /eventListener/v{apiVersion}/eventBatch |
-+------------------------+------------+----------------------------------------------------------------------------+
-
-Table - REST Operation Summary
-
-Api Versioning
-~~~~~~~~~~~~~~
-
-apiVersion is used to describe the major version number of the event
-listener API (which is the same as the major version number of this
-specification). When this number changes, the implication is: the new
-major version will break clients of older major versions in some way, if
-they try to use the new API without modification (e.g., unmodified v1
-clients would not be able to use v2 without error).
-
-The Event Listener shall provide the following HTTP headers in response
-to all requests. Additionally, clients may populate these headers on
-requests to indicate the specific version they are interested in.
-
-- X-MinorVersion: 0
-
-- X-PatchVersion: 0
-
-- X-LatestVersion: 7.1
-
-If a client requests major version 7 (per the REST resource URL) and
-does not specify the above headers, then they will be provided with the
-latest patch version of 7.0.x (which is 7.0.1). If the client wants a
-particular minor version of major version 7, then they need to supply
-the X-MinorVersion header with their request. For example, if they
-request major version 7 with X-MinorVersion: 1, they will get the latest
-patch version of 7.1, which is 7.1.0.
-
-Buffering of Events
-~~~~~~~~~~~~~~~~~~~~
-
-{ServerRoot} is defined in section 3 of this document, which defines the
-REST resource URL. One or more FQDNs may be provisioned in an event
-source when it is instantiated or updated. If an event source is unable
-to reach any of the provisioned FQDNs, it should buffer the event data
-specified below, up to a maximum of 1 hour, until a connection can be
-established and the events can be successfully delivered to the VES
-Event Listener service.
-
-xNFs acting as event sources should not send syslog events to the VES
-Event Listener during debug mode (which is controlled via the Netconf
-management interface), but should store syslog events locally for
-access, and possible FTP transfer, via the xNF console (e.g., command
-line interface).
-
-If the internal event source event buffer or local storage should
-overflow, then the event source should send a Fault event, and should
-discard events in a first-in, first-out (FIFO) manner (i.e., discard
-oldest events first).
-
-Message Size
-~~~~~~~~~~~~
-
-Message size should be limited to 2 megabytes of uncompressed text sent
-as application/json.
-
-Operation: publishAnyEvent
---------------------------
-
-Functional Behavior
-~~~~~~~~~~~~~~~~~~~
-
-Allows authorized clients to publish any single event to the VES event
-listener.
-
-- Supports only secure HTTPS (one way SSL) access.
-
-- Uses the HTTP verb POST
-
-- Supports JSON content types
-
-- Provides HTTP response codes as well as Service and Policy error
- messages
-
-Call Flow
-~~~~~~~~~
-
-.. image:: publish-event-flow.png
-
-Figure - publishAnyEvent Call Flow
-
-Input Parameters
-~~~~~~~~~~~~~~~~
-
-Header Fields (note: all parameter names shall be treated as
-case-insensitive):
-
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Accept | string | No | Determines the format of the body of the response. Valid values are: |
-| | | | |
-| | | | - application/json |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Authorization | string | Yes | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Content-length | integer | No | Note that content length is limited to 2Megabyte. |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Content-type | string | Yes | Must be set to one of the following values: |
-| | | | |
-| | | | - application/json |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-MinorVersion | integer | No | The minor version of the API requested by the client |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-PatchVersion | integer | No | The patch version of the API requested by the client |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-LatestVersion | string | No | The full version of the API requested by the client expressed as {major}.{minor}.{patch} |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Body Fields:
-
-+-----------------+-----------------+-----------------+-----------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-----------------+-----------------+-----------------+-----------------------------------------------------------+
-| Event | event | Yes | Contains the JSON structure of the common event format. |
-+-----------------+-----------------+-----------------+-----------------------------------------------------------+
-
-Output Parameters
-~~~~~~~~~~~~~~~~~
-
-Header fields:
-
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Content-length | integer | No | Used only in error conditions. |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Content-type | string | No | Used only in error conditions |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Date | datetime | No | Date time of the response in GMT |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-MinorVersion | integer | Yes | The minor version of the API service |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-PatchVersion | integer | Yes | The patch version of the API service |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-LatestVersion | string | Yes | The full version of the API service expressed as {major}.{minor}.{patch} |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-
-Body Fields (for success responses): no content is provided.
-
-Body Fields (for error responses):
-
-+-----------------+-----------------+--------------------+----------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-----------------+-----------------+--------------------+----------------------------------+
-| requestError | requestError | Yes (for errors) | Used only in error conditions. |
-+-----------------+-----------------+--------------------+----------------------------------+
-
-HTTP Status Codes
-~~~~~~~~~~~~~~~~~
-
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| *Code* | *Reason Phrase* | *Description* |
-+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
-| 202 | Accepted | The request has been accepted for processing |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Sample Request and Response
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Sample Request
-^^^^^^^^^^^^^^
-
-+-------------------------------------------------------------------------------+
-| POST /eventListener/v7 HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| X-MinorVersion: 1 |
-| |
-| { |
-| |
-| "event": { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", |
-| |
-| "eventId": "fault0000245", |
-| |
-| "sequence": 1, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam001", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "PilotNumberPoolExhaustion", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active", |
-| |
-| "alarmAdditionalInformation": { |
-| |
-| "PilotNumberPoolSize": "1000" |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-------------------------------------------------------------------------------+
-
-Sample Success Response
-^^^^^^^^^^^^^^^^^^^^^^^
-
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
-
-Sample Error Responses
-^^^^^^^^^^^^^^^^^^^^^^
-
-Sample Policy Exception
-'''''''''''''''''''''''
-
-+---------------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “policyException”: { |
-| |
-| “messageId”: “POL9003”, |
-| |
-| “text”: “Message content size exceeds the allowable limit”, |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+---------------------------------------------------------------+
-
-Sample Service Exception
-''''''''''''''''''''''''
-
-+-----------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “serviceException”: { |
-| |
-| “messageId”: “SVC2000”, |
-| |
-| “text”: “Missing Parameter: %1. Error code is %2” |
-| |
-| “variables”: [ |
-| |
-| “severity”, |
-| |
-| “400” |
-| |
-| ] |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------+
-
-Operation: publishEventBatch
-----------------------------
-
-Functional Behavior
-~~~~~~~~~~~~~~~~~~~
-
-Allows authorized clients to publish a batch of events to the VES event
-listener.
-
-- Supports only secure HTTPS (one way SSL) access.
-
-- Uses the HTTP verb POST
-
-- Supports JSON content types
-
-- Provides HTTP response codes as well as Service and Policy error
- messages
-
-Call Flow
-~~~~~~~~~
-
-.. image:: publish event flow.png
-
-Figure – publishEventBatch Call Flow
-
-Input Parameters
-~~~~~~~~~~~~~~~~
-
-Header Fields (note: all parameter names shall be treated as
-case-insensitive):
-
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Accept | string | No | Determines the format of the body of the response. Valid values are: |
-| | | | |
-| | | | - application/json |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Authorization | string | Yes | The username and password are formed into one string as “username:password”. This string is then Base64 encoded to produce the encoded credential which is communicated in the header after the string “Authorization: Basic “. See examples below. If the Authorization header is missing, then an HTTP 400 Invalid Request message shall be returned. If the string supplied is invalid, then an HTTP 401 Unauthorized message shall be returned. |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Content-length | integer | No | Note that content length is limited to 2Megabyte. |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Content-type | string | Yes | Must be set to one of the following values: |
-| | | | |
-| | | | - application/json |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-MinorVersion | integer | No | The minor version of the API requested by the client |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-PatchVersion | integer | No | The patch version of the API requested by the client |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| X-LatestVersion | string | No | The full version of the API requested by the client expressed as {major}.{minor}.{patch} |
-+-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Body Fields:
-
-+-----------------+-----------------+-----------------+----------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-----------------+-----------------+-----------------+----------------------------------------------------------+
-| eventList | eventList | Yes | Array of events conforming to the common event format. |
-+-----------------+-----------------+-----------------+----------------------------------------------------------+
-
-Output Parameters
-~~~~~~~~~~~~~~~~~
-
-Header fields:
-
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Content-length | integer | No | Used only in error conditions. |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Content-type | string | No | Used only in error conditions |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| Date | datetime | No | Date time of the response in GMT |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-MinorVersion | integer | Yes | The minor version of the API service |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-PatchVersion | integer | Yes | The patch version of the API service |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-| X-LatestVersion | string | Yes | The full version of the API service expressed as {major}.{minor}.{patch} |
-+-------------------+-----------------+-----------------+----------------------------------------------------------------------------+
-
-Body Fields (for success responses: no content is provided.
-
-Body Fields (for error responses):
-
-+-----------------+-----------------+--------------------+----------------------------------+
-| **Parameter** | **Data Type** | **Required?** | **Brief description** |
-+-----------------+-----------------+--------------------+----------------------------------+
-| requestError | requestError | Yes (for errors) | Used only in error conditions. |
-+-----------------+-----------------+--------------------+----------------------------------+
-
-HTTP Status Codes
-~~~~~~~~~~~~~~~~~
-
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| *Code* | *Reason Phrase* | *Description* |
-+==========+=========================+==========================================================================================================================================================================================================================================================================================================================================================================================+
-| 202 | Accepted | The request has been accepted for processing |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 400 | Bad Request | Many possible reasons not specified by the other codes (e.g., missing required parameters or incorrect format). The response body may include a further exception code and text. HTTP 400 errors may be mapped to SVC0001 (general service error), SVC0002 (bad parameter), SVC2000 (general service error with details) or PO9003 (message content size exceeds the allowable limit). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 401 | Unauthorized | Authentication failed or was not provided. HTTP 401 errors may be mapped to POL0001 (general policy error) or POL2000 (general policy error with details). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 404 | Not Found | The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 405 | Method Not Allowed | A request was made of a resource using a request method not supported by that resource (e.g., using PUT on a REST resource that only supports POST). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 500 | Internal Server Error | The server encountered an internal error or timed out; please retry (general catch-all server-side error).HTTP 500 errors may be mapped to SVC1000 (no server resources). |
-+----------+-------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Sample Request and Response
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Sample Request
-^^^^^^^^^^^^^^
-
-+-------------------------------------------------------------------------------+
-| POST /eventListener/v7/eventBatch HTTP/1.1 |
-| |
-| Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== |
-| |
-| content-type: application/json |
-| |
-| | content-length: 12345 |
-| | X-MinorVersion: 1 |
-| |
-| { |
-| |
-| "eventList": [ |
-| |
-| { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": "Fault\_Vscf:Acs-Ericcson\_PilotNumberPoolExhaustion", |
-| |
-| "eventId": "fault0000250", |
-| |
-| "sequence": 1, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam0011234", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000000, |
-| |
-| "lastEpochMicrosec": 1413378172000000, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "PilotNumberPoolExhaustion", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Calls cannot complete - pilot numbers are unavailable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active", |
-| |
-| "alarmAdditionalInformation": { |
-| |
-| "PilotNumberPoolSize": "1000" |
-| |
-| } |
-| |
-| } |
-| |
-| }, |
-| |
-| { |
-| |
-| "commonEventHeader": { |
-| |
-| "version": "4.1", |
-| |
-| "vesEventListenerVersion": "7.1", |
-| |
-| "domain": "fault", |
-| |
-| "eventName": " Fault\_Vscf:Acs-Ericcson\_RecordingServerUnreachable", |
-| |
-| "eventId": "fault0000251", |
-| |
-| "sequence": 0, |
-| |
-| "priority": "High", |
-| |
-| "reportingEntityId": "cc305d54-75b4-431b-adb2-eb6b9e541234", |
-| |
-| "reportingEntityName": "ibcx0001vm002oam0011234", |
-| |
-| "sourceId": "de305d54-75b4-431b-adb2-eb6b9e546014", |
-| |
-| "sourceName": "scfx0001vm002cap001", |
-| |
-| "nfVendorName": "Ericsson", |
-| |
-| "nfNamingCode": "scfx", |
-| |
-| "nfcNamingCode": "ssc", |
-| |
-| "startEpochMicrosec": 1413378172000010, |
-| |
-| "lastEpochMicrosec": 1413378172000010, |
-| |
-| "timeZoneOffset": "UTC-05:30" |
-| |
-| }, |
-| |
-| "faultFields": { |
-| |
-| "faultFieldsVersion": 4.0, |
-| |
-| "alarmCondition": "RecordingServerUnreachable", |
-| |
-| "eventSourceType": "other", |
-| |
-| "specificProblem": "Recording server unreachable", |
-| |
-| "eventSeverity": "CRITICAL", |
-| |
-| "vfStatus": "Active" |
-| |
-| } |
-| |
-| } |
-| |
-| ] |
-| |
-| } |
-+-------------------------------------------------------------------------------+
-
-Sample Success Response
-^^^^^^^^^^^^^^^^^^^^^^^
-
-+--------------------------+
-| HTTPS/1.1 202 Accepted |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-+--------------------------+
-
-Sample Error Responses
-^^^^^^^^^^^^^^^^^^^^^^
-
-Sample Policy Exception
-'''''''''''''''''''''''
-
-+---------------------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “policyException”: { |
-| |
-| “messageId”: “POL9003”, |
-| |
-| “text”: “Message content size exceeds the allowable limit”, |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+---------------------------------------------------------------+
-
-Sample Service Exception
-''''''''''''''''''''''''
-
-+-----------------------------------------------------+
-| HTTPS/1.1 400 Bad Request |
-| |
-| content-type: application/json |
-| |
-| content-length: 12345 |
-| |
-| Date: Thu, 04 Jun 2009 02:51:59 GMT |
-| |
-| X-MinorVersion: 1 |
-| |
-| X-PatchVersion: 0 |
-| |
-| X-LatestVersion: 7.1 |
-| |
-| { |
-| |
-| “requestError”: { |
-| |
-| “serviceException”: { |
-| |
-| “messageId”: “SVC2000”, |
-| |
-| “text”: “Missing Parameter: %1. Error code is %2” |
-| |
-| “variables”: [ |
-| |
-| “severity”, |
-| |
-| “400” |
-| |
-| ] |
-| |
-| } |
-| |
-| } |
-| |
-| } |
-+-----------------------------------------------------+
-
-Terminology
-===========
-
-Terminology used in this document is summarized below:
-
-**A&AI**. Active & Available Inventory is the ONAP component that
-provides data views of Customer Subscriptions, Products, Services,
-Resources, and their relationships.
-
-**Alarm Condition**. Short name of the alarm condition/problem, such as
-a trap name.
-
-**APPC (formerly APP-C)**. Application Controller. Handles the life
-cycle management of Virtual Network Functions (VNFs).
-
-**ASDC**. AT&T Service Design and Creation Platform: the original name
-for the SDC. Replaced by SDC.
-
-**Common Event Format**. A JSON schema describing events sent to the VES
-Event Listener.
-
-**Common Event Header**. A component of the Common Event Format JSON
-structure. This datatype consists of fields common to all events.
-
-**DCAE**. Data Collection Analysis and Events. DCAE is the ONAP
-subsystem that supports closed loop control and higher-level correlation
-for business and operations activities. DCAE collects performance,
-usage, and configuration data, provides computation of analytics, aids
-in trouble-shooting and management, and publishes event, data, and
-analytics to the rest of the ONAP system for FCAPS functionality.
-
-**DMaaP.** Data Movement as a Platform. A set of common services
-provided by ONAP, including a Message Router, Data Router, and a Data
-Bus Controller.
-
-**Domain**. In VES, an event ‘domain’ identifies a broad category of
-events (e.g., ‘fault’ or ‘measurement’), each of which is associated
-with a VES domain field block, which is sent with the commonEventHeader
-when events of that category are generated.
-
-**ECOMP**. Enhanced Control, Orchestration, Management and Policy
-preceded ONAP and is the name given to AT&T’s instance of the ONAP
-platform.
-
-**Epoch**. The number of seconds that have elapsed since
-00:00:00 \ `Coordinated Universal
-Time <https://en.wikipedia.org/wiki/Coordinated_Universal_Time>`__ (UTC),
-Thursday, 1 January 1970. Every day is treated as if it contains exactly
-86400 seconds, so \ `leap
-seconds <https://en.wikipedia.org/wiki/Leap_second>`__ are not applied
-to seconds since the Epoch. In VES Epoch times are measured in
-microseconds.
-
-**Event.** A well-structured packet of network management information
-identified by an eventName which is asynchronously communicated to one
-or more instances of an Event Listener service to subscribers interested
-in that eventName. Events can convey measurements, faults, syslogs,
-threshold crossing alerts, and others types of information.
-
-**Event Id**. Event key that is unique to the event source. The key must
-be unique within notification life cycle similar to EventID from 3GPP.
-It could be a sequential number, or a composite key formed from the
-event fields, such as sourceName\_alarmCondition\_startEpoch. The
-eventId should not include whitespace. For fault events, eventId is the
-eventId of the initial alarm; if the same alarm is raised again for
-changed, acknowledged or cleared cases, eventId must be the same as the
-initial alarm (along with the same startEpochMicrosec and an incremental
-sequence number.
-
-**Event Name**. Identifier for specific types of events. Specific
-eventNames registered by the YAML may require that certain fields, which
-are optional in the Common Event Format, be present when events with
-that eventName are published.
-
-**Event Streaming**. The delivery of network management event
-information in real time.
-
-**Extensible Data Structures**. Data structures (e.g., hashMap) that
-allow event sources to send information not specifically identified in
-the VES schema.
-
-**Hash Map**. A hash table, or data structure, used to implement an
-associative array, a structure than can map keys to values. In VES 6.0,
-all name-value pair structures were changed to hash maps (i.e., {‘name’:
-‘keyName’, ‘value’: ‘keyValue’} was replaced with {‘keyName’:
-‘keyValue’}).
-
-**ICE**. Incubation and Certification Environment. Facilitates vendors
-and third-party in developing virtual network functions using ONAP and a
-network cloud.
-
-**IPMI**. The `Intelligent Platform Management
-Interface <https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface>`__.
-
-**JSON**. Java Script Object Notation. JSON is an
-`open-standard <https://en.wikipedia.org/wiki/Open_standard>`__ `file
-format <https://en.wikipedia.org/wiki/File_format>`__ that uses
-`human-readable <https://en.wikipedia.org/wiki/Human-readable_medium>`__
-text to transmit data objects consisting of `attribute–value
-pairs <https://en.wikipedia.org/wiki/Attribute%E2%80%93value_pair>`__
-and `array data types <https://en.wikipedia.org/wiki/Array_data_type>`__
-(or any other
-`serializable <https://en.wikipedia.org/wiki/Serialization>`__ value).
-It is a very common `data <https://en.wikipedia.org/wiki/Data>`__ format
-used for
-`asynchronous <https://en.wikipedia.org/wiki/Asynchronous_I/O>`__
-browser–server communication.
-
-**NF**. Network Function. Generalized name for a VNF or PNF.
-
-**NFC**. Network Function Component. Generalized name for a VNFC or a
-component of a PNF.
-
-**ONAP**. `Open Network Automation Platform <https://www.onap.org/>`__.
-
-**PNF**. Physical Network Function.
-
-**Policy**. Course of action for the management of the network. The ONAP
-Policy Framework is a comprehensive policy design, deployment, and
-execution environment. The Policy Framework is the ***decision making***
-component in `an ONAP
-system <https://www.onap.org/wp-content/uploads/sites/20/2017/12/ONAP_CaseSolution_Architecture_120817_FNL.pdf>`__.
-It allows you to specify, deploy, and execute the governance of the
-features and functions in your ONAP system, be they closed loop,
-orchestration, or more traditional open loop use case implementations.
-The Policy Framework is the component that is the source of truth for
-all policy decisions.
-
-**Reporting Entity Name**. Name of the entity reporting the event or
-detecting a problem in another vnf/vm or pnf which is experiencing the
-problem. May be the same as the sourceName. Not used for performance
-measurements currently.
-
-**SDC**. Service Design and Creation Platform: The ONAP visual modeling
-and design tool. It creates internal metadata that describes assets used
-by all ONAP components, both at design time and run time. The SDC
-manages the content of a catalog, and assemblies of selected catalog to
-define how and when VNFs are realized in a target environment.
-
-**Source Name**: Name of the entity experiencing the event issue, which
-may be detected and reported by a separate reporting entity. The
-sourceName identifies the device for which data is collected. A valid
-sourceName must be inventoried in A&AI.
-
-**Specific Problem**. Description of the alarm or problem.
-
-**VES**. Virtual Function Event Stream. In 6.0, the definition of VES
-was expanded to include event streaming for VNF, PNF and infrastructure.
-The VES Event Listener can receive any event sent in the VES Common
-Event Format.
-
-**VES Event Listener**. A RESTful connectionless push event listener
-capable of receiving single events or batches of events sent in the
-Common Event Format.
-
-**VM**. Virtual Machine.
-
-**VNF**. Virtual Network Function. A VNF is a virtualized task formerly
-carried out by proprietary, dedicated network hardware. (Examples:
-virtual firewall, virtual DNS). A VNF can also be defined as a specific
-kind of Vendor Software Product.
-
-**YAML**. A `data serialization
-language <https://en.wikipedia.org/wiki/Data_serialization_language>`__
-and superset of JSON.
-
-**VNFC**. Virtual Network Function Component. A VNFC is a part of a VNF.
-It is a stand-alone executable that is loosely-coupled, granular,
-re-usable, and responsible for a single capability.
-
-Appendix: Historical Change Log
-===============================
-
-For the latest changes, see the Change Block just before the Table of
-Contents.
-
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Date | Revision | Description |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 5/22/2015 | 0.1 | Initial Release - Draft |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 5/29/2015 | 0.2 | - Introduction: removed all system names and references to internal AT&T components |
-| | | |
-| | | - Security: changed ‘event publisher’ to ‘event source’ |
-| | | |
-| | | - Generic Event Format: updated the JSON schema per the below: |
-| | | |
-| | | - eventHeader: clarified the description of id, made sourceId a required field, changed the datatype of timestamps to timestamp [ ] |
-| | | |
-| | | - performanceFields: removed overflowFields |
-| | | |
-| | | - tmestamp: added a description of this datatype |
-| | | |
-| | | - Exceptions: fixed indentation of sections |
-| | | |
-| | | - Approvers: updated the list of approvers and added attuids |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/3/2015 | 0.3 | - Updated the security section to use HTTP Basic Authentication per AT&T REST standards. Updated the input parameters and messaging examples to use the new security scheme. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/5/2015 | 0.4 | - Added otherFields sub section to the defined datatypes |
-| | | |
-| | | - Added locale field to the eventHeader. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/5/2015 | 0.5 | - Updated the embedded event format json schema to match the changes made in v0.4 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/10/2015 | 0.6 | - Updated the {ServerRoot} format to contain an optional routing path (for D2 service modules). |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/7/2015 | 0.7 | Common Event Format updates: |
-| | | |
-| | | - EventHeader: added ‘measurement’ to the ‘domain’ enumeration; changed ‘locale’ to ‘location’ and clarified in the description that this should be a clli code |
-| | | |
-| | | - Added a MeasurementFields datatype, which required the addition of the following datatypes: codecsInUse, cpuUsage, diskUsage, featuresInUse, memoryUsage |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/15/2015 | 1.0 | - Changed sourceInstance in the eventHeader to be an array of name value pairs |
-| | | |
-| | | - Changed the performanceFields block to thresholdCrossingAlertFields. Updated the domain field of the eventHeader to match. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/23/2015 | v1.1 | Changes to eventHeader data format: |
-| | | |
-| | | - moved sourceInstance to internalHeaderFields |
-| | | |
-| | | - moved serviceInstanceId to internalHeaderFields |
-| | | |
-| | | - moved productId to internalHeaderFields |
-| | | |
-| | | - moved subscriberId to internalHeaderFields |
-| | | |
-| | | - moved location to internalHeaderFields |
-| | | |
-| | | - added the following new fields in internalHeaderFields: policyType, policyName, correlationEventType, correlationType, correlationName, correlationRootEventId |
-| | | |
-| | | - Changes to faultFields data format: |
-| | | |
-| | | - moved the eventSourceDeviceDescription to internalFaultFields and renamed it equipmentVendorModel |
-| | | |
-| | | - moved eventSourceHostname to internalFaultFields |
-| | | |
-| | | - changed alarmObjectInterface to alarmInterfaceA |
-| | | |
-| | | - changed alarmRemoteObject to alarmRemoteObjectZ and moved it to internalFaultFields |
-| | | |
-| | | - changed alarmRemoteObjectInterface to alarmInterfaceZ and moved it to internalFaultFields |
-| | | |
-| | | - Changes to thresholdCrossingFields data format: |
-| | | |
-| | | - changed several references from the old ‘performanceFields’ block to the new ‘thresholdCrossingFields’ block |
-| | | |
-| | | - Other: |
-| | | |
-| | | - Fixed several comma and colon syntax errors in the JSON schema as detected by a JSON schema syntax checker. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/11/2015 | v1.2 | Timestamp format: |
-| | | |
-| | | - Section 4.18: added a note in the datetime field of the Timestamp datatype specifying the (GMT) format required |
-| | | |
-| | | - Updated the JSON schema with the same information |
-| | | |
-| | | Event Header Severity Enumeration: |
-| | | |
-| | | - Section 4.8: modified the severity enumeration to remove the numbers in parentheses that followed the names. The names were not changed. |
-| | | |
-| | | - Updated the JSON schema with the same information. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/20/2015 | v1.3 | JSON Schema rev’d to v9: |
-| | | |
-| | | - Alphabetized all fields in the JSON schema |
-| | | |
-| | | - Fixed the way arrays were specified (JSON schema syntax issue) |
-| | | |
-| | | Sample Responses: |
-| | | |
-| | | - 2.1.1.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format |
-| | | |
-| | | - 6.2.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format |
-| | | |
-| | | - 6.3.6.1: alphabetized fields, fixed timestamps array depiction, fixed severity enum value to conform to latest format |
-| | | |
-| | | - 6.4.6.1: alphabetized fields, fixed timestamps array depiction, fixed eventList array depection, fixed severity enum value to conform to latest format |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/16/2015 | v1.4 | JSON Schema rev’d to v10: |
-| | | |
-| | | - Fixed an error in the way that the top level “event” object was specified in the v9 json schema. This was discovered when validating examples against the schema using this site: http://json-schema-validator.herokuapp.com/index.jsp. |
-| | | |
-| | | - Changed the embedded json file in section 4 |
-| | | |
-| | | Sample Responses: |
-| | | |
-| | | - Removed an extra comma after the timestamp brace in section 6.2.6 and 6.3.6. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 11/11/2015 | v1.5 | Section 4 was the only section changed: JSON Schema rev’d to v11 and Datatype tables were updated to match. Numerous data structure changes were made based on VNF vendor proof of concept feedback. Modified sample requests and responses to match. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 11/12/2015 | v1.6 | - The internalFaultFields were merged into the internalHeaderFields; then the internalFaultFields datatype was deleted. |
-| | | |
-| | | - Updated the JSON schema to v12. |
-| | | |
-| | | - Also corrected some background color issues in the sample requests and responses. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 1/18/2016 | v1.7 | - Section 2 changes: updated the sample request to conform with the changes below |
-| | | |
-| | | - Section 4 datatype changes: |
-| | | |
-| | | - Changed 'eventHeader' to 'commonEventHeader' |
-| | | |
-| | | - Moved 'eventSeverity' from the 'commonEventHeader' to 'faultFields' |
-| | | |
-| | | - Added 'priority' to 'commonEventHeader' |
-| | | |
-| | | - moved 'vFstatus' to 'faultFields' |
-| | | |
-| | | - removed 'firstDateTime' and 'lastDateTime' and changed 'firstEpoch' to 'startEpochMicrosec' and changed 'lastEpoch' to 'lastEpochMicrosec'. |
-| | | |
-| | | - Added 'functionalRole' to the commonEventHeader |
-| | | |
-| | | - In the commonEventHeader, changed the 'eventDomain' enumeration to remove 'measurements' and add 'measurementsForVfScaling'. |
-| | | |
-| | | - Changed the 'measurementFields' to 'measurementsForVfScalingFields' |
-| | | |
-| | | - In the commonEventHeader, changed the following fields: |
-| | | |
-| | | - 'eventDomain' to 'domain' |
-| | | |
-| | | - 'eventSequence' to 'sequence' |
-| | | |
-| | | - 'eventSourceId' to 'sourceId' |
-| | | |
-| | | - 'eventSounceName' to 'sourceName' |
-| | | |
-| | | - Updated the JSON schema to v13 |
-| | | |
-| | | - Section 6 changes: updated the input parameters and sample requests to conform to the changes above. |
-| | | |
-| | | - Section 7: changed the section from Approvers to Contributors. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 1/22/2016 | v1.8 | - Section 4: Added support for ‘mobileFlow’ in the commonEventHeader ‘domain’ enumeration. Added the mobileFlowFields datatype and the gtpPerFlowMetrics datatype referenced by that datatype. |
-| | | |
-| | | - Section 7: alphabetized the contributors |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 2/11/2016 | v1.9 | - Added section 1.3: Naming Standard for Event Types |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 2/12/2016 | v2.0 | - Updated request – response examples to reflect the naming standards for event types introduced in v1.9. |
-| | | |
-| | | - Added a paragraph on use of Avro as a transport in section 1.4 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/11/2016 | v2.1 | - Updated the embedded JSON schema to v15 to fix a typo in the required fields for the measurementsForVfScalingFields, namely, changed ‘configuredEntites’ to ‘configuredEntities’. Additionally, added an ‘Event Listener’ title block at the bottom of the file with a single required event object. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/15/2016 | v2.2 | - Added mobileFlowFields to the event datatype definition in section 4.7 and updated the embedded json schema at the top of section 4 to v16. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 4/26/2016 | v2.3 | - Generic Event Format updates: 1) made ‘priority’ lowercase in the Word doc table for commonEventHeader; 2) added ‘requestError’ data structure to the Word doc and JSON schema (which is now at v17) |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 4/27/2016 | v2.4 | - JSON Schema: In the 'event' data structure, changed 'thresholdCrossingFields' to 'thresholdCrossingAlertFields' to product v18 of the schema. |
-| | | |
-| | | - 'codecsInUse' data structure: changed 'numberInUse' to 'codecUtilization’ |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 5/26/2016 | v2.5 | - Changed responses from ‘204 No Content’ to ‘202 Accepted’ and added a body to the response that enable AT&T to throttle the events being sent and/or to request the current state of throttling at the event source. |
-| | | |
-| | | - Added new datatypes to support the above: eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs |
-| | | |
-| | | - Modifed the commonEventFormat json schema to v19 |
-| | | |
-| | | - Note: for the VendorEventListener: added new licensing language on the back of the title page; added an “attCopyrightNotice” definition at the top of the commonEventFormat\_Vendors.json file; also removed all references to internalHeaderFields from this file and from the VendorEventListener spec. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/9/2016 | v2.6 | - commonHeader: added a note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info" |
-| | | |
-| | | - commonHeader: deleted the capacity, measurementsForVfScaling and usage domains in the domain enumeration |
-| | | |
-| | | - commonHeader: added the following domains to the domain enumeration: licensingKci, scalingKpi, stateChange |
-| | | |
-| | | - event: removed references to capacityFields, measurementsForVfScalingFields and usageFields and added references to licensingKciFields, scalingKpiFields, stateChangeFields |
-| | | |
-| | | - licensingKciFields: added this section along with 'additionalMeasurements', which is an optional list of measurementGroup structures. Changed the name of kciFieldsVersion to licensingKciFieldsVersion. |
-| | | |
-| | | - scalingKpiFields: added this section but changed measurementFieldsVersion to scalingKpiFieldsVersion |
-| | | |
-| | | - stateChangeFields: added this section along with 'additionalFields', which is an optional list of name-value pairs. Other fields included newState and oldState which were enumerations of the following possible states: 'inService', 'maintenance', 'outOfService' |
-| | | |
-| | | - sysLogFields: added 'additionalFields', which is an optional list of name-value pairs |
-| | | |
-| | | - vNicUsage: added two required fields to the vNicUsage data structure: packetsIn and packetsOut |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/10/2016 | v2.7 | - commonHeader: removed the note on the description of sourceId and sourceName in the commonHeader: "use reportingEntity for domains that provide more detailed source info" |
-| | | |
-| | | - commonHeader: added measurementsForVfScaling domain back and removed the licensingKci and scalingKpi domains |
-| | | |
-| | | - event: removed references to licensingKciFields and scalingKpiFields; added references to measurementsForVfScalingFields |
-| | | |
-| | | - measurementsForVfScalingFields: combined the kciDetail and kpiDetail structures into the measurementsForVfScalingFields structure; referenced the errors structure |
-| | | |
-| | | - errors: added a new structure to capture the receive and transmit errors for the measurements domain |
-| | | |
-| | | - removed the following structures: kci, kpi, scalingKpiFields and licensingKciFields |
-| | | |
-| | | - eventDomainThrottleSpecification: updated the reference to commonEventHeader domain field |
-| | | |
-| | | - faultFields: removed the numbers from the enumerated strings for eventSourceType |
-| | | |
-| | | - vNicUsage: made the broadcast, multicast and unicast fields optional |
-| | | |
-| | | - contributors: updated Alok’s organizational area |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/12/2016 | v2.8 | - commonHeader: copied the descriptions of sourceId and sourceName from the JSON schema into the word document tables. |
-| | | |
-| | | - sample request examples: moved the reportingEntityId and reportingEntityNames to the same relative place in all sample requests in the document |
-| | | |
-| | | - Fixed the sample request shown for publishEventBatch to take an eventList as input. |
-| | | |
-| | | - Fixed the sample request shown for publishSpecificTopic to put the topic in the URL |
-| | | |
-| | | - errors: changed the receiveErrors and transmitErrors fields to be datatype number |
-| | | |
-| | | - codesInUse: changed 'codecUtilization' to 'numberinUse' |
-| | | |
-| | | - vNicUsage: updated the description of the fields |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 8/27/2016 | v2.9 | - Added a note "(currently: 1.1)" in the descriptions of the following fields: commonEventHeader:version, faultFields:faultFieldsVersion, measurementsForVfScalingFields:measurementsForVfScalingFieldsVersion, stateChangeFields:stateChangeFieldsVersion, sysLogFields:syslogFieldsVersion, thresholdCrossingAlertFields:thresholdCrossingFieldsVersion |
-| | | |
-| | | - stateChangeFields: made stateInterface mandatory |
-| | | |
-| | | - changed 'enum' to 'enumeration' throughout section 4 of the document (note: this can't be done in the JSON schema). |
-| | | |
-| | | - measurementsForVfScalingFields: made the following fields optional: conurrentSessions, configuredEntitites, cpuUsageArray, fileSystemUsageArray, memoryConfigured, memoryUsed, requestRate, vNicUsageArray |
-| | | |
-| | | - measurementsForVfScalingFields: concurrentSessions and configuredEntities: changed the description to support both VMs and VNFs |
-| | | |
-| | | - measurementsFor VfScalingFields: clarified the descriptions of latencyDistribution, measurementInverval and requestRate |
-| | | |
-| | | - syslogFields: clarified the descriptions of syslogSData, syslogTag, syslogVer |
-| | | |
-| | | - thresholdCrossingAlertFields: made the following fields optional and clarified their descriptions: elementType, networkService |
-| | | |
-| | | - command and commandList: created a list of command structures to enable the event collector to request changes of event sources. Commands consist of a commandType along with optional fields (whose presence is indicated by the commandType). Three command types are currently supported: 'measurementIntevalChange', ‘provideThrottlingState’ and 'throttlingSpecification'. |
-| | | |
-| | | - eventDomainThrottleSpecificationList: removed this and replaced it with commandList. |
-| | | |
-| | | - Operations and Sample Requests: modified the operations and samples to support the new command and commandList structures. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/1/2016 | v2.10 | - measurementsForVfScaling block: made the following fields optional: latencyDistribution (which is an array of latencyBucketMeasure structures) and meanRequestLatency. Updated the JSON schemas (now v24) to match. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/16/2016 | v2.11 | - 1 Introduction: updated the introduction to clarify the usage of eventTypes and the possibility of support for other protocols. |
-| | | |
-| | | - 6.1 REST Operation Overview: added two new subsections (6.1.2 and 6.1.3) discussing Api Version and Commands Toward Event Source Clients. |
-| | | |
-| | | - 6.2 publishAnyEvent: fixed the sample to conform to the latest changes |
-| | | |
-| | | - 6.3 publishSpecificTopic: fixed the sample to conform to the latest changes |
-| | | |
-| | | - 6.4 publishEventBatch: fixed the sample to conform to the latest changes |
-| | | |
-| | | - 6.5 provideThrottlingState operation: added the Input Parameters section heading back and fixed the sample request to provide eventThrottlingState (instead of eventThrottlingClientState). |
-| | | |
-| | | - The remaining bullets describe changes made to section 4 datatypes in alphabetical order: |
-| | | |
-| | | - command datatype: referenced the new section 6.1.3 which provides an explanation of command state expectations and requirements for a given eventSource: |
-| | | |
-| | | - commonEventHeader datatype: |
-| | | |
-| | | - made sourceId and reportingEntityId fields optional (although the internal Generic Event Listener spec indicates, in the field descriptions, that the AT&T enrichment process shall ensure that these fields are populated) |
-| | | |
-| | | - domain enumeration: changed measurementsForVfScalingFields to measurementsForVfScaling |
-| | | |
-| | | - eventDomainThrottleSpecificationList: added this array of eventDomainThrottleSpecification stuctures back to the schema because it is used by the provideThrottlingState operation. |
-| | | |
-| | | - eventList: added eventList back to the vendor version of the commonEventFormat. This is used by the publishEventBatch operation. |
-| | | |
-| | | - faultFields datatype: |
-| | | |
-| | | - eventSourceType: made this a string (and provided the previous enumerated values as examples) |
-| | | |
-| | | - filesystemUsage datatype: |
-| | | |
-| | | - changed vmIdentifier to filesystemName |
-| | | |
-| | | - gtpPerFlowMetrics datatype: |
-| | | |
-| | | - flowActivationTime: changed the format and description to be compliant with RFC 2822. |
-| | | |
-| | | - flowDeactivationTime: changed the format and description to be compliant with RFC 2822. |
-| | | |
-| | | - internalHeaderFields datatype: |
-| | | |
-| | | - Added the following optional fields: firstDateTime, lastDateTime compliant with RFC 2822. Noted in the description that these fields must be supplied for events in the following domains: fault, thresholdCrossingAlerts and measurementsForVfScaling. |
-| | | |
-| | | - ticketingTimestamp: changed the format and description to be compliant with RFC 2822. |
-| | | |
-| | | - syslogFields datatype: |
-| | | |
-| | | - eventSourceType: made this a string (and provided the previous enumerated values, without the numbers, as examples) |
-| | | |
-| | | - thresholdCrossingAlerts dataypte: |
-| | | |
-| | | - collectionTimestamp: changed the format and description to be compliant with RFC 2822. |
-| | | |
-| | | - eventStartTimestamp: changed the format and description to be compliant with RFC 2822. |
-| | | |
-| | | - added the same eventSeverity field as from the faultFields and made it required |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/23/2016 | v2.12 | - Section 4 Datatypes: commonEventHeader: made reportingEntityName a required field (note: the JSON schema already had this field as required) |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 11/29/2016 | v3.0 | - Introduction: |
-| | | |
-| | | - Introductory paragraph: changed '...Common Event Header Block followed by zero or more event domain blocks' to '...Common Event Header Block accompanied by zero or more event domain blocks' since the order of the blocks on the wire is not guaranteed. |
-| | | |
-| | | - Added Section 1.5 Versioning |
-| | | |
-| | | - Section 4: codec processing: |
-| | | |
-| | | - CommonEventFormat\_Vendors schema only: codesInUse: changed required field from "codecUtilization" which was removed previously to "numberInUse" which is the new field name. |
-| | | |
-| | | - added ‘codecSelected’ datatype |
-| | | |
-| | | - added ‘codecSelectedTranscoding’ datatype |
-| | | |
-| | | - Section 4 and section 6: command processing: |
-| | | |
-| | | - Added commandListEntry which is an object that references the command object. |
-| | | |
-| | | - commandList: changed commandList to contain an array of commandListEntry objects. |
-| | | |
-| | | - Updated sample responses in section 6 where commands are used |
-| | | |
-| | | - Section 4: commonEventHeader: |
-| | | |
-| | | - Incremented version to 1.2 |
-| | | |
-| | | - added two new values to the ‘domain’ enumeration: ‘serviceEvents’ and ‘signaling |
-| | | |
-| | | - Section 4: added endOfCallVqmSummaries datatype |
-| | | |
-| | | - Section 4: ‘event’: added two fields: ‘serviceEventsFields’ and ‘signalingFields’ |
-| | | |
-| | | - Section 4: added ‘eventInstanceIdentifier’datatype |
-| | | |
-| | | - Section 4: CommonEventListener only: internalHeaderFields: |
-| | | |
-| | | - added ‘internalHeaderFieldsVersion’(initially set to 1.1) |
-| | | |
-| | | - added ‘correlationFirstEpoch’ |
-| | | |
-| | | - added 'closedLoopControlName' |
-| | | |
-| | | - added 'closedLoopFlag' |
-| | | |
-| | | - added 'collectorTimeStamp' |
-| | | |
-| | | - added 'eventTag' |
-| | | |
-| | | - added ‘tenantName’ |
-| | | |
-| | | - changed 'operationalStatus' to 'inMaint' |
-| | | |
-| | | - added required fields in the schema to match the word doc: 'equipmentNameCode', 'equipmentType', 'equipmentVendor', 'inMaint', 'provStatus' |
-| | | |
-| | | - Section 4: added ‘marker’datatype |
-| | | |
-| | | - Section 4: added ‘midCallRtcp’ datatype |
-| | | |
-| | | - Section 4: mobileFlowFields: |
-| | | |
-| | | - added ‘mobileFlowFieldsVersion’(initially set to 1.1) |
-| | | |
-| | | - Section 4: added ‘serviceEventsFields’datatype |
-| | | |
-| | | - Section 4: added ‘signalingFields’ datatype |
-| | | |
-| | | - Section 4: syslogFields: |
-| | | |
-| | | - Incremented syslogFieldsVersion to 1.2 |
-| | | |
-| | | - added 'syslogPri' |
-| | | |
-| | | - added 'syslogSev' |
-| | | |
-| | | - added ‘syslogSdId’ |
-| | | |
-| | | - Section 4: thresholdCrossingAlertFields: |
-| | | |
-| | | - Incremented thresholdCrossingFieldsVersion to 1.2 |
-| | | |
-| | | - added 'additionalFields' which is an optional list of name value pairs. |
-| | | |
-| | | - Section 4: schema v26.0 embedded reflecting the above changes. |
-| | | |
-| | | - Section 6 and Section 2: changed all sample requests to use /v3 in the REST Resource URL. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 12/1/2016 | v3.1 | - Section 6: Updated the call flow diagrams to show ‘v3’ |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 1/5/2017 | v4.0 | - Combined the Generic Event Listener and Vendor Event Listener into a single API service specification with version 4.0. |
-| | | |
-| | | - Changed the title to VES (Virtual Function Event Streaming) Listener. |
-| | | |
-| | | - Changed references to 'generic event' to 'common event' or 'VES event' (depending on the context) throughout the document. |
-| | | |
-| | | - Used the Legal Disclaimer from the Vendor Event Listener on the back of the title page. |
-| | | |
-| | | - Section 1: Introduction changes: |
-| | | |
-| | | - modified wording to reference 'VES' |
-| | | |
-| | | - removed the 'Audience' section, which described various AT&T groups the documented was intended for |
-| | | |
-| | | - tweaked the naming standards for event types to clarify the purpose of the naming conventions |
-| | | |
-| | | - Section 3: Resource Structure: added a sentence describing the FQDN and port used in the resource URL. |
-| | | |
-| | | - Section 4: Common Event Format changes: |
-| | | |
-| | | - renamed the section to 'Common Event Format' from 'Generic Event Format' |
-| | | |
-| | | - reorganized the datatypes into separate sections; sections were defined for each of the domains as well as for common event, common event header and command list processing |
-| | | |
-| | | - codecSelected datatype: removed this datatype |
-| | | |
-| | | - codecSelectedTranscoding datatype: removed this datatype |
-| | | |
-| | | - command datatype: added an enumerated value to commandType: 'heartbeatIntervalChange' |
-| | | |
-| | | - commonEventHeader: added internalHeaderFields to the commonEventHeader, defined as "Fields (not supplied by event sources) that the VES Event Listener service can use to enrich the event if needed for efficient internal processing. This is an empty object which is intended to be defined separately by each provider implementing the VES Event Listener." |
-| | | |
-| | | - commonEventHeader: removed two enumerated values, 'serviceEvents' and 'signaling' from the domain enumeration |
-| | | |
-| | | - commonEventHeader version: incremented the version to 2.0 |
-| | | |
-| | | - endOfCallVqmSummaries datatype: removed this datatype |
-| | | |
-| | | - event: changed the description of the event datatype to: "fields which constitute the ‘root level’ of the common event format" |
-| | | |
-| | | - event: removed 'serviceEventFields' and 'signalingFields' from the definition |
-| | | |
-| | | - event: fixed a misspelling of ‘thresholdCrossingAlertFields’, which was only present in the Word document |
-| | | |
-| | | - eventInstanceIdentifier datatype: removed this datatype |
-| | | |
-| | | - internalHeaderFIelds datatype: defined this as follows: "The internalHeaderFields datatype is an undefined object which can contain arbitrarily complex JSON structures. It is intended to be defined separately by each provider implementing the VES Event Listener. The fields in internalHeaderFields are not provided by any event source but instead are added by the VES Event Listener service itself as part of an event enrichment process necessary for efficient internal processing of events received by the VES Event Listener" |
-| | | |
-| | | - marker datatype: removed this datatype |
-| | | |
-| | | - measurementsForVfScalingFields datatype: clarified that memoryConfigured and memoryUsed are measured in MB |
-| | | |
-| | | - midCallRtcp datatype: removed this datatype |
-| | | |
-| | | - mobileFlowFields datatype: added ‘additionalFields’ |
-| | | |
-| | | - mobileFlowFields datatype: incremented the version number for this field block to 1.2 |
-| | | |
-| | | - serviceEventsFields datatype: removed this datatype |
-| | | |
-| | | - signalingFields datatype: removed this datatype |
-| | | |
-| | | - syslogFields: added three fields to the schema that were previously described in the document but not incorporated into the schema: syslogPri, syslogSev, syslogSdId |
-| | | |
-| | | - syslogFields version: incremented the version to 2.0 |
-| | | |
-| | | - Modified the Common Event Format JSON schema to v27.0 to incorporate the above changes. Also, added the AT&T Copyright Notice from the top of the retired CommonEventFormat\_Vendors schema. |
-| | | |
-| | | - Section 6 and 2: changed all sample requests to use /v4 in the REST Resource URL and call flow diagrams. |
-| | | |
-| | | - Section 6.1.3: added a row to the table in this section describing the ‘heartbeatIntervalChange’ command. |
-| | | |
-| | | - Section 6.1.4: added this new section describing expectations for buffering of events should all REST resource URL FQDNs be unreachable. |
-| | | |
-| | | - Section 6 Sample Requests: modified all sample requests showing the return of a commandList toward the event source to incorporate a heartbeatIntervalChange command; also corrected the spelling in the samples for the measurementIntervalChange command. |
-| | | |
-| | | - Section 7: Contributors: removed this section |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 3/21/2017 | v4.1 | - JSON Schema changes to produce v27.2 (note: an earlier draft version of v27.1 had been distributed to a few individuals): |
-| | | |
-| | | - To support use of the schema with event batches, removed the following statement near the end of the schema file: |
-| | | |
-| | | “required”: [ “event” ] |
-| | | |
-| | | - Fixed the characters used in some of the quotes |
-| | | |
-| | | - Fixed some typos in the descriptions. |
-| | | |
-| | | - Removed the booleans, which were non-essential and which were causing problems across different implementations. |
-| | | |
-| | | - Section 4.5.7 measurementsForVfScalingFields: |
-| | | |
-| | | - Fixed the spelling of measurementsForVfScalingFields in the Word document |
-| | | |
-| | | - Section 2 and 6 sample requests and responses: |
-| | | |
-| | | - Removed quotes from numbers: sequence, and first/lastEpochMicrosec. |
-| | | |
-| | | - Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package. |
-| | | |
-| | | - Section 6.2.6.1, 6.3.6.1, 6.4.6.1 sample requests: |
-| | | |
-| | | - Added an alarmAdditionalInformation field array to the sample requests. |
-| | | |
-| | | - Added missing commas. |
-| | | |
-| | | - Section 6.5.6.1 provideThrottlingState sample requests: |
-| | | |
-| | | - Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects. |
-| | | |
-| | | - Added missing quotes. |
-| | | |
-| | | - Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 4/14/2017 | v5.0 | - Section 1 Introduction: |
-| | | |
-| | | - Clarified the Introduction (Section 1). |
-| | | |
-| | | - Changed Section 1.1 title from ‘Terminology’ to 'Event Registration' and referenced the YAML event registration format, defined in a separate document. |
-| | | |
-| | | - Clarified naming standards for eventName. |
-| | | |
-| | | - Section 3: updated the REST resource structure |
-| | | |
-| | | - Section 4.1 command list processing datatypes: |
-| | | |
-| | | - Got rid of commandListEntry and returned commandList to a simple array of commands. |
-| | | |
-| | | - Added heartbeatInterval to the command datatype. |
-| | | |
-| | | - Changed the datatype of measurementInterval from number to integer. |
-| | | |
-| | | - Section 4.2 common event datatypes: |
-| | | |
-| | | - event dataType: Added heartbeatFields, sipSignalingFields and voiceQualityFields to the event datatype as optional field blocks |
-| | | |
-| | | - Added jsonObject which provides a json object schema, name and other meta-information along with one or more object instances. |
-| | | |
-| | | - Added jsonObjectInstance which provides meta-information about an instance of a jsonObject along with the actual object instance |
-| | | |
-| | | - Added the ‘key’ datatype |
-| | | |
-| | | - Added the namedArrayOfFields datatype |
-| | | |
-| | | - Added vendorVnfNameFields |
-| | | |
-| | | - Section 4.3 common event header fields: |
-| | | |
-| | | - Add two new enumerations to domain: ‘sipSignaling’ and ‘voiceQuality’ |
-| | | |
-| | | - Renamed eventType to eventName. Note that the original usage of eventType was formally described in the Introduction back on 2/11/2016 with v1.9. |
-| | | |
-| | | - Made eventName a required field |
-| | | |
-| | | - Created a new field called eventType with a meaning that is different than the old eventType. |
-| | | |
-| | | - Removed functionalRole, which was replaced by the following two fields. |
-| | | |
-| | | - Added nfNamingCode |
-| | | |
-| | | - Added nfcNamingCode |
-| | | |
-| | | - Changed version to 3.0 (major version change) and made it a required field |
-| | | |
-| | | - Section 4.4: faultFields: |
-| | | |
-| | | - added one optional field: eventCategory |
-| | | |
-| | | - made faultFieldsVersion a required field |
-| | | |
-| | | - changed faultFieldsVersion to 2.0 (major version change) |
-| | | |
-| | | - fixed a typo on the spelling of alarmInterfaceA |
-| | | |
-| | | - clarified field descriptions |
-| | | |
-| | | - Section 4.5: added heartbeatFields datatype which can be used to communicate heartbeatInterval. Note: this change was previously made in v4.2 |
-| | | |
-| | | - Section 4.6 measurements for vf scaling datatypes: changed the following datatypes from number to integer: |
-| | | |
-| | | - In measurementsForVfScalingFields: concurrentSessions, configuredEntities, numberOfMediaPortsInUse, vnfcScalingMetric |
-| | | |
-| | | - In codecsInUse: numberInUse |
-| | | |
-| | | - In featuresInUse: featureUtilization |
-| | | |
-| | | - Section 4.6.2 modified cpuUsage |
-| | | |
-| | | - Section 4.6.3 added diskUsage |
-| | | |
-| | | - Section 4.6.7 measurementsForVfScalingFields: |
-| | | |
-| | | - fixed the spelling of the measurementsForVfScalingFields in the Word document |
-| | | |
-| | | - added additionalFields, which is an array of fields (i.e., name-value pairs) |
-| | | |
-| | | - changed additionalMeasurements to reference the common datatype namedArrayOfFields (instead of referencing measurementGroup) |
-| | | |
-| | | - added additionalObjects which is an array of jsonObjects described by name, keys and schema |
-| | | |
-| | | - deleted aggregateCpuUsage |
-| | | |
-| | | - added diskUsageArray |
-| | | |
-| | | - deleted measurementGroup (which was replaced by the common datatype: namedArrayOfFields |
-| | | |
-| | | - added memoryUsageArray |
-| | | |
-| | | - deleted memoryConfigured and memoryUsed |
-| | | |
-| | | - deleted errors and vNicUsageArray |
-| | | |
-| | | - added vNicPerformanceArray |
-| | | |
-| | | - changed the measurementsForVfScalingVersion to 2.0 (major version change) and made it a required field. Also changed the name of this version field in the Word document to match that in the JSON schema. |
-| | | |
-| | | - Section 4.6.8 added memoryUsage |
-| | | |
-| | | - Section 4.6.9 vNicPerformance: replaced vNicUsage and errors with vNicPerformance |
-| | | |
-| | | - Section 4.7 mobile flow fields changes: |
-| | | |
-| | | - Made mobileFlowFieldsVersion a required field and changed the mobileFlowFieldsVersion to 2.0 (major version change). |
-| | | |
-| | | - Changed the datatype of flowActivationTime and flowDeactivationTime in the Word doc to string. |
-| | | |
-| | | - changed the following datatypes from number to integer: otherEndpointPort, reportingEndpointPort, samplingAlgorithm |
-| | | |
-| | | - Section 4.8: otherFields: |
-| | | |
-| | | - Added otherFieldsVersion (set at 1.1) |
-| | | |
-| | | - Added hashOfNameValuePairArrays |
-| | | |
-| | | - Added jsonObjects |
-| | | |
-| | | - Added nameValuePairs |
-| | | |
-| | | - Section 4.9: added sipSignaling domain datatypes with 4.8.1 sipSignalingFields. sipSignalingFieldsVersion is set at 1.0 |
-| | | |
-| | | - Section 4.10 stateChangeFields: made stateChangeFieldsVersion a required field and set it to 2.0 (major version change). |
-| | | |
-| | | - Section 4.11 syslogFields: |
-| | | |
-| | | - Changed the following datatypes from number to integer: syslogFacility, syslogPri |
-| | | |
-| | | - Changed additionalFields from a field [ ] to a string which takes name=value pairs delimited by a pipe symbol. |
-| | | |
-| | | - Changed syslogFieldsVersion to 3.0 (major version change) and made it a required field |
-| | | |
-| | | - Made syslogSev an enumerated string (previously just a string) |
-| | | |
-| | | - Section 4.12 thresholdCrossingAlertFields: made thresholdCrossingFieldsVersion a required field and set it to 2.0 (major version change). |
-| | | |
-| | | - Section 4.132: added voice quality domain datatypes with 4.13.1 endOfCallVqmSummaries and 4.13.2 voiceQualityFields. voiceQualityFieldsVersion is set at 1.0 |
-| | | |
-| | | - JSON Schema: changed the schema to v28.0 and incorporated all of the changes above. |
-| | | |
-| | | - Additional JSON Schema changes that are part of v28: Note: The following changes are provided relative to API Spec v4.0 (which embedded JSON schema v27.0), but they were also made in an interim release v4.1 (which embedded JSON schema v27.2): |
-| | | |
-| | | - To support use of the schema with event batches, removed the following statement near the end of the schema file: |
-| | | |
-| | | “required”: [ “event” ] |
-| | | |
-| | | - Fixed the characters used in some of the quotes |
-| | | |
-| | | - Fixed some typos in the descriptions. |
-| | | |
-| | | - Removed the booleans, which were non-essential and which were causing problems across different implementations. |
-| | | |
-| | | - Section 2 and 6 sample requests and responses (also incorporated in interim release 4.1): |
-| | | |
-| | | - Removed quotes from numbers: sequence, and first/lastEpochMicrosec. |
-| | | |
-| | | - Fixed all quote characters, some of which were using unusual symbols that wouldn’t validate with the json-schema Python package. |
-| | | |
-| | | - Section 2 and 6 sample requests and responses (only in v5.0): |
-| | | |
-| | | - Changed the version numbers in the URL string. |
-| | | |
-| | | - Added nfNamingCode and nfcNamingCode and removed functionalRole |
-| | | |
-| | | - Section 6 call flows: updated the version number (only in v5.0). |
-| | | |
-| | | - Section 6: removed the publishSpecificTopic operation |
-| | | |
-| | | - Section 6.1.4: Buffering: clarified event source expectations for buffering (only in v5.0). |
-| | | |
-| | | - Section 6.2.6.1, 6.3.6.1 sample requests (also incorporated in interim release 4.1): |
-| | | |
-| | | - Added an alarmAdditionalInformation field array to the sample requests. |
-| | | |
-| | | - Added missing commas. |
-| | | |
-| | | - Section 6.2.6.3, 6.3.6.3 commandList sample responses (only in v5.0): |
-| | | |
-| | | - Fixed the commandList sample responses to pass an array of anonymous command objects (rather than an array of commandListEntry objects). |
-| | | |
-| | | - Fixed the heartbeatIntervalChange commandType to pass a heartbeatInterval value instead of a measurementInterval value. |
-| | | |
-| | | - Removed quotes from the measurementInterval and heartbeatInterval values since they are numbers. |
-| | | |
-| | | - Section 6.4.6.1 provideThrottlingState sample requests (also incorporated in interim release 4.1): |
-| | | |
-| | | - Fixed the eventDomainThrottleSpecificationList to pass an array of anonymous eventDomainThrottleSpecification objects. |
-| | | |
-| | | - Added missing quotes. |
-| | | |
-| | | - Fixed the suppressedNvPairsList to pass an array of anonymous suppressedNvPairs objects (also incorporated in interim release 4.1). |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 5/22/2017 | v5.1 | - Footers: removed proprietary markings and updated copyrights to 2017 |
-| | | |
-| | | - Section 4.2.3: field: |
-| | | |
-| | | - Changed the API spec to make ‘name’ and ‘value’ start with lowercase letters. Note: this did not affect the schema, which already had them as lowercase. |
-| | | |
-| | | - JSON Schema: |
-| | | |
-| | | - measurementGroup: deleted this object since it was replaced with ‘namedArrayOfFields’ in v28.0 and was no longer being used. |
-| | | |
-| | | - namedArrayOfFields: Fixed an error in the specification of required fields: from ‘measurements’ to ‘arrayOfFields’. |
-| | | |
-| | | - Changed the version of the JSON schema to 28.1 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/14/2017 | v5.2 | - JSON Schema: created v28.2 by changing the field descriptions in the memoryUsage object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the 28.1 structure. |
-| | | |
-| | | - Word Document: measurementsForVfScaling Domain: memoryUsage object: changed the field descriptions in this object to refer to ‘kibibytes’ instead of ‘kilobytes’. There were no changes to the memoryUsage structure. |
-| | | |
-| | | - Reorganized the Word document to group the data structures in Section 4 into three broad categories to better align with the VNF Guidelines documentation that has been prepared for vendors: |
-| | | |
-| | | - Common Event Datatypes: |
-| | | |
-| | | - Command List Processing Datatypes |
-| | | |
-| | | - Common Event Datatypes |
-| | | |
-| | | - Common Event Header Datatypes |
-| | | |
-| | | - Technology Independent Datatypes: |
-| | | |
-| | | - ‘Fault Domain Datatypes |
-| | | |
-| | | - ‘Heartbeat’ Domain Datatypes |
-| | | |
-| | | - ‘Measurements For Vf Scaling’ Domain Datatypes |
-| | | |
-| | | - ‘Other’ Domain Datatypes |
-| | | |
-| | | - ‘State Change’ Domain Datatypes |
-| | | |
-| | | - ‘Syslog’ Domain Datatypes |
-| | | |
-| | | - ‘Threshold Crossing Alert’ Domain Datatypes |
-| | | |
-| | | - Technology Specify Datatypes: |
-| | | |
-| | | - ‘Mobile Flow’ Domain Datatypes |
-| | | |
-| | | - ‘Sip Signaling’ Domain Datatypes |
-| | | |
-| | | - ‘Voice Quality’ Domain Datatypes |
-| | | |
-| | | - Section 6.1.3: Commands Toward Event Source Clients: Added a statement: “Note: Vendors are not currently required to implement support for command processing; in addition, command processing may be supported by an App-C interface in future.” |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/22/2017 | v5.3 | - JSON Schema: created v28.3 by correcting an error in the sipSignalingFields: changed vnfVendorNameFields to vendorVnfNameFields. Embedded the new schema at the top of section 4. |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/12/2017 | v5.4 | - Note: There no changes to any data structures or operations in this version. |
-| | | |
-| | | - JSON Schema: created v28.4 embedded at the top of section 4: |
-| | | |
-| | | - Added a reference to eventList in the properties defined under the schema title. This enables the schema to correctly validate event batches in addition to just events. |
-| | | |
-| | | - Moved the schema title to the top of the schema and changed the text from “Event Listener” to “VES Event Listener” |
-| | | |
-| | | - Added a schema header block under the title to clearly communicate the schema version, associated API and last-modified information |
-| | | |
-| | | - Changed the date in the copyright notice to 2017 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 9/19/2017 | v5.4.1 | - Note: There no changes to any data structures or operations in this version. |
-| | | |
-| | | - Back of Cover Page: updated the license and copyright notice to comply with ONAP guidelines |
-| | | |
-| | | - JSON Schema: updated the JSON schema to v28.4.1: updated the copyright notice and license to comply with ONAP guidelines |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 6/28/2018 | v6.0 | - Added contributors to the title page. |
-| | | |
-| | | - Updated references to ‘vnf’ ‘vnfc’ to either ‘nf’ and ‘nfc’ or ‘xNf’ and ‘xNfc’ to generalize support across both vnfs and pnfs. |
-| | | |
-| | | - Section 1: |
-| | | |
-| | | - clarified the meaning of the VES acronym |
-| | | |
-| | | - changed references from ASDC to SDC and from MSO to SO |
-| | | |
-| | | - clarified the requirements for eventNames. |
-| | | |
-| | | - Added a section of EventId use case examples |
-| | | |
-| | | - Added a new section on measurement expansion fields |
-| | | |
-| | | - Added a new section of syslogs |
-| | | |
-| | | - clarified the versioning section and referenced the new API Versioning section in section 6. |
-| | | |
-| | | - Added a list of all the latest field block version numbers in this version of the API spec. |
-| | | |
-| | | - Section 2: updated the sample to show use of new HTTP versioning headers. Added a note indicating that support for mutual SSL would be provided in future. |
-| | | |
-| | | - Section 3: updated the resource structure remove the clientThrottlingState resource. |
-| | | |
-| | | - Section 4: hashMaps. Changed all name-value pair structures to hashMaps causing the following data model and JSON schema (to v29.0) changes: |
-| | | |
-| | | - 4.1.1: Common Event Datatypes: |
-| | | |
-| | | - removed "field" and added “hashMap” |
-| | | |
-| | | - removed “namedArrayOfFields” and added “namedHashMap” |
-| | | |
-| | | - added arrayOfNamedHashMap |
-| | | |
-| | | - added arrayOfJsonObject |
-| | | |
-| | | - 4.2.1: Fault Domain Datatypes: |
-| | | |
-| | | - changed the faultFields version to 3.0 (major change) |
-| | | |
-| | | - changed faultFields.alarmAdditionalInformation to reference a hashMap |
-| | | |
-| | | - 4.2.2: Heartbeat Domain Datatypes: |
-| | | |
-| | | - changed the heartbeatFieldsVersion to 2.0 (major change) |
-| | | |
-| | | - changed heartbeatFields.additionalFields to reference a hashMap |
-| | | |
-| | | - 4.2.3: Measurement Domain Datatypes: |
-| | | |
-| | | - changed the measurementFieldsVersion to 3.0 (major change) |
-| | | |
-| | | - changed measurementFields.additionalFields to reference a hashMap |
-| | | |
-| | | - changed measurement.additionalMesurements to reference a namedHashMap [ ] |
-| | | |
-| | | - modified measurementFields.featureUsageArray to reference a hashmap and removed ‘featuresInUse’ |
-| | | |
-| | | - added the following datatypes which are now referenced as items in arrays within measurementFields: hugePages, load, machineCheckException, processStats |
-| | | |
-| | | - 4.2.5: Other Domain Datatypes: |
-| | | |
-| | | - Change the otherFieldsVersion to 2.0 (major change) |
-| | | |
-| | | - changed otherFields.nameValuePairs to reference a hashMap and renamed it hashMap |
-| | | |
-| | | - changed otherFields.hashOfNameValuePairArrrays to reference a namedHashMap and renamed it arrayOfNamedHashMap |
-| | | |
-| | | - 4.2.7: State Change Domain Datatypes: |
-| | | |
-| | | - changed the stateChangeFiledsVersion to 3.0 (major change) |
-| | | |
-| | | - changed stateChangeFields.additionalFields to reference a hashMap |
-| | | |
-| | | - 4.2.9: Threshold Crossing Alert Domain Datatypes: |
-| | | |
-| | | - changed the thresholdCrossingAlertFieldsVersion to 3.0 (major change) |
-| | | |
-| | | - changed thresholdCrossingAlertFields.additionalFields to reference a hashMap |
-| | | |
-| | | - counter: removed name and value elements and replaced with a hashMap |
-| | | |
-| | | - 4.3.1: Mobile Flow Domain Datatypes: |
-| | | |
-| | | - changed the mobileFlowFieldsVersion to 3.0 (major change) |
-| | | |
-| | | - changed mobileFlowFields.additionalFields to reference a hashMap |
-| | | |
-| | | - gtpPerFlowMetrics: modified ipTosCountList to reference hashmap |
-| | | |
-| | | - gtpPerFlowMetrics: modified mobileQciCosCountList to reference hashmap |
-| | | |
-| | | - gtpPerFlowMetrics: modified tcpFlagCountList to reference hashmap |
-| | | |
-| | | - 4.3.2: Sip Signaling Domain Datatypes: |
-| | | |
-| | | - changed the sigSignalingFieldsVersion to 2.0 (major change) |
-| | | |
-| | | - changed sipSignalingFields.additionalInformation to reference a hashMap |
-| | | |
-| | | - 4.3.3: Voice Quality Domain Datatypes: |
-| | | |
-| | | - change the voiceQualityFieldsVersion to 2.0 (major change) |
-| | | |
-| | | - changed voiceQualityFields.additionalInformation to reference a hashMap |
-| | | |
-| | | - Section 4: added notes at the top of section 4 clarifying expectations and requirements for optional fields, extensible fields and keys sent through extensible fields. |
-| | | |
-| | | - Common Event Data Types: Section 4.1.1.9 Changed vendorVnfNameFields to vendorNfNameFields; updated Section 4.3.2 SipSignaling and 4.3.3 Voice Quality to refer to the renamed object |
-| | | |
-| | | - Common Event Header Section 4.1.2: |
-| | | |
-| | | - clarified the descriptions of eventId, reportingEntityName, sourceName and startEpochMicroseconds. |
-| | | |
-| | | - Added ‘notification’ and ‘pngRegistration’ to the domain enumeration. |
-| | | |
-| | | - added a new timeZoneOffsest field |
-| | | |
-| | | - Fault Domain Section 4.2.1: clarified the definitions of alarmCondition, eventSeverity and specificProblem |
-| | | |
-| | | - Measurements Domain Section 4.2.3: changed the name of this domain from ‘measurementsForVfScaling’ to ‘measurement’ |
-| | | |
-| | | - measurementsForVfScaling measurement |
-| | | |
-| | | - measurementsForVfScalingFields measurementFields |
-| | | |
-| | | - measurementsForVfScalingVersion measurementFieldsVersion |
-| | | |
-| | | - the ‘mfvs’ abbreviation measurement |
-| | | |
-| | | - Measurements Domain Section 4.2.3 cpuUsage: added seven optional fields to this structure: cpuCapacityContention, cpuDemandAvg, cpuDemandMhz, cpuDemandPct, cpuLatencyAverage, cpuOverheadAvg, cpuSwapWaitTime |
-| | | |
-| | | - Measurements Domain Section 4.2.3 diskUsage: added ten optional fields to this structure: diskBusResets, diskCommandsAborted, diskCommandsAvg, diskFlushRequests, diskFlushTime, diskReadCommandsAvg, diskTime, diskTotalReadLatencyAvg, diskTotalWriteLatencyAvg, diskWriteCommandsAvg |
-| | | |
-| | | - Measurements Domain Section 4.2.3: added a new ‘ipmi’ datatype along with following ‘supporting’ datatypes: ipmiBaseboardTemperature, ipmiBaseboardVoltageRegulator, ipmiBattery, ipmiFan, ipmiGlobalAggregateTemperatureMargin, ipmiHsbp, ipmiNic, ipmiPowerSupply, ipmiProcessor, processorDimmAggregateThermalMargin |
-| | | |
-| | | - Measurements Domain Section 4.2.3: added a new ‘load’ datatype |
-| | | |
-| | | - Measurements Domain Section 4.2.3 memoryUsage: added eight optional fields to this structure: memoryDemand, memoryLatencyAvg, memorySharedAvg, memorySwapInAvg, memorySwapInRateAvg, memorySwapOutAvg, memorySwapOutRateAvg, memorySwapUsedAvg |
-| | | |
-| | | - Measurements Domain Section 4.2.3: modified measurementFields to include the following new fields: hugePagesArray, ipmi, loadArray, memoryErrors, processStatusArray, rdtArray |
-| | | |
-| | | - Measurements Domain Section 4.2.3 renamed vNicPerformance to nicPerformance and changed vNicIdentifer to nicIdentifier |
-| | | |
-| | | - Notification Domain Section 4.2.4: added notificationFields to support a new notification domain. |
-| | | |
-| | | - pnfRegistration Domain Section 4.2.7: added pnfRegistrationFields to support a new registration domain. |
-| | | |
-| | | - sysLog Domain Section 4.2.8: added two new fields: syslogMsgHost and syslogTs. Clarified field descriptions. Clarified syslogSData example. |
-| | | |
-| | | - endOfCallVqmSummaries Section 4.3.3.1: |
-| | | |
-| | | - converted endpointJitter into two fields: endpointAverageJitter and endpointMaxJitter |
-| | | |
-| | | - converted localJitter into two fields: localAverageJitter and localMaxJitter |
-| | | |
-| | | - added two fields: localAverageJitterBufferDelay and localMaxJitterBufferDelay |
-| | | |
-| | | - added endpointRtpOctetsLost and endpointRtpPacketsLost |
-| | | |
-| | | - added localRtpOctetsLost and localRtpPacketsLost |
-| | | |
-| | | - converted packetsLost into oneWayDelay |
-| | | |
-| | | - API Versioning: |
-| | | |
-| | | - Section 1.4: clarified the versioning section and linked it to the following new section 6.1.2 |
-| | | |
-| | | - Section 6.1.2: Added requirements for HTTP headers communicating minor, patch and latest version information. |
-| | | |
-| | | - Section 2 and 6 sample messages: clarified examples to use the new HTTP headers |
-| | | |
-| | | - Section 6.1.4: Added a section specifying message size limits. |
-| | | |
-| | | - Section2 6.2.6.1 and 6.3.6.1: corrected additionalInformation examples to use hashMap instead of name-value pair fields. |
-| | | |
-| | | - Section 7: Added a section on Terminology. |
-| | | |
-| | | - Command List Processing: removed command list processing from the document and schema: |
-| | | |
-| | | - Modified the Section 3 resource structure to align with these changes. |
-| | | |
-| | | - Removed Section 4 Datatypes: command, commandList, eventDomainThrottleSpecification, eventDomainThrottleSpecificationList, eventThrottlingState, suppressedNvPairs |
-| | | |
-| | | - Removed Section 6.1 description of commands toward event source clients |
-| | | |
-| | | - Removed Section 6.4 operation: provideThrottlingState |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/30/2018 | v7.0 | - General: |
-| | | |
-| | | - Fixed typos throughout |
-| | | |
-| | | - Changed example versions to v7 |
-| | | |
-| | | - Section1: |
-| | | |
-| | | - Clarified casing and use of dashes versus colons in eventName examples |
-| | | |
-| | | - Updated all field block versions |
-| | | |
-| | | - Section 2: added a note clarifying that TLS 1.2 or higher must be used for HTTPS connections. |
-| | | |
-| | | - Section 4 embedded schema changed to v30: |
-| | | |
-| | | - Added “ ‘additionalProperties’: false ” to objects to reject events that attempt to send properties that are not listed in the ‘properties’ keyword. Note: does not affect hashmap extensible fields. |
-| | | |
-| | | - Changed all versions in all field blocks from number to string enum with the version number fixed by the enum so the schema can validate events that attempt to send non-standard field blocks. |
-| | | |
-| | | - Changed syslog additionalFields to a hashMap |
-| | | |
-| | | - Section 4: |
-| | | |
-| | | - Fixed section heading numbers that were the same. |
-| | | |
-| | | - 4.1.1: jsonObjectInstance: added an optional recursive jsonObject and removed all required fields from this object |
-| | | |
-| | | - 4.1.2: commonEventHeader: |
-| | | |
-| | | - nfVendorName: added this optional field |
-| | | |
-| | | - timeZoneOffset: changed from number to string with a particular format specified |
-| | | |
-| | | - version was changed from number to string (as were all the version fields of all the field blocks) |
-| | | |
-| | | - vesCommonEventListenerVersion: added this required field as a string enumeration |
-| | | |
-| | | - 4.2.3: Measurements Domain: |
-| | | |
-| | | - Added a note clarifying that NFs are required to report exactly one Measurement event per period per sourceName |
-| | | |
-| | | - diskUsage: added four new optional fields: diskWeightedIoTimeAve, diskWeightedIoTimeLast, diskWeightedIoTimeMax, diskWeightedIoTimeMin |
-| | | |
-| | | - memoryUsage: add one new optional field: percentMemoryUsage |
-| | | |
-| | | - nicPerformance: added nine new optional fields: administrativeState, operationalState, receivedPercentDiscard, receivedPercentError, receivedUtilization, speed, transmittedPercentDiscard, transmittedPercentError, transmittedUtilization |
-| | | |
-| | | - processorDimmAggregateThermalMargin: make the thermalMargin field required |
-| | | |
-| | | - 4.2.8: Syslog Domain: |
-| | | |
-| | | - Corrected the example at the end of the section |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 7/31/2018 | v7.0.1 | - Section 4: The schema embedded at the top of section 4 was patched to correct a header field name error—the schema version moves from 30 to 30.0.1: |
-| | | |
-| | | - Changed commonEventHeader field: ‘vesCommonEventFormatVersion’ field to ‘vesEventListenerVersion’ and set the enum to 7.0.1 |
-| | | |
-| | | - Also changed the commonEventHeader ‘required’ array to reflect use the corrected field name: ‘vesEventListenerVersion’ |
-| | | |
-| | | - Changed the commonEventHeader ‘version’ field enumeration to 4.0.1 |
-| | | |
-| | | - Section1: |
-| | | |
-| | | - Changed the field block versions for the common header for ‘vesEventListenerVersion’ (to 7.0.1) and ‘version’ (to 4.0.1). |
-| | | |
-| | | - Sections 2 and 6: |
-| | | |
-| | | - Changed the commonEventHeader version fields above, in the sample message requests and responses; also updated the faultFieldsVersion to 4.0 |
-| | | |
-| | | - Section 6.1.2: Changed the X-LatestVersion to 7.0.1 and the X-PatchVersion to 1 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 12/10/2018 | v7.1 | - Section 1.2: Added Notification domain Perf3gpp domain and changed a reference from ‘measurements domain’ to ‘measurement domain’. |
-| | | |
-| | | - Section 1.7.1: Field Block Versions: added ‘perf3gppFields’ version at 1.0 and changed the following version enumerations so that existing clients of major version 7 would not be broken by this VES minor version change, in accordance with semantic versioning definitions: |
-| | | |
-| | | - commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0 or 7.0.1 or 7.1. |
-| | | |
-| | | - commonEventHeader: changed ‘version’ enum to accept either 4.0 or 4.0.1 or 4.1 |
-| | | |
-| | | - Section 2: |
-| | | |
-| | | - changed sample request and responses to reference 7.1 instead of 7.0.1 (and version 4.1 of the commonEventHeader version, instead of v4.0.1) |
-| | | |
-| | | - added a sub section on service provider support for mutual ssl certificate authentication |
-| | | |
-| | | - Section 4.1.2.1: |
-| | | |
-| | | - CommonEventHeader timeZoneOffset changed description from ‘UTC+/-hh.mm’ to ‘UTC+/-hh:mm’ |
-| | | |
-| | | - Added ‘perf3gpp’ to the domain enumeration |
-| | | |
-| | | - Section 4.2.3: Measurement Domain Datatypes: |
-| | | |
-| | | - In ‘MeasurementFields’: Changed ‘ipmiArray’ to ‘ipmi’ and made the type ‘object’ |
-| | | |
-| | | - ‘ipmiProcessor’: changed ‘pprocessorThermalControl’ to ‘processorThermalControl’ |
-| | | |
-| | | - ‘machineCheckException’: changed ‘processIdentifier’ to ‘vmIdentifier’ |
-| | | |
-| | | - Section 4.2.6: added the perf3gpp domain |
-| | | |
-| | | - Section 4 embedded schema: |
-| | | |
-| | | - Changed the schema version from 30.0.1 to 30.1 as a result of the changes below: |
-| | | |
-| | | - commonEventHeader: changed to ‘vesEventListenerVersion’ enum to accept either 7.0, 7.0.1 or 7.1 |
-| | | |
-| | | - commonEventHeader: changed the ‘version’ field enumeration to accept either 4.0, 4.0.1 or 4.1 |
-| | | |
-| | | - commonEventHeader: changed the ‘domain’ enumeration to add support for the perf3gpp domain. |
-| | | |
-| | | - ‘event’: added a reference to ‘perf3gppFields’ |
-| | | |
-| | | - ‘hugePages’: changed the type of hugePagesIdentifier from number to string |
-| | | |
-| | | - ‘ipmiGlobalAggregateTemperatureMargin’: changed ‘pmiGlobalAggregateTemperatureMarginIdentifier’ to ‘globalAggregateTemperatureMarginIdentifier’ |
-| | | |
-| | | - ‘perf3gppFields’: added this object |
-| | | |
-| | | - Section 6: changed references throughout from v7.0.1 to v7.1 and v4.0.1 (of the commonEventHeader version) to v4.1 |
-+--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. |image0| image:: media/image3.png
- :width: 6.48926in
- :height: 4.86694in
-.. |image1| image:: media/image4.png
- :width: 6.50000in
- :height: 4.87450in
-.. |image2| image:: media/image5.png
- :width: 3.76033in
- :height: 1.16677in
-.. |image3| image:: media/image7.png
- :width: 4.75347in
- :height: 2.57361in
-.. |image4| image:: media/image8.png
- :width: 4.74722in
- :height: 2.56667in
diff --git a/docs/index.rst b/docs/index.rst index fe9f0da..efdfc86 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,8 +28,6 @@ User Guides files/*Bundling* files/VNFSDK-Marketplace-userguide-operators files/VNFSDK-Marketplace-userguide-vendors - files/ves-client-guidelines files/Dovetail - files/ICE files/VNFSDK-LFN-CVC
\ No newline at end of file |
