docs/sections/apis/ves-hv/VesEvent.proto

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * dcaegen2-collectors-veshv
   4  * ================================================================================
   5  * Copyright (C) 2018 NOKIA
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 syntax = "proto3";
  21 package org.onap.ves;
  22
  23 message VesEvent                            // top-level message, currently the maximum event size supported by the HV-VES Collector is 1 MiB
  24 {
  25     CommonEventHeader commonEventHeader=1;  // required
  26
  27     bytes eventFields=2;                    // required, payload
  28         // this field contains a domain-specific GPB message
  29         // the field being opaque (bytes), the decoding of the payload occurs in a separate step
  30         // the name of the GPB message for domain XYZ is XyzFields
  31         // e.g. for domain==perf3gpp, the GPB message is Perf3gppFields
  32 }
  33
  34 // VES CommonEventHeader adapted to GPB (Google Protocol Buffers)
  35 // Aligned with VES 7.0.1 schema, and extending to Performance Domain.
  36
  37 message CommonEventHeader
  38 {
  39     string version = 1;                     // required, "version of the gpb common event header", current value "1.0"
  40     string domain = 2;                      // required, "the eventing domain associated with the event", allowed values:
  41                                             // fault, heartbeat, measurement, mobileFlow, other, pnfRegistration, sipSignaling,
  42                                             // stateChange, syslog, thresholdCrossingAlert, voiceQuality, perf3gpp
  43
  44     uint32 sequence = 3;                    // required, "ordering of events communicated by an event source instance or 0 if not needed"
  45
  46     enum Priority
  47     {
  48         PRIORITY_NOT_PROVIDED = 0;
  49         HIGH = 1;
  50         MEDIUM = 2;
  51         NORMAL = 3;
  52         LOW = 4;
  53     }
  54     Priority priority = 4;                  // required, "processing priority"
  55
  56     string eventId = 5;                     // required, "event key that is unique to the event source"
  57     string eventName = 6;                   // required, "unique event name"
  58     string eventType = 7;                   // "for example - guest05,  platform"
  59
  60     uint64 lastEpochMicrosec = 8;           // required, "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"
  61     uint64 startEpochMicrosec = 9;          // required, "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"
  62
  63     string nfNamingCode = 10;               // "4 character network function type, aligned with vnf naming standards"
  64     string nfcNamingCode = 11;              // "3 character network function component type, aligned with vfc naming standards"
  65     string nfVendorName = 12;               // " Vendor Name providing the nf "
  66
  67     bytes reportingEntityId = 13;           // "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process"
  68     string reportingEntityName = 14;        // required, "name of the entity reporting the event, for example, an EMS name; may be the same as sourceName should match A&AI entry"
  69     bytes sourceId = 15;                    // "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process"
  70     string sourceName = 16;                 // required, "name of the entity experiencing the event issued use A&AI entry"
  71     string timeZoneOffset = 17;             // "Offset to GMT to indicate local time zone for the device"
  72     string vesEventListenerVersion = 18;    // required, "Version of the VesEvent Listener", current value "7.0.2"
  73
  74     reserved "InternalHeaderFields";        // "enrichment fields for internal VES Event Listener service use only, not supplied by event sources"
  75     reserved 100;
  76 }