diff options
| -rw-r--r-- | tests/docs/README.md | 1 | ||||
| -rw-r--r-- | tests/docs/ves_data_model.json | 948 |
2 files changed, 833 insertions, 116 deletions
diff --git a/tests/docs/README.md b/tests/docs/README.md new file mode 100644 index 0000000..dc164d2 --- /dev/null +++ b/tests/docs/README.md @@ -0,0 +1 @@ +This folder contains the latest version of the VES schema, aligned with the latest release (5.0) of the AT&T VES schema published at https://github.com/att/evel-test-collector/tree/master/docs/att_interface_definition/. diff --git a/tests/docs/ves_data_model.json b/tests/docs/ves_data_model.json index e88a927..ca948ff 100644 --- a/tests/docs/ves_data_model.json +++ b/tests/docs/ves_data_model.json @@ -17,7 +17,7 @@ "type": "object", "properties": { "codecIdentifier": { "type": "string" }, - "numberInUse": { "type": "number" } + "numberInUse": { "type": "integer" } }, "required": [ "codecIdentifier", "numberInUse" ] }, @@ -35,7 +35,8 @@ ] }, "eventDomainThrottleSpecification": { "$ref": "#/definitions/eventDomainThrottleSpecification" }, - "measurementInterval": { "type": "number" } + "heartbeatInterval": { "type": "integer" }, + "measurementInterval": { "type": "integer" } }, "required": [ "commandType" ] }, @@ -43,18 +44,10 @@ "description": "array of commands from an event collector toward an event source", "type": "array", "items": { - "$ref": "#/definitions/commandListEntry" + "$ref": "#/definitions/command" }, "minItems": 0 }, - "commandListEntry": { - "description": "reference to a command object", - "type": "object", - "properties": { - "command": {"$ref": "#/definitions/command"} - }, - "required": [ "command" ] - }, "commonEventHeader": { "description": "fields common to all events", "type": "object", @@ -68,21 +61,23 @@ "measurementsForVfScaling", "mobileFlow", "other", + "sipSignaling", "stateChange", "syslog", - "thresholdCrossingAlert" + "thresholdCrossingAlert", + "voiceQuality" ] }, "eventId": { "description": "event key that is unique to the event source", "type": "string" }, - "eventType": { - "description": "unique event topic name", + "eventName": { + "description": "unique event name", "type": "string" }, - "functionalRole": { - "description": "function of the event source e.g., eNodeB, MME, PCRF", + "eventType": { + "description": "for example - applicationVnf, guestOS, hostOS, platform", "type": "string" }, "internalHeaderFields": { "$ref": "#/definitions/internalHeaderFields" }, @@ -90,6 +85,14 @@ "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 vnf naming standards", + "type": "string" + }, "priority": { "description": "processing priority", "type": "string", @@ -101,11 +104,11 @@ ] }, "reportingEntityId": { - "description": "UUID identifying the entity reporting the event, for example an OAM VM", + "description": "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process", "type": "string" }, "reportingEntityName": { - "description": "name of the entity reporting the event, for example, an OAM VM", + "description": "name of the entity reporting the event, for example, an EMS name; may be the same as sourceName", "type": "string" }, "sequence": { @@ -113,7 +116,7 @@ "type": "integer" }, "sourceId": { - "description": "UUID identifying the entity experiencing the event issue", + "description": "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process", "type": "string" }, "sourceName": { @@ -129,9 +132,9 @@ "type": "number" } }, - "required": [ "domain", "eventId", "functionalRole", "lastEpochMicrosec", - "priority", "reportingEntityName", "sequence", - "sourceName", "startEpochMicrosec" ] + "required": [ "domain", "eventId", "eventName", "lastEpochMicrosec", + "priority", "reportingEntityName", "sequence", "sourceName", + "startEpochMicrosec", "version" ] }, "counter": { "description": "performance counter", @@ -145,37 +148,330 @@ "required": [ "criticality", "name", "thresholdCrossed", "value" ] }, "cpuUsage": { - "description": "percent usage of an identified CPU", + "description": "usage of an identified CPU", "type": "object", "properties": { - "cpuIdentifier": { "type": "string" }, - "percentUsage": { "type": "number" } + "cpuIdentifier": { + "description": "cpu identifer", + "type": "string" + }, + "cpuIdle": { + "description": "percentage of CPU time spent in the idle task", + "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 VNFC reporting the event is running", + "type": "number" + } }, "required": [ "cpuIdentifier", "percentUsage" ] }, - "errors": { - "description": "receive and transmit errors for the measurements domain", + "diskUsage": { + "description": "usage of an identified disk", "type": "object", "properties": { - "receiveDiscards": { "type": "number" }, - "receiveErrors": { "type": "number" }, - "transmitDiscards": { "type": "number" }, - "transmitErrors": { "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" + }, + "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" + } }, - "required": [ "receiveDiscards", "receiveErrors", "transmitDiscards", "transmitErrors" ] + "required": [ "diskIdentifier" ] }, + "endOfCallVqmSummaries": { + "description": "provides end of call voice quality metrics", + "type": "object", + "properties": { + "adjacencyName": { + "description": " adjacency name", + "type": "string" + }, + "endpointDescription": { + "description": "Either Caller or Callee", + "type": "string", + "enum": ["Caller", "Callee"] + }, + "endpointJitter": { + "description": "", + "type": "number" + }, + "endpointRtpOctetsDiscarded": { + "description": "", + "type": "number" + }, + "endpointRtpOctetsReceived": { + "description": "", + "type": "number" + }, + "endpointRtpOctetsSent": { + "description": "", + "type": "number" + }, + "endpointRtpPacketsDiscarded": { + "description": "", + "type": "number" + }, + "endpointRtpPacketsReceived": { + "description": "", + "type": "number" + }, + "endpointRtpPacketsSent": { + "description": "", + "type": "number" + }, + "localJitter": { + "description": "", + "type": "number" + }, + "localRtpOctetsDiscarded": { + "description": "", + "type": "number" + }, + "localRtpOctetsReceived": { + "description": "", + "type": "number" + }, + "localRtpOctetsSent": { + "description": "", + "type": "number" + }, + "localRtpPacketsDiscarded": { + "description": "", + "type": "number" + }, + "localRtpPacketsReceived": { + "description": "", + "type": "number" + }, + "localRtpPacketsSent": { + "description": "", + "type": "number" + }, + "mosCqe": { + "description": "1-5 1dp", + "type": "number" + }, + "packetsLost": { + "description": "", + "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" }, "measurementsForVfScalingFields": { "$ref": "#/definitions/measurementsForVfScalingFields" }, "mobileFlowFields": { "$ref": "#/definitions/mobileFlowFields" }, "otherFields": { "$ref": "#/definitions/otherFields" }, + "sipSignalingFields": { "$ref": "#/definitions/sipSignalingFields" }, "stateChangeFields": { "$ref": "#/definitions/stateChangeFields" }, "syslogFields": { "$ref": "#/definitions/syslogFields" }, - "thresholdCrossingAlertFields": { "$ref": "#/definitions/thresholdCrossingAlertFields" } + "thresholdCrossingAlertFields": { "$ref": "#/definitions/thresholdCrossingAlertFields" }, + "voiceQualityFields": { "$ref": "#/definitions/voiceQualityFields" } }, "required": [ "commonEventHeader" ] }, @@ -254,8 +550,12 @@ "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 or priority", + "description": "event severity", "type": "string", "enum": [ "CRITICAL", @@ -266,7 +566,7 @@ ] }, "eventSourceType": { - "description": "type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction", + "description": "type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction", "type": "string" }, "faultFieldsVersion": { @@ -289,15 +589,15 @@ ] } }, - "required": [ "alarmCondition", "eventSeverity", - "eventSourceType", "specificProblem", "vfStatus" ] + "required": [ "alarmCondition", "eventSeverity", "eventSourceType", + "faultFieldsVersion", "specificProblem", "vfStatus" ] }, "featuresInUse": { "description": "number of times an identified feature was used over the measurementInterval", "type": "object", "properties": { "featureIdentifier": { "type": "string" }, - "featureUtilization": { "type": "number" } + "featureUtilization": { "type": "integer" } }, "required": [ "featureIdentifier", "featureUtilization" ] }, @@ -370,7 +670,7 @@ "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’", + "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": { @@ -386,7 +686,7 @@ "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’", + "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": { @@ -404,14 +704,12 @@ "ipTosCountList": { "description": "array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow", "type": "array", - "uniqueItems": true, "items": { "type": "array", "items": [ { "type": "string" }, { "type": "number" } - ], - "additionalItems": false + ] } }, "ipTosList": { @@ -444,14 +742,12 @@ "mobileQciCosCountList": { "description": "array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow", "type": "array", - "uniqueItems": true, "items": { "type": "array", "items": [ { "type": "string" }, { "type": "number" } - ], - "additionalItems": false + ] } }, "mobileQciCosList": { @@ -544,14 +840,12 @@ "tcpFlagCountList": { "description": "array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow", "type": "array", - "uniqueItems": true, "items": { "type": "array", "items": [ { "type": "string" }, { "type": "number" } - ], - "additionalItems": false + ] } }, "tcpFlagList": { @@ -583,10 +877,107 @@ "roundTripTime", "timeToFirstByte" ] }, + "heartbeatFields": { + "description": "optional field block for fields specific to heartbeat events", + "type": "object", + "properties": { + "additionalFields": { + "description": "additional heartbeat fields if needed", + "type": "array", + "items": { + "$ref": "#/definitions/field" + } + }, + "heartbeatFieldsVersion": { + "description": "version of the heartbeatFields block", + "type": "number" + }, + "heartbeatInterval": { + "description": "current heartbeat interval in seconds", + "type": "integer" + } + }, + "required": [ "heartbeatFieldsVersion", "heartbeatInterval" ] + }, "internalHeaderFields": { "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources", "type": "object" }, + "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", @@ -616,17 +1007,27 @@ "description": "measurementsForVfScaling fields", "type": "object", "properties": { - "additionalMeasurements": { - "description": "additional measurement fields", + "additionalFields": { + "description": "additional name-value-pair fields", "type": "array", "items": { - "$ref": "#/definitions/measurementGroup" + "$ref": "#/definitions/field" } }, - "aggregateCpuUsage": { - "description": "aggregate CPU usage of the VM on which the VNFC reporting the event is running", - "type": "number" + "additionalMeasurements": { + "description": "array of named name-value-pair arrays", + "type": "array", + "items": { + "$ref": "#/definitions/namedArrayOfFields" + } }, + "additionalObjects": { + "description": "array of JSON objects described by name, schema and other meta-information", + "type": "array", + "items": { + "$ref": "#/definitions/jsonObject" + } + }, "codecUsageArray": { "description": "array of codecs in use", "type": "array", @@ -636,11 +1037,11 @@ }, "concurrentSessions": { "description": "peak concurrent sessions for the VM or VNF over the measurementInterval", - "type": "number" + "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 VNF", - "type": "number" + "type": "integer" }, "cpuUsageArray": { "description": "usage of an array of CPUs", @@ -649,7 +1050,13 @@ "$ref": "#/definitions/cpuUsage" } }, - "errors": { "$ref": "#/definitions/errors" }, + "diskUsageArray": { + "description": "usage of an array of disks", + "type": "array", + "items": { + "$ref": "#/definitions/diskUsage" + } + }, "featureUsageArray": { "description": "array of features in use", "type": "array", @@ -683,17 +1090,16 @@ "description": "version of the measurementsForVfScaling block", "type": "number" }, - "memoryConfigured": { - "description": "memory in MB configured in the VM on which the VNFC reporting the event is running", - "type": "number" - }, - "memoryUsed": { - "description": "memory usage in MB of the VM on which the VNFC reporting the event is running", - "type": "number" + "memoryUsageArray": { + "description": "memory usage of an array of VMs", + "type": "array", + "items": { + "$ref": "#/definitions/memoryUsage" + } }, "numberOfMediaPortsInUse": { "description": "number of media ports in use", - "type": "number" + "type": "integer" }, "requestRate": { "description": "peak rate of service requests per second to the VNF over the measurementInterval", @@ -701,17 +1107,56 @@ }, "vnfcScalingMetric": { "description": "represents busy-ness of the VNF from 0 to 100 as reported by the VNFC", - "type": "number" + "type": "integer" }, - "vNicUsageArray": { + "vNicPerformanceArray": { "description": "usage of an array of virtual network interface cards", "type": "array", "items": { - "$ref": "#/definitions/vNicUsage" + "$ref": "#/definitions/vNicPerformance" } } }, - "required": [ "measurementInterval" ] + "required": [ "measurementInterval", "measurementsForVfScalingVersion" ] + }, + "memoryUsage": { + "description": "memory usage of an identified virtual machine", + "type": "object", + "properties": { + "memoryBuffered": { + "description": "kilobytes of temporary storage for raw disk blocks", + "type": "number" + }, + "memoryCached": { + "description": "kilobytes of memory used for cache", + "type": "number" + }, + "memoryConfigured": { + "description": "kilobytes of memory configured in the virtual machine on which the VNFC reporting the event is running", + "type": "number" + }, + "memoryFree": { + "description": "kilobytes of physical RAM left unused by the system", + "type": "number" + }, + "memorySlabRecl": { + "description": "the part of the slab that can be reclaimed such as caches measured in kilobytes", + "type": "number" + }, + "memorySlabUnrecl": { + "description": "the part of the slab that cannot be reclaimed even when lacking memory measured in kilobytes", + "type": "number" + }, + "memoryUsed": { + "description": "total memory minus the sum of free, buffered, cached and slab memory measured in kilobytes", + "type": "number" + }, + "vmIdentifier": { + "description": "virtual machine identifier associated with the memory metrics", + "type": "string" + } + }, + "required": [ "memoryFree", "memoryUsed", "vmIdentifier" ] }, "mobileFlowFields": { "description": "mobileFlow fields", @@ -807,7 +1252,7 @@ }, "otherEndpointPort": { "description": "IP Port for the reporting entity, as used for the flow being reported on", - "type": "number" + "type": "integer" }, "otherFunctionalRole": { "description": "Functional role of the other endpoint for the flow being reported on e.g., MME, S-GW, P-GW, PCRF...", @@ -827,7 +1272,7 @@ }, "reportingEndpointPort": { "description": "IP port for the reporting entity, as used for the flow being reported on", - "type": "number" + "type": "integer" }, "sac": { "description": "service area code", @@ -835,7 +1280,7 @@ }, "samplingAlgorithm": { "description": "Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied", - "type": "number" + "type": "integer" }, "tac": { "description": "transport area code", @@ -850,23 +1295,63 @@ "type": "string" } }, - "required": [ "flowDirection", "gtpPerFlowMetrics", "ipProtocolType", - "ipVersion", "otherEndpointIpAddress", "otherEndpointPort", + "required": [ "flowDirection", "gtpPerFlowMetrics", "ipProtocolType", "ipVersion", + "mobileFlowFieldsVersion", "otherEndpointIpAddress", "otherEndpointPort", "reportingEndpointIpAddr", "reportingEndpointPort" ] }, + "namedArrayOfFields": { + "description": "an array of name value pairs along with a name for the array", + "type": "object", + "properties": { + "name": { "type": "string" }, + "arrayOfFields": { + "description": "array of name value pairs", + "type": "array", + "items": { + "$ref": "#/definitions/field" + } + } + }, + "required": [ "name", "measurements" ] + }, "otherFields": { - "description": "additional fields not reported elsewhere", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } + "description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration", + "type": "object", + "properties": { + "hashOfNameValuePairArrays": { + "description": "array of named name-value-pair arrays", + "type": "array", + "items": { + "$ref": "#/definitions/namedArrayOfFields" + } + }, + "jsonObjects": { + "description": "array of JSON objects described by name, schema and other meta-information", + "type": "array", + "items": { + "$ref": "#/definitions/jsonObject" + } + }, + "nameValuePairs": { + "description": "array of name-value pairs", + "type": "array", + "items": { + "$ref": "#/definitions/field" + } + }, + "otherFieldsVersion": { + "description": "version of the otherFields block", + "type": "number" + } + }, + "required": [ "otherFieldsVersion" ] }, "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", + "description": "Unique message identifier of the format ABCnnnn where ABC is either SVC for Service Exceptions or POL for Policy Exception", "type": "string" }, "text": { @@ -884,6 +1369,56 @@ }, "required": [ "messageId", "text" ] }, + "sipSignalingFields": { + "description": "sip signaling fields", + "type": "object", + "properties": { + "additionalInformation": { + "description": "additional sip signaling fields if needed", + "type": "array", + "items": { + "$ref": "#/definitions/field" + } + }, + "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 VNF", + "type": "string" + }, + "localPort": { + "description": "port on VNF", + "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" + }, + "vnfVendorNameFields": { + "$ref": "#/definitions/vnfVendorNameFields" + } + }, + "required": [ "correlator", "localIpAddress", "localPort", "remoteIpAddress", + "remotePort", "sipSignalingFieldsVersion", "vnfVendorNameFields" ] + }, "stateChangeFields": { "description": "stateChange fields", "type": "object", @@ -922,7 +1457,7 @@ "type": "string" } }, - "required": [ "newState", "oldState", "stateInterface" ] + "required": [ "newState", "oldState", "stateChangeFieldsVersion", "stateInterface" ] }, "suppressedNvPairs": { "description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling", @@ -947,11 +1482,8 @@ "type": "object", "properties": { "additionalFields": { - "description": "additional syslog fields if needed", - "type": "array", - "items": { - "$ref": "#/definitions/field" - } + "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", @@ -963,7 +1495,7 @@ }, "syslogFacility": { "description": "numeric code from 0 to 23 for facility--see table in documentation", - "type": "number" + "type": "integer" }, "syslogFieldsVersion": { "description": "version of the syslogFields block", @@ -975,7 +1507,7 @@ }, "syslogPri": { "description": "0-192 combined severity and facility", - "type": "number" + "type": "integer" }, "syslogProc": { "description": "identifies the application that originated the message", @@ -995,7 +1527,17 @@ }, "syslogSev": { "description": "numerical Code for severity derived from syslogPri as remaider of syslogPri / 8", - "type": "string" + "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", @@ -1006,7 +1548,7 @@ "type": "number" } }, - "required": [ "eventSourceType", "syslogMsg", "syslogTag" ] + "required": [ "eventSourceType", "syslogFieldsVersion", "syslogMsg", "syslogTag" ] }, "thresholdCrossingAlertFields": { "description": "fields specific to threshold crossing alert events", @@ -1059,7 +1601,7 @@ "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’", + "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": { @@ -1067,7 +1609,7 @@ "type": "string" }, "elementType": { - "description": "type of network element", + "description": "type of network element - internal ATT field", "type": "string" }, "eventSeverity": { @@ -1082,7 +1624,7 @@ ] }, "eventStartTimestamp": { - "description": "Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’", + "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": { @@ -1090,7 +1632,7 @@ "type": "string" }, "networkService": { - "description": "network name", + "description": "network name - internal ATT field", "type": "string" }, "possibleRootCause": { @@ -1109,32 +1651,206 @@ "alertType", "collectionTimestamp", "eventSeverity", - "eventStartTimestamp" + "eventStartTimestamp", + "thresholdCrossingFieldsVersion" ] }, - "vNicUsage": { - "description": "usage of identified virtual network interface card", + "vendorVnfNameFields": { + "description": "provides vendor, vnf and vfModule identifying information", "type": "object", "properties": { - "broadcastPacketsIn": { "type": "number" }, - "broadcastPacketsOut": { "type": "number" }, - "bytesIn": { "type": "number" }, - "bytesOut": { "type": "number" }, - "multicastPacketsIn": { "type": "number" }, - "multicastPacketsOut": { "type": "number" }, - "packetsIn": { "type": "number" }, - "packetsOut": { "type": "number" }, - "unicastPacketsIn": { "type": "number" }, - "unicastPacketsOut": { "type": "number" }, - "vNicIdentifier": { "type": "string" } + "vendorName": { + "description": "VNF vendor name", + "type": "string" + }, + "vfModuleName": { + "description": "ASDC vfModuleName for the vfModule generating the event", + "type": "string" + }, + "vnfName": { + "description": "ASDC modelName for the VNF generating the event", + "type": "string" + } }, - "required": [ "bytesIn", "bytesOut", "packetsIn", "packetsOut", "vNicIdentifier"] - } - }, - "title": "Event Listener", - "type": "object", + "required": [ "vendorName" ] + }, + "vNicPerformance": { + "description": "describes the performance and errors of an identified virtual network interface card", + "type": "object", "properties": { - "event": {"$ref": "#/definitions/event"} + "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" ] + }, + "vNicIdentifier": { + "description": "vNic identification", + "type": "string" + } + }, + "required": [ "valuesAreSuspect", "vNicIdentifier" ] + }, + "voiceQualityFields": { + "description": "provides statistics related to customer facing voice products", + "type": "object", + "properties": { + "additionalInformation": { + "description": "additional voice quality fields if needed", + "type": "array", + "items": { + "$ref": "#/definitions/field" + } + }, + "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" + }, + "vendorVnfNameFields": { + "$ref": "#/definitions/vendorVnfNameFields" + }, + "voiceQualityFieldsVersion": { + "description": "version of the voiceQualityFields block", + "type": "number" + } }, - "required": ["event"] + "required": [ "calleeSideCodec", "callerSideCodec", "correlator", "midCallRtcp", + "vendorVnfNameFields", "voiceQualityFieldsVersion" ] + } + }, + "title": "Event Listener", + "type": "object", + "properties": { + "event": {"$ref": "#/definitions/event"} + } } |