...
Sample 1 - Sample data for vFW and vDNS use cases; downloadable: ves5.3-measurement-vf5vdns.txt
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"event": {
"commonEventHeader": {
"startEpochMicrosec": 1500584201765465,
"sourceId": "Dummy VM UUID - No Metadata available",
"eventId": "11",
"reportingEntityId": "No UUID available",
"internalHeaderFields": {
"collectorTimeStamp": "Thu, 07 20 2017 08:56:52 GMT"
},
"eventType": "HTTP request rate",
"priority": "Normal",
"version": 1.2,
"reportingEntityName": "fwll",
"sequence": 11,
"domain": "measurementsForVfScaling",
"lastEpochMicrosec": 1500584212017216,
"eventName": "vnfScalingMeasurement",
"sourceName": "Dummy VM name - No Metadata available"
},
"measurementsForVfScalingFields": {
"cpuUsageArray": [{
"percentUsage": 0,
"cpuIdentifier": "cpu1",
"cpuIdle": 100,
"cpuUsageSystem": 0,
"cpuUsageUser": 0
}],
"measurementInterval": 10,
"requestRate": 7832,
"vNicUsageArray": [{
"transmittedOctetsDelta": 5680,
"receivedTotalPacketsDelta": 14,
"vNicIdentifier": "eth0",
"valuesAreSuspect": "true",
"transmittedTotalPacketsDelta": 31,
"receivedOctetsDelta": 1332
}],
"measurementsForVfScalingVersion": 2.1
}
}
}
|
...
Sample 2 - Sample data for general VES 5.3 use cases; downloadable: VES-5.3-measurement-mockup.txt
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"event":
{
"measurementsForVfScalingFields":
{
"measurementInterval":5,
"meanRequestLatency":0,
"additionalMeasurements":
[
{
"arrayOfFields":
[
{"name":"jvm.maxHeapSize", "value":"1040064" },
{"name":"jvm.peak.cpu", "value":"2.00" },
{"name":"jvm.usedMemory", "value":"284089"},
{"name":"jvm.freeMemory","value":"755975"},
{"name":"jvm.average.cpu","value":"0.41"}
],
"name":"virc-jvm"
},
{
"arrayOfFields":
[
{"name":"average.caps","value":"0.00"},
{"name":"mrf.numOfPlayedAnns","value":"0"},
{"name":"numOfSipServletErrors","value":"0"},
{"name":"numOfBlockOnMaxForwards","value":"0"},
{"name":"numOfBlockOnInvalidNumber","value":"0"},
{"name":"mrf.numOfFailuresOnNoAvailableMrf","value":"0"},
{"name":"mrf.numOfNotFoundAnns","value":"0"},
{"name":"dns.numOfSuccessfulDnsQueries","value":"0"},
{"name":"numOfCallAttempts","value":"0"},
{"name":"dns.numOfFailedDnsQueries","value":"0"}
],
"name":"virc-cc-generic"
},
{
"arrayOfFields":
[
{"name":"ccf.numOfAbnormalRfSessions","value":"0"},
{"name":"ccf.average.tps","value":"0.00"},
{"name":"ccf.low.tps","value":"0.00"},
{"name":"ccf.numOfDroppedAcrDueToBufferOverflow","value":"0"},
{"name":"ccf.numOfResentAcr","value":"0"},
{"name":"ccf.numOfFailedNotResentAcr","value":"0"},
{"name":"ccf.peak.tps","value":"0.00"},
{"name":"ccf.numOfActiveRfSessions","value":"14"}
],
"name":"virc-cc-ccf"
},
{
"arrayOfFields":
[
{"name":"inb.numOfCallReattemptsOnBgcfRouteAdvance","value":"0"},
{"name":"inb.average.call.block.latency","value":"0.00"},
{"name":"inb.numOfCallReattemptsOnBgcfNoAnswer","value":"0"},
{"name":"inb.average.call.setup.latency","value":"0.00"},
{"name":"inb.numOfCancelledCalls","value":"0"},
{"name":"inb.numOfBlockOnNpaNxxXxxxScreening","value":"0"},
{"name":"inb.numOfIncomingCalls","value":"0"},
{"name":"inb.numOfBlockOnOperatorCallScreening","value":"0"},
{"name":"inb.numOfAnsweredCalls","value":"0"},
{"name":"inb.numOfBlockOnFailedSiDerivation","value":"0"},
{"name":"inb.numOfBlockOnOrigCarrierScreening","value":"0"},
{"name":"inb.concurrentCalls","value":"0"},
{"name":"inb.numOfBlockOnSrvOrigDestScreening","value":"0"},
{"name":"inb.numOfFailedCalls","value":"0"},
{"name":"inb.average.caps","value":"0.00"},
{"name":"inb.numOfBlockOnNoAvailableBgcf","value":"0"},
{"name":"inb.peak.caps","value":"0.00"}
],
"name":"virc-cc-inbound"
},
{
"arrayOfFields":
[
{"name":"outb.numOfCallReAttemptsOnBgcfNoAnswer","value":"0"},
{"name":"outb.numOfBlockOnAdcScreening","value":"0"},
{"name":"outb.dom.numOfFailedCalls","value":"0"},
{"name":"outb.average.call.block.latency","value":"0.00"},
{"name":"outb.average.caps","value":"0.00"},
{"name":"outb.dom.numOfAnsweredCalls","value":"0"},
{"name":"outb.dom.numOfCancelledCalls","value":"0"},
{"name":"outb.numOfDestNumberPrefixManipulations","value":"0"},
{"name":"outb.transit.numOfCancelledCalls","value":"0"},
{"name":"outb.numOfBlockOnOrigCarrierScreening","value":"0"},
{"name":"outb.numOfBlockOnCspDetermination","value":"0"},
{"name":"outb.numOfNationalNumberManipulations","value":"0"},
{"name":"outb.numOfBlockOnCountryCodeScreening","value":"0"},
{"name":"outb.average.call.setup.latency","value":"0.00"},
{"name":"outb.numOfCallReAttemptsOnBgcfRouteAdvance","value":"0"},
{"name":"outb.numOfInterCarrierCallReattempts","value":"0"},
{"name":"outb.dom.numOfIncomingCalls","value":"0"},
{"name":"outb.numOfCliAnonymization","value":"0"},
{"name":"outb.numOfBlockOnLeadingZeroScreening","value":"0"},
{"name":"outb.concurrentCalls","value":"0"},
{"name":"outb.numOfBlockOnNoAvailableBgcf","value":"0"},
{"name":"outb.peak.caps","value":"0.00"},
{"name":"outb.numOfBlockOnFailedDcgDetermination","value":"0"},
{"name":"outb.transit.numOfAnsweredCalls","value":"0"},
{"name":"outb.numOfBlockOnFailedSiDerivation","value":"0"},
{"name":"outb.transit.numOfIncomingCalls","value":"0"},
{"name":"outb.numOfIntraCarrierCallReattempts","value":"0"},
{"name":"outb.transit.numOfFailedCalls","value":"0"},
{"name":"outb.numOfBlockOnSrvOrigDestScreening","value":"0"}
],
"name":"virc-cc-outbound"
},
{
"arrayOfFields":
[
{"name":"out.request.update","value":"0"},
{"name":"out.request.info","value":"0"},
{"name":"in.request.publish","value":"0"},
{"name":"in.request.ack","value":"0"},
{"name":"in.request.options","value":"0"},
{"name":"out.request.ack","value":"0"},
{"name":"in.request.invite","value":"0"},
{"name":"in.request.refer","value":"0"},
{"name":"out.request.subscribe","value":"0"},
{"name":"in.request.subscribe","value":"0"},
{"name":"out.request.message","value":"0"},
{"name":"in.request.info","value":"0"},
{"name":"out.request.notify","value":"0"},
{"name":"in.request.prack","value":"0"},
{"name":"in.response.1xx","value":"0"},
{"name":"in.request.notify","value":"0"},
{"name":"out.response.5xx","value":"0"},
{"name":"out.response.6xx","value":"0"},
{"name":"in.response.3xx","value":"0"},
{"name":"in.response.2xx","value":"0"},
{"name":"active.sip.sessions","value":"0"},
{"name":"in.request.cancel","value":"0"},
{"name":"out.request.bye","value":"0"},
{"name":"out.request.prack","value":"0"},
{"name":"out.response.1xx","value":"0"},
{"name":"out.response.2xx","value":"0"},
{"name":"in.request.register","value":"0"},
{"name":"in.request.bye","value":"0"},
{"name":"out.response.3xx","value":"0"},
{"name":"out.response.4xx","value":"0"},
{"name":"out.request.publish","value":"0"},
{"name":"out.request.options","value":"0"},
{"name":"out.request.invite","value":"0"},
{"name":"out.request.refer","value":"0"},
{"name":"out.request.register","value":"0"},
{"name":"in.request.update","value":"0"},
{"name":"in.response.5xx","value":"0"},
{"name":"in.response.4xx","value":"0"},
{"name":"in.request.message","value":"0"},
{"name":"out.request.cancel","value":"0"},
{"name":"in.response.6xx","value":"0"}
],
"name":"virc-cc-sip"
}
],
"concurrentSessions":0,
"measurementsForVfScalingVersion": 2
},
"commonEventHeader":
{
"reportingEntityName":"ircc0002vm049cca001",
"startEpochMicrosec":1496235300000000,
"lastEpochMicrosec":1496235600000000,
"eventId":"3409",
"sourceName":"ircc0002vm049cca001",
"sequence":0,
"priority":"Normal",
"domain":"measurementsForVfScaling",
"internalHeaderFields":
{
"collectorTimeStamp":"Wed, 05 31 2017 01:00:01 GMT"
},
"eventType":"Mfvs_ircc_cca",
"eventName":"Mfvs_ircc",
"version" : 3.0
}
}
}
|
...
JSON Field | JSON sub-field | Populate Using | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| { | |||||||||||||
| closedLoopControlName | closedLoopControlName included in the DCAE configuration Policy | The unique ID for the Control Loop. It is created by the CLAMP platform during Control Loop design. The DCAE Micro service that publishes this event structure MUST include this ID. | |||||||||||
| version | version included in the DCAE configuration Policy | The version of the Control Loop event message. Should be '1.0.2'. | |||||||||||
| requestID | Generate a UUID for this output message | For the control loop, when an instance of the Control Loop occurs, this unique ID must be created. The same ID must be forwarded for both the ONSET and the ABATED control loop messages. | |||||||||||
| closedLoopAlarmStart | commonEventHeader.startEpochMicrosec from the received VES measurementsForVfScaling message | When the alarm was first detected. | |||||||||||
| closedLoopEventClient | Concatenate name of this DCAE instance and name for this TCA instance, separated by "." | For monitoring/logging/auditing purposes, if there is an instance ID of the DCAE micro service this field should be populated with it. | |||||||||||
| target_type | "VNF" | The type of the target: VM or VNF. Future PNF(?). | |||||||||||
| target | "generic-vnf.vnf-idname" or "vserver.vserver-name" | This is the name of the field within the A&AI sub-tag that indicates the actual entity Node details. There should be a matching node field within the A&AI subtag holding this value. | |||||||||||
| AAI | { | Contains the A&AI Node-Attribute list. | |||||||||||
generic-vnf.vnf-idname | commonEventHeader.reportingEntityNamesourceName from the received VES measurementsForVfScaling message (value for the data element used in A&AI) | NEW: Updated on 10/23/17 to use vnf-name instead of vnf-id based on
| |||||||||||
| generic-vnf.in-maint | value | If the A&AI enrichment query added in JIRA
| |||||||||||
| generic-vnf.is-closed-loop-disabled | value | ||||||||||||
| generic-vnf.orchestration-status | value | ||||||||||||
| generic-vnf.prov-status | value | ||||||||||||
| generic-vnf.resource-version | value | ||||||||||||
| generic-vnf.service-id | value | ||||||||||||
| generic-vnf.vnf-nameid | value | ||||||||||||
| generic-vnf.vnf-type | value | ||||||||||||
| } | |||||||||||||
| from | "DCAE" | The ONAP platform component publishing this message. If DCAE, then it should be 'DCAE'. | |||||||||||
| policyScope | policyScope included in the DCAE configuration Policy | The version of the Policy driving the DCAE Micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller. | |||||||||||
| policyName | policyName included in the DCAE configuration Policy | The version of the Policy driving the DCAE Micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller. | |||||||||||
| policyVersion | policyVersion included in the DCAE configuration Policy | The version of the Policy driving the DCAE Micro service. Should be a part of the configuration policy setup by CLAMP and passed by DCAE controller. | |||||||||||
| closedLoopEventStatus | "ONSET" |
...
"controlLoopSchemaType": "VNF"
and the A&AI enrichment query fails or A&AI enrichment is disabled by setting the preference "enableAAIEnrichment" : false
Sample 3 - Sample Control Loop Event Message for vFW demo, "controlLoopSchemaType": "VNF"; no enrichmentAnchor SampleControlLoopMsgvFW SampleControlLoopMsgvFW
| Expand |
|---|
{ , |
...
"controlLoopSchemaType": "VM"
and the A&AI enrichment query failsfails or A&AI enrichment is disabled by setting the preference "enableAAIEnrichment" : false
Sample 4 - Sample Control Loop Event Message for vDNS/vLB demo, "controlLoopSchemaType": "VM", no enrichmentAnchor SampleControlLoopMsgvDNS SampleControlLoopMsgvDNS
| Expand |
|---|
{ "closedLoopEventClient": "DCAE_INSTANCE_ID.dcae-tca", "policyVersion": "1.0.0.5", "policyName": "vLoadBalancer", "policyScope": "resource=SampleResource,service=SampleService,type=SampleType,closedLoopControlName=SampleClosedLoop", "target_type": "VM", "AAI": { "vserver.vserver-name": "dfw1lb01lb01" }, "closedLoopAlarmStart": 1484855074322720, "closedLoopEventStatus": "ONSET", "closedLoopControlName": "CL-DNS-LOW-TRAFFIC-SIG-d925ed73-8231-4d02-9545-db4e101f88f8", "version": "1.0.2", "target": "vserver.vserver-name", "requestID": "8e9bc97e-795c-4195-820a-45a53a1db947", "from": "DCAE" } |
...
In both cases, the value of the fields, generic-vnf.vnf-id and name and vserver.vserver-name, is constructed from the incoming VES measurementsForVfScaling message received from the upstream collector in the field: commonEventHeader.reportingEntityNamesourceName.
Policy Interface
In the Data Flow Diagram, v1 - Flow 3c, the Policy Interface described here is shown in Flow 3c. This is how the application gets its policy config, whether it comes at deployment and instantiation time via an ASDC blueprint (Flow 2a), or, in later releases, based on being reconfigured by CLAMP via Policy, Flow 3a+3b.
...