gerrit.onap Code Review - sdc.git/blob

   1 ---
   2 # PM Dictionary schema specifying and describing the meta information
   3 # used to define perf3gpp measurements in the PM Dictionary
   4 pmMetaData:
   5   presence: required
   6   structure:
   7     pmHeader:
   8       presence: required
   9       structure:
  10         nfType:
  11           presence: required
  12           comment: NF type; should match the nfName-vendor string used in the fileReady
  13             or perf3gpp eventName
  14         pmDefSchemaVsn:
  15           presence: required
  16           value: 2.0
  17           comment: PM Dictionary Schema Version from the VES Event Registration specification
  18         pmDefVsn:
  19           presence: required
  20           comment: vendor-defined PM Dictionary version
  21     pmFields:
  22       presence: required
  23       structure:
  24         iMeasInfoId:
  25           presence: required
  26           comment: vendor-defined integer measurement group identifier
  27         iMeasType:
  28           presence: required
  29           comment: vendor-defined integer identifier for the measType; must be combined
  30             with measInfoId to identify a specific measurement.
  31         measChangeType:
  32           presence: required
  33           value:
  34             - added
  35             - modified
  36             - deleted
  37           comment: indicates the type of change that occurred during measLastChange
  38         measCollectionMethod:
  39           presence: required
  40           value:
  41             - CC
  42             - SI
  43             - DER
  44             - Gauge
  45             - Average
  46           comment: the measurement collection method; CC, SI, DER and Gauge are as
  47             defined in 3GPP; average contains the average value of the measurement
  48             during the granularity period
  49         measCondition:
  50           presence: required
  51           comment: description of the condition causing the measurement
  52         measDescription:
  53           presence: required
  54           comment: description of the measurement information and purpose
  55         measFamily:
  56           presence: required
  57           comment: abbreviation for a family of measurements, in 3GPP format, or vendor
  58             defined
  59         measInfoId:
  60           presence: required
  61           comment: name for a group of related measurements in 3GPP format or vendor
  62             defined
  63         measLastChange:
  64           presence: required
  65           comment: version of the PM Dictionary the last time this measurement was
  66             added, modified or deleted
  67         measObjClass:
  68           presence: required
  69           value:
  70             - NGBTS
  71             - NGCELL
  72             - IPNO
  73             - IPSEC
  74             - ETHIF
  75           comment: measurement object class
  76         measResultRange:
  77           presence: optional
  78           comment: range of the measurement result; only necessary when the range
  79             is smaller than the full range of the data type
  80         measResultType:
  81           presence: required
  82           value:
  83             - float
  84             - uint32
  85             - uint64
  86           comment: data type of the measurement result
  87         measResultUnits:
  88           presence: required
  89           value:
  90             - seconds
  91             - minutes
  92             - nanoseconds
  93             - microseconds
  94             - dB
  95             - number
  96             - kilobytes
  97             - bytes
  98             - ethernetFrames
  99             - packets
 100             - users
 101           comment: units of measure for the measurement result
 102         measType:
 103           presence: required
 104           comment: measurement name in 3GPP or vendor-specific format; vendor specific
 105             names are preceded with VS
 106         measAdditionalFields:
 107           presence: required
 108           comment: vendor-specific PM Dictionary fields
 109           structure:
 110             vendorField1:
 111               presence: required
 112               value:
 113                 - X
 114                 - Y
 115                 - Z
 116               comment: vendor field 1 description
 117             vendorField2:
 118               presence: optional
 119               value:
 120                 - A
 121                 - B
 122               comment: vendor field 2 description.
 123 ...
 124 # PM Dictionary perf3gpp measurements for the gnb-Nokia NF (bracket style yaml)
 125 ---
 126 pmMetaData:
 127   pmHeader:
 128     nfType: gnb-Nokia
 129     pmDefSchemaVsn: 2.0
 130     pmDefVsn: 5G19_1906_002
 131   pmFields:
 132     iMeasInfoId: 2204
 133     iMeasType: 1
 134     measCollectionMethod: CC
 135     measCondition: "This measurement is updated when X2AP: SgNB Modification Required message is sent to MeNB
 136                       with the SCG Change Indication set as PSCellChange."
 137     measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change attempts."
 138     measFamily: NINFC
 139     measInfoId: "NR Intra Frequency PSCell Change"
 140     measLastChange: 5G18A_1807_003
 141     measObjClass: NGCELL
 142     measResultRange: 0-4096
 143     measResultType: integer
 144     measResultUnits: number
 145     measType: VS.NINFC.IntraFrPscelChAttempt
 146     measAdditionalFields:
 147       vendorField1: X
 148       vendorField2: B
 149 ...
 150 ---
 151 pmMetaData:
 152   pmHeader:
 153     nfType: gnb-Nokia
 154     pmDefSchemaVsn: 2.0
 155     pmDefVsn: 5G19_1906_002
 156   pmFields:
 157     iMeasInfoId: 2204
 158     iMeasType: 2
 159     measCollectionMethod: CC
 160     measCondition: "This measurement is updated when the TDCoverall timer has elapsed before gNB receives the X2AP: SgNB Modification Confirm message."
 161     measDescription: "This measurement the number of intra gNB intra frequency PSCell change failures due to TDCoverall timer expiry."
 162     measFamily: NINFC
 163     measInfoId: "NR Intra Frequency PSCell Change"
 164     measLastChange: 5G18A_1807_003
 165     measObjClass: NGCELL
 166     measResultRange: 0-4096
 167     measResultType: float
 168     measResultUnits: number
 169     measType: VS.NINFC.IntraFrPscelChFailTdcExp
 170     measAdditionalFields:
 171       vendorField1:
 172         - Y
 173         - X
 174 ...
 175 ---
 176 pmMetaData:
 177   pmHeader:
 178     nfType: gnb-Nokia
 179     pmDefSchemaVsn: 2.0
 180     pmDefVsn: 5G19_1906_002
 181   pmFields:
 182     iMeasInfoId: 2206
 183     iMeasType: 1
 184     measCondition: "This measurement is updated when MeNB replies to X2AP: SgNB Modification Required message with the X2AP: SgNB Modification Refuse message."
 185     measCollectionMethod: CC
 186     measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change failures due to MeNB refusal."
 187     measFamily: NINFC
 188     measInfoId: "NR Intra Frequency PSCell Change"
 189     measLastChange: 5G19_1906_002
 190     measObjClass: NGCELL
 191     measResultRange: 0-4096
 192     measResultType: float
 193     measChangeType: added
 194     measResultUnits: number
 195     measType: VS.NINFC.IntraFrPscelChFailMenbRef
 196     measAdditionalFields:
 197       vendorField1:
 198         - Z
 199         - A
 200       vendorField2: A
 201 ...
 202 ---
 203 pmMetaData:
 204   pmHeader:
 205     nfType: gnb-Nokia
 206     pmDefSchemaVsn: 2.0
 207     pmDefVsn: 5G19_1906_002
 208   pmFields:
 209     iMeasInfoId: 2206
 210     iMeasType: 1
 211     measCondition: "This measurement is updated when MeNB replies to X2AP: SgNB Modification Required message with the X2AP: SgNB Modification Refuse message."
 212     measCollectionMethod: CC
 213     measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change failures due to MeNB refusal."
 214     measFamily: NINFC
 215     measInfoId: "NR Intra Frequency PSCell Change"
 216     measLastChange: 5G19_1906_002
 217     measObjClass: NGCELL
 218     measResultRange: 0-4096
 219     measResultType: float
 220     measChangeType: added
 221     measResultUnits: number
 222     measType: VS.NINFC.IntraFrPscelChFailMenbRef
 223     measAdditionalFields:
 224       vendorField1:
 225         - X
 226         - Y
 227       vendorField2: A
 228 ...