summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Sullivan <bryan.sullivan@att.com>2017-01-18 10:48:34 -0800
committerBryan Sullivan <bryan.sullivan@att.com>2017-01-18 10:48:34 -0800
commitef6609a879de38fa825645b949bf3a4f82f75348 (patch)
tree179732eb8d2f6b262d4a6b547d1e9239b028f7d3
parent3f4bdff540761f36659a847f0c12482efe26b00a (diff)
Update to latest schema version.
JIRA: VES-2 Update copyright year. Add heartbeatIntervalChange operation. Add internalHeaderFields. Add mobileFlowFields additionalFields. Add mobileFlowFields mobileFlowFieldsVersion. Add syslogPri, syslogSdId, syslogSev. Add thresholdCrossingAlertFields additionalFields. Remove "internal ATT field" comment. Change-Id: I3191656b4be2ab139952719ade74bcd07a87faa2 Signed-off-by: Bryan Sullivan <bryan.sullivan@att.com>
-rw-r--r--docs/ves_data_model.json70
1 files changed, 53 insertions, 17 deletions
diff --git a/docs/ves_data_model.json b/docs/ves_data_model.json
index f74470a..e88a927 100644
--- a/docs/ves_data_model.json
+++ b/docs/ves_data_model.json
@@ -3,7 +3,7 @@
"definitions": {
"CopyrightNotice": {
- "description": "Copyright (c) <2016>, AT&T Intellectual Property.",
+ "description": "Copyright (c) <2016-2017>, AT&T Intellectual Property.",
"type": "object",
"properties": {
"useAndRedistribution": {
@@ -28,6 +28,7 @@
"commandType": {
"type": "string",
"enum": [
+ "heartbeatIntervalChange",
"measurementIntervalChange",
"provideThrottlingState",
"throttlingSpecification"
@@ -38,14 +39,6 @@
},
"required": [ "commandType" ]
},
- "commandListEntry": {
- "description": "command from an event collector toward an event source",
- "type": "object",
- "properties": {
- "command": {"$ref": "#/definitions/command"}
- },
- "required": [ "command" ]
- },
"commandList": {
"description": "array of commands from an event collector toward an event source",
"type": "array",
@@ -54,6 +47,14 @@
},
"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",
@@ -84,6 +85,7 @@
"description": "function of the event source e.g., eNodeB, MME, PCRF",
"type": "string"
},
+ "internalHeaderFields": { "$ref": "#/definitions/internalHeaderFields" },
"lastEpochMicrosec": {
"description": "the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds",
"type": "number"
@@ -163,12 +165,12 @@
"required": [ "receiveDiscards", "receiveErrors", "transmitDiscards", "transmitErrors" ]
},
"event": {
- "description": "generic event format",
+ "description": "the root level of the common event format",
"type": "object",
"properties": {
"commonEventHeader": { "$ref": "#/definitions/commonEventHeader" },
"faultFields": { "$ref": "#/definitions/faultFields" },
- "measurementsForVfScalingFields": { "$ref": "#/definitions/measurementsForVfScalingFields" },
+ "measurementsForVfScalingFields": { "$ref": "#/definitions/measurementsForVfScalingFields" },
"mobileFlowFields": { "$ref": "#/definitions/mobileFlowFields" },
"otherFields": { "$ref": "#/definitions/otherFields" },
"stateChangeFields": { "$ref": "#/definitions/stateChangeFields" },
@@ -581,6 +583,10 @@
"roundTripTime", "timeToFirstByte"
]
},
+ "internalHeaderFields": {
+ "description": "enrichment fields for internal VES Event Listener service use only, not supplied by event sources",
+ "type": "object"
+ },
"latencyBucketMeasure": {
"description": "number of counts falling within a defined latency bucket",
"type": "object",
@@ -599,8 +605,8 @@
"measurements": {
"description": "array of name value pair measurements",
"type": "array",
- "items": {
- "$ref": "#/definitions/field"
+ "items": {
+ "$ref": "#/definitions/field"
}
}
},
@@ -678,11 +684,11 @@
"type": "number"
},
"memoryConfigured": {
- "description": "memory configured in the VM on which the VNFC reporting the event is running",
+ "description": "memory in MB configured in the VM on which the VNFC reporting the event is running",
"type": "number"
},
"memoryUsed": {
- "description": "memory usage of the VM on which the VNFC reporting the event is running",
+ "description": "memory usage in MB of the VM on which the VNFC reporting the event is running",
"type": "number"
},
"numberOfMediaPortsInUse": {
@@ -711,6 +717,13 @@
"description": "mobileFlow fields",
"type": "object",
"properties": {
+ "additionalFields": {
+ "description": "additional mobileFlow fields if needed",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/field"
+ }
+ },
"applicationType": {
"description": "Application type inferred",
"type": "string"
@@ -780,6 +793,10 @@
"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"
@@ -956,6 +973,10 @@
"description": "syslog message",
"type": "string"
},
+ "syslogPri": {
+ "description": "0-192 combined severity and facility",
+ "type": "number"
+ },
"syslogProc": {
"description": "identifies the application that originated the message",
"type": "string"
@@ -968,6 +989,14 @@
"description": "syslog structured data consisting of a structured data Id followed by a set of key value pairs",
"type": "string"
},
+ "syslogSdId": {
+ "description": "0-32 char in format name@number for example ourSDID@32473",
+ "type": "string"
+ },
+ "syslogSev": {
+ "description": "numerical Code for severity derived from syslogPri as remaider of syslogPri / 8",
+ "type": "string"
+ },
"syslogTag": {
"description": "msgId indicating the type of message such as TCPOUT or TCPIN; NILVALUE should be used when no other value can be provided",
"type": "string"
@@ -983,6 +1012,13 @@
"description": "fields specific to threshold crossing alert events",
"type": "object",
"properties": {
+ "additionalFields": {
+ "description": "additional threshold crossing alert fields if needed",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/field"
+ }
+ },
"additionalParameters": {
"description": "performance counters",
"type": "array",
@@ -1031,7 +1067,7 @@
"type": "string"
},
"elementType": {
- "description": "type of network element - internal ATT field",
+ "description": "type of network element",
"type": "string"
},
"eventSeverity": {
@@ -1054,7 +1090,7 @@
"type": "string"
},
"networkService": {
- "description": "network name - internal ATT field",
+ "description": "network name",
"type": "string"
},
"possibleRootCause": {