gerrit.onap Code Review - ccsdk/features.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * ONAP : ccsdk features
   4  * ================================================================================
   5  * Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
   6  * All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  */
  22 package org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.impl.dom;
  23
  24 import java.time.Instant;
  25 import org.onap.ccsdk.features.sdnr.wt.devicemanager.service.VESCollectorService;
  26 import org.onap.ccsdk.features.sdnr.wt.devicemanager.types.VESCommonEventHeaderPOJO;
  27 import org.onap.ccsdk.features.sdnr.wt.devicemanager.types.VESFaultFieldsPOJO;
  28 import org.opendaylight.mdsal.dom.api.DOMNotification;
  29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
  30 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  31 import org.slf4j.Logger;
  32 import org.slf4j.LoggerFactory;
  33
  34 //@formatter:off
  35 /*
  36 * Maps ORAN Fault fields to VES fault domain fields and VES commonEventHeader fields
  37 *
  38 *
  39 *      VES Fields                  Mapping
  40 *      ----------                  -------
  41 *      domain                      "fault"
  42 *      eventId                     "nt:network-topology/nt:topology/nt:node/nt:node-id"
  43 *      eventName                   "nt:network-topology/nt:topology/nt:node/nt:node-id"
  44 *      eventType                   "O-RAN-RU-Fault"
  45 *      lastEpochMicrosec           TimeStamp represented by <eventTime> field in NetConf notification header in unix time format - as microseconds elapsed since 1 Jan 1970 not including leap seconds.
  46 *      nfcNamingCode               always ""
  47 *      nfNamingCode                always ""
  48 *      nfVendorName                /ietf-hardware:hardware/component[not(parent)][1]/mfg-name
  49 *      priority                    "Normal"
  50 *      reportingEntityId           The OAM-Controller identifier with in the SMO - e.g. the fully qualified domain name or IP-Address.
  51 *      reportingEntityName         as configured by helm charts for the OpenDaylight cluster name ??????
  52 *      sequence                    As per NetConf notification increasing sequence number as unsigned integer 32 bits. The value is reused in the eventId field.
  53 *      sourceId                    Value of ietf-hardware (RFC8348) /hardware/component[not(parent)][1]/uuid or 'nt:network-topology/nt:topology/nt:node/nt:node-id' if ietf component not found.
  54 *      sourceName                  "nt:network-topology/nt:topology/nt:node/nt:node-id"
  55 *      startEpochMicrosec          Current OAM-Controller Node timestamp in unix time format - as microseconds elapsed since 1 Jan 1970 not including leap seconds.
  56 *      timeZoneOffset              Static text: "+00:00"
  57 *      version                     "4.1"
  58 *      vesEventListenerVersion     "7.2.1"
  59 *
  60 *
  61 *      alarmAdditionalInformation
  62 *      alarmCondition              Value of "o-ran-fm:alarm-notif/fault-id"
  63 *      alarmInterfaceA             Value of "o-ran-fm:alarm-notif/fault-source"
  64 *      eventCategory               Static text "O-RU failure"
  65 *      eventSeverity               Value of "o-ran-fm:alarm-notif/fault-severity". But if "o-ran-fm:alarm-notif/is-cleared" then "NORMAL"
  66 *      eventSourceType             The value of ietf-hardware (RFC8348) /hardware/component[not(parent)][1]/model-name or "O-RU" if not found.
  67 *      faultFieldsVersion          "4.0"
  68 *      specificProblem             A mapping of the fault-id to its description according to O-RAN OpenFronthaul specification.
  69 *      vfStatus                    "Active"
  70 *
  71 */
  72 //@formatter:on
  73
  74 public class ORanDOMFaultToVESFaultMapper {
  75     @SuppressWarnings("unused")
  76     private static final Logger LOG = LoggerFactory.getLogger(ORanDOMFaultToVESFaultMapper.class);
  77     private static final String VES_EVENT_DOMAIN = "fault";
  78     private static final String VES_EVENTTYPE = "ORAN_Fault";
  79     private static final String VES_EVENT_PRIORITY = "Normal";
  80     private static final String VES_EVENT_CATEGORY = "O-RU Failure";
  81     private static final String VES_FAULT_FIELDS_VERSION = "4.0";
  82     private static final String VES_FAULT_FIELDS_VFSTATUS = "Active"; //virtual function status
  83
  84     private final VESCollectorService vesProvider;
  85     private final String notifName; // Name
  86     private final String nodeIdString; // Sourcename
  87     //Initialized during registration
  88     private String mfgName;
  89     private String uuid;
  90     private String modelName;
  91
  92     public ORanDOMFaultToVESFaultMapper(NodeId nodeId, VESCollectorService vesCollectorService, String notifName) {
  93         this.nodeIdString = nodeId.getValue();
  94         this.vesProvider = vesCollectorService;
  95         this.notifName = notifName;
  96     }
  97
  98     public void setMfgName(String mfgName) {
  99         this.mfgName = mfgName;
 100     }
 101
 102     public void setUuid(String uuid) {
 103         this.uuid = uuid;
 104     }
 105
 106     public void setModelName(String modelName) {
 107         this.modelName = modelName;
 108     }
 109
 110     public VESCommonEventHeaderPOJO mapCommonEventHeader(DOMNotification notification, Instant eventTime,
 111             int sequenceNo) {
 112         VESCommonEventHeaderPOJO vesCEH = new VESCommonEventHeaderPOJO();
 113         vesCEH.setDomain(VES_EVENT_DOMAIN);
 114         vesCEH.setEventName(notifName);
 115         vesCEH.setEventType(VES_EVENTTYPE);
 116         vesCEH.setPriority(VES_EVENT_PRIORITY);
 117
 118         String eventId = notifName + "-" + Long.toUnsignedString(sequenceNo);
 119
 120         vesCEH.setEventId(eventId);
 121         vesCEH.setStartEpochMicrosec(eventTime.toEpochMilli() * 1000);
 122         vesCEH.setLastEpochMicrosec(eventTime.toEpochMilli() * 1000);
 123         vesCEH.setNfVendorName(mfgName);
 124         vesCEH.setReportingEntityName(vesProvider.getConfig().getReportingEntityName());
 125         vesCEH.setSequence(sequenceNo);
 126         vesCEH.setSourceId(uuid);
 127         vesCEH.setSourceName(nodeIdString);
 128
 129         return vesCEH;
 130     }
 131
 132     public VESFaultFieldsPOJO mapFaultFields(DOMNotification alarmNotif) {
 133         VESFaultFieldsPOJO vesFaultFields = new VESFaultFieldsPOJO();
 134         ContainerNode cn = alarmNotif.getBody();
 135         vesFaultFields.setAlarmCondition(ORanDMDOMUtility.getLeafValue(cn, ORanDeviceManagerQNames.ORAN_FM_FAULT_ID));
 136         vesFaultFields
 137                 .setAlarmInterfaceA(ORanDMDOMUtility.getLeafValue(cn, ORanDeviceManagerQNames.ORAN_FM_FAULT_SOURCE));
 138         vesFaultFields.setEventCategory(VES_EVENT_CATEGORY);
 139         if (ORanDMDOMUtility.getLeafValue(cn, ORanDeviceManagerQNames.ORAN_FM_FAULT_IS_CLEARED).equals("true")) {
 140             vesFaultFields.setEventSeverity("NORMAL");
 141         } else {
 142             vesFaultFields.setEventSeverity(
 143                     ORanDMDOMUtility.getLeafValue(cn, ORanDeviceManagerQNames.ORAN_FM_FAULT_SEVERITY));
 144         }
 145         vesFaultFields.setEventSourceType(modelName);
 146         vesFaultFields.setFaultFieldsVersion(VES_FAULT_FIELDS_VERSION);
 147         vesFaultFields
 148                 .setSpecificProblem(ORanDMDOMUtility.getLeafValue(cn, ORanDeviceManagerQNames.ORAN_FM_FAULT_TEXT));
 149         vesFaultFields.setVfStatus(VES_FAULT_FIELDS_VFSTATUS);
 150
 151         return vesFaultFields;
 152     }
 153
 154 }