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: float
 144     measChangeType: added
 145     measResultUnits: number
 146     measType: VS.NINFC.IntraFrPscelChAttempt
 147     measAdditionalFields:
 148       vendorField1: X
 149       vendorField2: B
 150 ...
 151 ---
 152 pmMetaData:
 153   pmHeader:
 154     nfType: gnb-Nokia
 155     pmDefSchemaVsn: 2.0
 156     pmDefVsn: 5G19_1906_002
 157   pmFields:
 158     iMeasInfoId: 2204
 159     iMeasType: 2
 160     measCollectionMethod: CC
 161     measCondition: "This measurement is updated when the TDCoverall timer has elapsed before gNB receives the X2AP: SgNB Modification Confirm message."
 162     measDescription: "This measurement the number of intra gNB intra frequency PSCell change failures due to TDCoverall timer expiry."
 163     measFamily: NINFC
 164     measInfoId: "NR Intra Frequency PSCell Change"
 165     measLastChange: 5G18A_1807_003
 166     measObjClass: NGCELL
 167     measResultRange: 0-4096
 168     measResultType: float
 169     measChangeType: added
 170     measResultUnits: number
 171     measType: VS.NINFC.IntraFrPscelChFailTdcExp
 172     measAdditionalFields:
 173       vendorField1:
 174         - Y
 175         - X
 176 ...
 177 ---
 178 pmMetaData:
 179   pmHeader:
 180     nfType: gnb-Nokia
 181     pmDefSchemaVsn: 2.0
 182     pmDefVsn: 5G19_1906_002
 183   pmFields:
 184     iMeasInfoId: 2206
 185     iMeasType: 1
 186     measCondition: "This measurement is updated when MeNB replies to X2AP: SgNB Modification Required message with the X2AP: SgNB Modification Refuse message."
 187     measCollectionMethod: CC
 188     measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change failures due to MeNB refusal."
 189     measFamily: NINFC
 190     measInfoId: "NR Intra Frequency PSCell Change"
 191     measLastChange: 5G19_1906_002
 192     measObjClass: NGCELL
 193     measResultRange: 0-4096
 194     measResultType: float
 195     measChangeType: added
 196     measResultUnits: number
 197     measType: VS.NINFC.IntraFrPscelChFailMenbRef
 198     measAdditionalFields:
 199       vendorField1:
 200         - X
 201         - Y
 202       vendorField2: A
 203 ...
 204 ---
 205 pmMetaData:
 206   pmHeader:
 207     nfType: gnb-Nokia
 208     pmDefSchemaVsn: 2.0
 209     pmDefVsn: 5G19_1906_002
 210   pmFields:
 211     iMeasInfoId: 2206
 212     iMeasType: 1
 213     measCondition: "This measurement is updated when MeNB replies to X2AP: SgNB Modification Required message with the X2AP: SgNB Modification Refuse message."
 214     measCollectionMethod: CC
 215     measDescription: "This counter indicates the number of intra gNB intra frequency PSCell change failures due to MeNB refusal."
 216     measFamily: NINFC
 217     measInfoId: "NR Intra Frequency PSCell Change"
 218     measLastChange: 5G19_1906_002
 219     measObjClass: NGCELL
 220     measResultRange: 0-4096
 221     measResultType: float
 222     measChangeType: added
 223     measResultUnits: number
 224     measType: VS.NINFC.IntraFrPscelChFailMenbRef
 225     measAdditionalFields:
 226       vendorField1:
 227         - X
 228         - Z
 229       vendorField2: A
 230 ...