2 * Copyright (c) 2020 AT&T Intellectual Property.
3 * Copyright (c) 2020 Nokia.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
17 * This source code is part of the near-RT RIC (RAN Intelligent Controller)
18 * platform project (RICP).
29 clientruntime "github.com/go-openapi/runtime/client"
30 "github.com/go-openapi/strfmt"
31 "github.com/prometheus/alertmanager/api/v2/client"
32 "github.com/prometheus/alertmanager/api/v2/client/alert"
33 "github.com/prometheus/alertmanager/api/v2/models"
34 "github.com/spf13/viper"
36 "gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
37 app "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
40 type AlarmAdapter struct {
45 activeAlarms []alarm.Alarm
55 NewAlarmAdapter("", 0).Run(true)
58 func NewAlarmAdapter(amHost string, alertInterval int) *AlarmAdapter {
59 if alertInterval == 0 {
60 alertInterval = viper.GetInt("promAlertManager.alertInterval")
64 amHost = viper.GetString("promAlertManager.address")
70 amBaseUrl: viper.GetString("promAlertManager.baseUrl"),
71 amSchemes: []string{viper.GetString("promAlertManager.schemes")},
72 alertInterval: alertInterval,
73 activeAlarms: make([]alarm.Alarm, 0),
77 func (a *AlarmAdapter) Run(sdlcheck bool) {
78 app.Logger.SetMdc("alarmAdapter", fmt.Sprintf("%s:%s", Version, Hash))
79 app.SetReadyCB(func(d interface{}) { a.rmrReady = true }, true)
80 app.Resource.InjectStatusCb(a.StatusCB)
82 app.Resource.InjectRoute("/ric/v1/alarms", a.GetActiveAlarms, "GET")
83 app.Resource.InjectRoute("/ric/v1/alarms", a.RaiseAlarm, "POST")
84 app.Resource.InjectRoute("/ric/v1/alarms", a.ClearAlarm, "DELETE")
86 // Start background timer for re-raising alerts
87 go a.StartAlertTimer()
89 app.RunWithParams(a, sdlcheck)
92 func (a *AlarmAdapter) StartAlertTimer() {
93 tick := time.Tick(time.Duration(a.alertInterval) * time.Millisecond)
96 for _, m := range a.activeAlarms {
97 app.Logger.Info("Re-raising alarm: %v", m)
98 a.PostAlert(a.GenerateAlertLabels(m))
104 func (a *AlarmAdapter) Consume(rp *app.RMRParams) (err error) {
105 app.Logger.Info("Message received!")
107 defer app.Rmr.Free(rp.Mbuf)
109 case alarm.RIC_ALARM_UPDATE:
112 app.Logger.Info("Unknown Message Type '%d', discarding", rp.Mtype)
118 func (a *AlarmAdapter) HandleAlarms(rp *app.RMRParams) (*alert.PostAlertsOK, error) {
119 var m alarm.AlarmMessage
120 if err := json.Unmarshal(rp.Payload, &m); err != nil {
121 app.Logger.Error("json.Unmarshal failed: %v", err)
124 app.Logger.Info("newAlarm: %v", m)
126 if _, ok := alarm.RICAlarmDefinitions[m.Alarm.SpecificProblem]; !ok {
127 app.Logger.Warn("Alarm (SP='%d') not recognized, ignoring ...", m.Alarm.SpecificProblem)
131 // Suppress duplicate alarms
132 idx, found := a.IsMatchFound(m.Alarm)
133 if found && m.AlarmAction != alarm.AlarmActionClear {
134 app.Logger.Info("Duplicate alarm ... suppressing!")
138 // Clear alarm if found from active alarm list
139 if m.AlarmAction == alarm.AlarmActionClear {
141 a.activeAlarms = a.RemoveAlarm(a.activeAlarms, idx)
142 app.Logger.Info("Active alarm cleared!")
144 app.Logger.Info("No matching alarm found, ignoring!")
149 // New alarm -> update active alarms and post to Alert Manager
150 if m.AlarmAction == alarm.AlarmActionRaise {
151 a.UpdateActiveAlarms(m.Alarm)
152 return a.PostAlert(a.GenerateAlertLabels(m.Alarm))
158 func (a *AlarmAdapter) IsMatchFound(newAlarm alarm.Alarm) (int, bool) {
159 for i, m := range a.activeAlarms {
160 if m.ManagedObjectId == newAlarm.ManagedObjectId && m.ApplicationId == newAlarm.ApplicationId &&
161 m.SpecificProblem == newAlarm.SpecificProblem && m.IdentifyingInfo == newAlarm.IdentifyingInfo {
168 func (a *AlarmAdapter) RemoveAlarm(alarms []alarm.Alarm, i int) []alarm.Alarm {
170 defer a.mutex.Unlock()
172 copy(alarms[i:], alarms[i+1:])
173 return alarms[:len(alarms)-1]
176 func (a *AlarmAdapter) UpdateActiveAlarms(newAlarm alarm.Alarm) {
178 defer a.mutex.Unlock()
180 // For now just keep the active alarms in-memory. Use SDL later
181 a.activeAlarms = append(a.activeAlarms, newAlarm)
184 func (a *AlarmAdapter) GenerateAlertLabels(newAlarm alarm.Alarm) (models.LabelSet, models.LabelSet) {
185 alarmDef := alarm.RICAlarmDefinitions[newAlarm.SpecificProblem]
186 amLabels := models.LabelSet{
187 "alertname": alarmDef.AlarmText,
188 "severity": string(newAlarm.PerceivedSeverity),
189 "service": fmt.Sprintf("%s:%s", newAlarm.ManagedObjectId, newAlarm.ApplicationId),
190 "system_name": "RIC",
192 amAnnotations := models.LabelSet{
193 "description": newAlarm.IdentifyingInfo,
194 "additional_info": newAlarm.AdditionalInfo,
195 "summary": alarmDef.EventType,
196 "instructions": alarmDef.OperationInstructions,
199 return amLabels, amAnnotations
202 func (a *AlarmAdapter) NewAlertmanagerClient() *client.Alertmanager {
203 cr := clientruntime.New(a.amHost, a.amBaseUrl, a.amSchemes)
204 return client.New(cr, strfmt.Default)
207 func (a *AlarmAdapter) PostAlert(amLabels, amAnnotations models.LabelSet) (*alert.PostAlertsOK, error) {
208 pa := &models.PostableAlert{
210 GeneratorURL: strfmt.URI(""),
213 Annotations: amAnnotations,
215 alertParams := alert.NewPostAlertsParams().WithAlerts(models.PostableAlerts{pa})
217 app.Logger.Info("Posting alerts: labels: %v, annotations: %v", amLabels, amAnnotations)
218 ok, err := a.NewAlertmanagerClient().Alert.PostAlerts(alertParams)
220 app.Logger.Error("Posting alerts to '%s/%s' failed with error: %v", a.amHost, a.amBaseUrl, err)
225 func (a *AlarmAdapter) StatusCB() bool {
227 app.Logger.Info("RMR not ready yet!")