diff options
Diffstat (limited to 'dpo/data-formats/VES-5.28.4-dataformat.json')
| -rwxr-xr-x | dpo/data-formats/VES-5.28.4-dataformat.json | 312 |
1 files changed, 219 insertions, 93 deletions
diff --git a/dpo/data-formats/VES-5.28.4-dataformat.json b/dpo/data-formats/VES-5.28.4-dataformat.json index b97f8a84..cce6dea9 100755 --- a/dpo/data-formats/VES-5.28.4-dataformat.json +++ b/dpo/data-formats/VES-5.28.4-dataformat.json @@ -17,7 +17,6 @@ "$ref": "#/definitions/eventList" } }, - "definitions": { "schemaHeaderBlock": { "description": "schema date, version, author and associated API", @@ -41,41 +40,28 @@ } } }, - "attCopyrightNotice": { - "description": "Copyright (c) <2017>, AT&T Intellectual Property. All rights reserved. Licensed under the Apache License, Version 2.0 (the License)", - "type": "object", - "properties": { - "useAndRedistribution": { - "description": "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", - "type": "string" - }, - "licenseLink": { - "description": "http://www.apache.org/licenses/LICENSE-2.0", - "type":"string" - }, - "condition1": { - "description": "Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an AS IS BASIS,", - "type": "string" - }, - "condition2": { - "description": "Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.", - "type": "string" - }, - "condition3": { - "description": "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", - "type": "string" - }, - "condition4": { - "description": "See the License for the specific language governing permissions and limitations under the License.", - "type": "string" - }, - "Trademarks": { - "description": "ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.", - "type": "string" - } + "schemaLicenseAndCopyrightNotice": { + "description": "Copyright (c) 2017, AT&T Intellectual Property. All rights reserved", + "type": "object", + "properties": { + "apacheLicense2.0": { + "description": "Licensed under the Apache License, Version 2.0 (the 'License'); you may not use this file except in compliance with the License. You may obtain a copy of the License at:", + "type": "string" + }, + "licenseUrl": { + "description": "http://www.apache.org/licenses/LICENSE-2.0", + "type": "string" + }, + "asIsClause": { + "description": "Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", + "type": "string" + }, + "permissionsAndLimitations": { + "description": "See the License for the specific language governing permissions and limitations under the License.", + "type": "string" } - }, - + } + }, "codecsInUse": { "description": "number of times an identified codec was used over the measurementInterval", "type": "object", @@ -87,7 +73,10 @@ "type": "integer" } }, - "required": ["codecIdentifier", "numberInUse"] + "required": [ + "codecIdentifier", + "numberInUse" + ] }, "command": { "description": "command from an event collector toward an event source", @@ -112,7 +101,9 @@ "type": "integer" } }, - "required": ["commandType"] + "required": [ + "commandType" + ] }, "commandList": { "description": "array of commands from an event collector toward an event source", @@ -208,9 +199,17 @@ "type": "number" } }, - "required": ["domain", "eventId", "eventName", "lastEpochMicrosec", - "priority", "reportingEntityName", "sequence", "sourceName", - "startEpochMicrosec", "version" + "required": [ + "domain", + "eventId", + "eventName", + "lastEpochMicrosec", + "priority", + "reportingEntityName", + "sequence", + "sourceName", + "startEpochMicrosec", + "version" ] }, "counter": { @@ -219,7 +218,10 @@ "properties": { "criticality": { "type": "string", - "enum": ["CRIT", "MAJ"] + "enum": [ + "CRIT", + "MAJ" + ] }, "name": { "type": "string" @@ -231,7 +233,12 @@ "type": "string" } }, - "required": ["criticality", "name", "thresholdCrossed", "value"] + "required": [ + "criticality", + "name", + "thresholdCrossed", + "value" + ] }, "cpuUsage": { "description": "usage of an identified CPU", @@ -278,7 +285,10 @@ "type": "number" } }, - "required": ["cpuIdentifier", "percentUsage"] + "required": [ + "cpuIdentifier", + "percentUsage" + ] }, "diskUsage": { "description": "usage of an identified disk", @@ -449,7 +459,9 @@ "type": "number" } }, - "required": ["diskIdentifier"] + "required": [ + "diskIdentifier" + ] }, "endOfCallVqmSummaries": { "description": "provides end of call voice quality metrics", @@ -462,7 +474,10 @@ "endpointDescription": { "description": "Either Caller or Callee", "type": "string", - "enum": ["Caller", "Callee"] + "enum": [ + "Caller", + "Callee" + ] }, "endpointJitter": { "description": "", @@ -541,7 +556,10 @@ "type": "number" } }, - "required": ["adjacencyName", "endpointDescription"] + "required": [ + "adjacencyName", + "endpointDescription" + ] }, "event": { "description": "the root level of the common event format", @@ -581,7 +599,9 @@ "$ref": "#/definitions/voiceQualityFields" } }, - "required": ["commonEventHeader"] + "required": [ + "commonEventHeader" + ] }, "eventDomainThrottleSpecification": { "description": "specification of what information to suppress within an event domain", @@ -606,7 +626,9 @@ } } }, - "required": ["eventDomain"] + "required": [ + "eventDomain" + ] }, "eventDomainThrottleSpecificationList": { "description": "array of eventDomainThrottleSpecifications", @@ -639,7 +661,9 @@ "$ref": "#/definitions/eventDomainThrottleSpecificationList" } }, - "required": ["eventThrottlingMode"] + "required": [ + "eventThrottlingMode" + ] }, "faultFields": { "description": "fields specific to fault events", @@ -699,8 +723,13 @@ ] } }, - "required": ["alarmCondition", "eventSeverity", "eventSourceType", - "faultFieldsVersion", "specificProblem", "vfStatus" + "required": [ + "alarmCondition", + "eventSeverity", + "eventSourceType", + "faultFieldsVersion", + "specificProblem", + "vfStatus" ] }, "featuresInUse": { @@ -714,7 +743,10 @@ "type": "integer" } }, - "required": ["featureIdentifier", "featureUtilization"] + "required": [ + "featureIdentifier", + "featureUtilization" + ] }, "field": { "description": "name value pair", @@ -727,7 +759,10 @@ "type": "string" } }, - "required": ["name", "value"] + "required": [ + "name", + "value" + ] }, "filesystemUsage": { "description": "disk usage of an identified virtual machine in gigabytes and/or gigabytes per second", @@ -755,8 +790,14 @@ "type": "string" } }, - "required": ["blockConfigured", "blockIops", "blockUsed", "ephemeralConfigured", - "ephemeralIops", "ephemeralUsed", "filesystemName" + "required": [ + "blockConfigured", + "blockIops", + "blockUsed", + "ephemeralConfigured", + "ephemeralIops", + "ephemeralUsed", + "filesystemName" ] }, "gtpPerFlowMetrics": { @@ -840,7 +881,8 @@ "type": "array", "items": { "type": "array", - "items": [{ + "items": [ + { "type": "string" }, { @@ -881,7 +923,8 @@ "type": "array", "items": { "type": "array", - "items": [{ + "items": [ + { "type": "string" }, { @@ -982,7 +1025,8 @@ "type": "array", "items": { "type": "array", - "items": [{ + "items": [ + { "type": "string" }, { @@ -1003,21 +1047,37 @@ "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", + "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" + "numRetries", + "numTimeouts", + "numTunneledL7BytesReceived", + "roundTripTime", + "timeToFirstByte" ] }, "heartbeatFields": { @@ -1040,7 +1100,10 @@ "type": "integer" } }, - "required": ["heartbeatFieldsVersion", "heartbeatInterval"] + "required": [ + "heartbeatFieldsVersion", + "heartbeatInterval" + ] }, "internalHeaderFields": { "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources", @@ -1078,7 +1141,10 @@ "type": "string" } }, - "required": ["objectInstances", "objectName"] + "required": [ + "objectInstances", + "objectName" + ] }, "jsonObjectInstance": { "description": "meta-information about an instance of a jsonObject along with the actual object instance", @@ -1100,7 +1166,9 @@ } } }, - "required": ["objectInstance"] + "required": [ + "objectInstance" + ] }, "key": { "description": "tuple which provides the name of a key along with its value and relative order", @@ -1119,7 +1187,9 @@ "type": "string" } }, - "required": ["keyName"] + "required": [ + "keyName" + ] }, "latencyBucketMeasure": { "description": "number of counts falling within a defined latency bucket", @@ -1135,7 +1205,9 @@ "type": "number" } }, - "required": ["countsInTheBucket"] + "required": [ + "countsInTheBucket" + ] }, "measurementsForVfScalingFields": { "description": "measurementsForVfScaling fields", @@ -1251,7 +1323,10 @@ } } }, - "required": ["measurementInterval", "measurementsForVfScalingVersion"] + "required": [ + "measurementInterval", + "measurementsForVfScalingVersion" + ] }, "memoryUsage": { "description": "memory usage of an identified virtual machine", @@ -1290,7 +1365,11 @@ "type": "string" } }, - "required": ["memoryFree", "memoryUsed", "vmIdentifier"] + "required": [ + "memoryFree", + "memoryUsed", + "vmIdentifier" + ] }, "mobileFlowFields": { "description": "mobileFlow fields", @@ -1431,9 +1510,16 @@ "type": "string" } }, - "required": ["flowDirection", "gtpPerFlowMetrics", "ipProtocolType", "ipVersion", - "mobileFlowFieldsVersion", "otherEndpointIpAddress", "otherEndpointPort", - "reportingEndpointIpAddr", "reportingEndpointPort" + "required": [ + "flowDirection", + "gtpPerFlowMetrics", + "ipProtocolType", + "ipVersion", + "mobileFlowFieldsVersion", + "otherEndpointIpAddress", + "otherEndpointPort", + "reportingEndpointIpAddr", + "reportingEndpointPort" ] }, "namedArrayOfFields": { @@ -1451,7 +1537,10 @@ } } }, - "required": ["name", "arrayOfFields"] + "required": [ + "name", + "arrayOfFields" + ] }, "otherFields": { "description": "fields for events belonging to the 'other' domain of the commonEventHeader domain enumeration", @@ -1483,7 +1572,9 @@ "type": "number" } }, - "required": ["otherFieldsVersion"] + "required": [ + "otherFieldsVersion" + ] }, "requestError": { "description": "standard request error data structure", @@ -1506,7 +1597,10 @@ "type": "string" } }, - "required": ["messageId", "text"] + "required": [ + "messageId", + "text" + ] }, "sipSignalingFields": { "description": "sip signaling fields", @@ -1555,8 +1649,14 @@ "$ref": "#/definitions/vendorVnfNameFields" } }, - "required": ["correlator", "localIpAddress", "localPort", "remoteIpAddress", - "remotePort", "sipSignalingFieldsVersion", "vendorVnfNameFields" + "required": [ + "correlator", + "localIpAddress", + "localPort", + "remoteIpAddress", + "remotePort", + "sipSignalingFieldsVersion", + "vendorVnfNameFields" ] }, "stateChangeFields": { @@ -1597,7 +1697,12 @@ "type": "string" } }, - "required": ["newState", "oldState", "stateChangeFieldsVersion", "stateInterface"] + "required": [ + "newState", + "oldState", + "stateChangeFieldsVersion", + "stateInterface" + ] }, "suppressedNvPairs": { "description": "List of specific NvPairsNames to suppress within a given Name-Value Field for event Throttling", @@ -1615,7 +1720,10 @@ } } }, - "required": ["nvPairFieldName", "suppressedNvPairNames"] + "required": [ + "nvPairFieldName", + "suppressedNvPairNames" + ] }, "syslogFields": { "description": "sysLog fields", @@ -1688,7 +1796,12 @@ "type": "number" } }, - "required": ["eventSourceType", "syslogFieldsVersion", "syslogMsg", "syslogTag"] + "required": [ + "eventSourceType", + "syslogFieldsVersion", + "syslogMsg", + "syslogTag" + ] }, "thresholdCrossingAlertFields": { "description": "fields specific to threshold crossing alert events", @@ -1814,7 +1927,9 @@ "type": "string" } }, - "required": ["vendorName"] + "required": [ + "vendorName" + ] }, "vNicPerformance": { "description": "describes the performance and errors of an identified virtual network interface card", @@ -1935,14 +2050,20 @@ "valuesAreSuspect": { "description": "Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other condtions", "type": "string", - "enum": ["true", "false"] + "enum": [ + "true", + "false" + ] }, "vNicIdentifier": { "description": "vNic identification", "type": "string" } }, - "required": ["valuesAreSuspect", "vNicIdentifier"] + "required": [ + "valuesAreSuspect", + "vNicIdentifier" + ] }, "voiceQualityFields": { "description": "provides statistics related to customer facing voice products", @@ -1986,8 +2107,13 @@ "type": "number" } }, - "required": ["calleeSideCodec", "callerSideCodec", "correlator", "midCallRtcp", - "vendorVnfNameFields", "voiceQualityFieldsVersion" + "required": [ + "calleeSideCodec", + "callerSideCodec", + "correlator", + "midCallRtcp", + "vendorVnfNameFields", + "voiceQualityFieldsVersion" ] } } |