2 * ============LICENSE_START=======================================================
3 * ONAP : ccsdk features
4 * ================================================================================
5 * Copyright (C) 2021 highstreet technologies GmbH Intellectual Property.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
22 package org.onap.ccsdk.features.sdnr.wt.devicemanager.oran.impl.binding;
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.yang.gen.v1.urn.o.ran.fm._1._0.rev190204.AlarmNotif;
29 import org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
35 * Maps ORAN Fault fields to VES fault domain fields and VES commonEventHeader fields
41 * eventId "nt:network-topology/nt:topology/nt:node/nt:node-id"
42 * eventName "nt:network-topology/nt:topology/nt:node/nt:node-id"
43 * eventType "O-RAN-RU-Fault"
44 * 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.
45 * nfcNamingCode always ""
46 * nfNamingCode always ""
47 * nfVendorName /ietf-hardware:hardware/component[not(parent)][1]/mfg-name
49 * reportingEntityId The OAM-Controller identifier with in the SMO - e.g. the fully qualified domain name or IP-Address.
50 * reportingEntityName as configured by helm charts for the OpenDaylight cluster name ??????
51 * sequence As per NetConf notification increasing sequence number as unsigned integer 32 bits. The value is reused in the eventId field.
52 * 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.
53 * sourceName "nt:network-topology/nt:topology/nt:node/nt:node-id"
54 * startEpochMicrosec Current OAM-Controller Node timestamp in unix time format - as microseconds elapsed since 1 Jan 1970 not including leap seconds.
55 * timeZoneOffset Static text: "+00:00"
57 * vesEventListenerVersion "7.2.1"
60 * alarmAdditionalInformation
61 * alarmCondition Value of "o-ran-fm:alarm-notif/fault-id"
62 * alarmInterfaceA Value of "o-ran-fm:alarm-notif/fault-source"
63 * eventCategory Static text "O-RU failure"
64 * eventSeverity Value of "o-ran-fm:alarm-notif/fault-severity". But if "o-ran-fm:alarm-notif/is-cleared" then "NORMAL"
65 * eventSourceType The value of ietf-hardware (RFC8348) /hardware/component[not(parent)][1]/model-name or "O-RU" if not found.
66 * faultFieldsVersion "4.0"
67 * specificProblem A mapping of the fault-id to its description according to O-RAN OpenFronthaul specification.
73 public class ORanFaultToVESFaultMapper {
75 @SuppressWarnings("unused")
76 private static final Logger LOG = LoggerFactory.getLogger(ORanFaultToVESFaultMapper.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
84 private final VESCollectorService vesProvider;
85 private final String notifName; // Name
86 private final String nodeIdString; // Sourcename
87 private String mfgName;
89 private String modelName;
91 public ORanFaultToVESFaultMapper(NodeId nodeId, VESCollectorService vesCollectorService,
93 this.nodeIdString = nodeId.getValue();
94 this.vesProvider = vesCollectorService;
95 this.notifName = notifName;
98 public void setMfgName(String mfgName) {
99 this.mfgName= mfgName;
102 private String getMfgName() {
106 public void setUuid(String uuid) {
110 private String getUuid() {
114 public void setModelName(String modelName) {
115 this.modelName = modelName;
118 private String getModelName() {
122 public VESCommonEventHeaderPOJO mapCommonEventHeader(AlarmNotif notification, Instant eventTime, int sequenceNo) {
123 VESCommonEventHeaderPOJO vesCEH = new VESCommonEventHeaderPOJO();
124 vesCEH.setDomain(VES_EVENT_DOMAIN);
125 vesCEH.setEventName(notifName);
126 vesCEH.setEventType(VES_EVENTTYPE);
127 vesCEH.setPriority(VES_EVENT_PRIORITY);
131 eventId = notifName + "-" + Long.toUnsignedString(sequenceNo);
133 vesCEH.setEventId(eventId);
134 vesCEH.setStartEpochMicrosec(eventTime.toEpochMilli() * 1000);
135 vesCEH.setLastEpochMicrosec(eventTime.toEpochMilli() * 1000);
136 vesCEH.setNfVendorName(getMfgName());
137 vesCEH.setReportingEntityName(vesProvider.getConfig().getReportingEntityName());
138 vesCEH.setSequence(sequenceNo);
139 vesCEH.setSourceId(getUuid());
140 vesCEH.setSourceName(nodeIdString);
145 public VESFaultFieldsPOJO mapFaultFields(AlarmNotif alarmNotif) {
146 VESFaultFieldsPOJO vesFaultFields = new VESFaultFieldsPOJO();
148 vesFaultFields.setAlarmCondition(alarmNotif.getFaultId().toString());
149 vesFaultFields.setAlarmInterfaceA(alarmNotif.getFaultSource());
150 vesFaultFields.setEventCategory(VES_EVENT_CATEGORY);
151 if (alarmNotif.getIsCleared()) {
152 vesFaultFields.setEventSeverity("NORMAL");
154 vesFaultFields.setEventSeverity(alarmNotif.getFaultSeverity().getName());
156 vesFaultFields.setEventSourceType(getModelName());
157 vesFaultFields.setFaultFieldsVersion(VES_FAULT_FIELDS_VERSION);
158 vesFaultFields.setSpecificProblem(alarmNotif.getFaultText());
159 vesFaultFields.setVfStatus(VES_FAULT_FIELDS_VFSTATUS);
161 return vesFaultFields;