docs/sections/apis/ves-hv/MeasDataCollection.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 // Definition for RTPM, structure aligned with 3GPP PM format optimized for RTPM delivery pre-standard TS 28.550 V2.0.0 (2018-09).
  24 // Some field details are taken from 3GPP TS 32.436 V15.0.0 (2018-06) ASN.1 file.
  25 // Note (2018-09): work is in progress for 3GPP TS 28.550. Changes will be made, if needed, to align with final version.
  26 // Differences/additions to 3GPP TS 28.550 are marked with "%%".
  27
  28 message MeasDataCollection                  // top-level message
  29 {
  30     // %% Combined messageFileHeader, measData (single instance), messageFileFooter (not needed: timestamp = collectionBeginTime + granularityPeriod).
  31     string formatVersion = 1;               // required, current value "28.550 2.0"
  32     uint32 granularityPeriod = 2;           // required, duration in seconds, %% moved from MeasInfo (single reporting period per event)
  33     string measuredEntityUserName = 3;      // network function user definable name ("userLabel") defined for the measured entity in 3GPP TS 28.622
  34     string measuredEntityDn = 4;            // DN as per 3GPP TS 32.300
  35     string measuredEntitySoftwareVersion = 5;
  36     repeated string measObjInstIdList = 6; // %%: optional, monitored object LDNs as per 3GPP TS 32.300 and 3GPP TS 32.432
  37     repeated MeasInfo measInfo = 7;
  38 }
  39
  40 message MeasInfo
  41 {
  42     oneof MeasInfoId {                      // measurement group identifier
  43         uint32 iMeasInfoId = 1;             // identifier as integer (%%: more compact)
  44         string sMeasInfoId = 2;             // identifier as string (more generic)
  45     }
  46
  47     oneof MeasTypes {                       // measurement identifiers associated with the measurement results
  48         IMeasTypes iMeasTypes = 3;          // identifiers as integers (%%: more compact)
  49         SMeasTypes sMeasTypes = 4;          // identifiers as strings (more generic)
  50     }
  51     // Needed only because GPB does not support repeated fields directly inside 'oneof'
  52     message IMeasTypes { repeated uint32 iMeasType = 1; }
  53     message SMeasTypes { repeated string sMeasType = 1; }
  54
  55     string jobId = 5;
  56     repeated MeasValue measValues = 6;      // performance measurements grouped by measurement object
  57 }
  58
  59 message MeasValue
  60 {
  61     oneof MeasObjInstId {                   // monitored object LDN as per 3GPP TS 32.300 and 3GPP TS 32.432
  62         string sMeasObjInstId = 1;          // LDN itself
  63         uint32 measObjInstIdListIdx = 2;    // %%: index into measObjInstIdList (1-based)
  64     }
  65     repeated MeasResult measResults = 3;
  66     bool suspectFlag = 4;
  67     map<string, string> measObjAddlFlds = 5; // %%: optional per-object data (name/value HashMap)
  68 }
  69
  70 message MeasResult
  71 {
  72     uint32 p = 1;                           // Index in the MeasTypes array (1-based), needed only if measResults has fewer elements than MeasTypes
  73     oneof xValue {
  74         sint64 iValue = 2;
  75         double rValue = 3;
  76         bool isNull = 4;
  77     }
  78 }