adapter/cmd/adapter.go

   1 /*
   2  *  Copyright (c) 2020 AT&T Intellectual Property.
   3  *  Copyright (c) 2020 Nokia.
   4  *
   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
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18  * platform project (RICP).
  19  */
  20
  21 package main
  22
  23 import (
  24         "encoding/json"
  25         "fmt"
  26         "time"
  27         "sync"
  28
  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"
  35
  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"
  38 )
  39
  40 type AlarmAdapter struct {
  41         amHost        string
  42         amBaseUrl     string
  43         amSchemes     []string
  44         alertInterval int
  45         activeAlarms  []alarm.Alarm
  46         mutex             sync.Mutex
  47         rmrReady      bool
  48 }
  49
  50 var Version string
  51 var Hash string
  52
  53 // Main function
  54 func main() {
  55         NewAlarmAdapter("", 0).Run(true)
  56 }
  57
  58 func NewAlarmAdapter(amHost string, alertInterval int) *AlarmAdapter {
  59         if alertInterval == 0 {
  60                 alertInterval = viper.GetInt("promAlertManager.alertInterval")
  61         }
  62
  63         if amHost == "" {
  64                 amHost = viper.GetString("promAlertManager.address")
  65         }
  66
  67         return &AlarmAdapter{
  68                 rmrReady:      false,
  69                 amHost:        amHost,
  70                 amBaseUrl:     viper.GetString("promAlertManager.baseUrl"),
  71                 amSchemes:     []string{viper.GetString("promAlertManager.schemes")},
  72                 alertInterval: alertInterval,
  73                 activeAlarms:  make([]alarm.Alarm, 0),
  74         }
  75 }
  76
  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)
  81
  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")
  85
  86         // Start background timer for re-raising alerts
  87         go a.StartAlertTimer()
  88
  89         app.RunWithParams(a, sdlcheck)
  90 }
  91
  92 func (a *AlarmAdapter) StartAlertTimer() {
  93         tick := time.Tick(time.Duration(a.alertInterval) * time.Millisecond)
  94         for range tick {
  95                 a.mutex.Lock()
  96                 for _, m := range a.activeAlarms {
  97                         app.Logger.Info("Re-raising alarm: %v", m)
  98                         a.PostAlert(a.GenerateAlertLabels(m))
  99                 }
 100                 a.mutex.Unlock()
 101         }
 102 }
 103
 104 func (a *AlarmAdapter) Consume(rp *app.RMRParams) (err error) {
 105         app.Logger.Info("Message received!")
 106
 107         defer app.Rmr.Free(rp.Mbuf)
 108         switch rp.Mtype {
 109         case alarm.RIC_ALARM_UPDATE:
 110                 a.HandleAlarms(rp)
 111         default:
 112                 app.Logger.Info("Unknown Message Type '%d', discarding", rp.Mtype)
 113         }
 114
 115         return nil
 116 }
 117
 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)
 122                 return nil, err
 123         }
 124         app.Logger.Info("newAlarm: %v", m)
 125
 126         if _, ok := alarm.RICAlarmDefinitions[m.Alarm.SpecificProblem]; !ok {
 127                 app.Logger.Warn("Alarm (SP='%d') not recognized, ignoring ...", m.Alarm.SpecificProblem)
 128                 return nil, nil
 129         }
 130
 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!")
 135                 return nil, nil
 136         }
 137
 138         // Clear alarm if found from active alarm list
 139         if m.AlarmAction == alarm.AlarmActionClear {
 140                 if found {
 141                         a.activeAlarms = a.RemoveAlarm(a.activeAlarms, idx)
 142                         app.Logger.Info("Active alarm cleared!")
 143                 } else {
 144                         app.Logger.Info("No matching alarm found, ignoring!")
 145                 }
 146                 return nil, nil
 147         }
 148
 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))
 153         }
 154
 155         return nil, nil
 156 }
 157
 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 {
 162                         return i, true
 163                 }
 164         }
 165         return -1, false
 166 }
 167
 168 func (a *AlarmAdapter) RemoveAlarm(alarms []alarm.Alarm, i int) []alarm.Alarm {
 169         a.mutex.Lock()
 170         defer a.mutex.Unlock()
 171
 172         copy(alarms[i:], alarms[i+1:])
 173         return alarms[:len(alarms)-1]
 174 }
 175
 176 func (a *AlarmAdapter) UpdateActiveAlarms(newAlarm alarm.Alarm) {
 177         a.mutex.Lock()
 178         defer a.mutex.Unlock()
 179
 180         // For now just keep the active alarms in-memory. Use SDL later
 181         a.activeAlarms = append(a.activeAlarms, newAlarm)
 182 }
 183
 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",
 191         }
 192         amAnnotations := models.LabelSet{
 193                 "description":     newAlarm.IdentifyingInfo,
 194                 "additional_info": newAlarm.AdditionalInfo,
 195                 "summary":         alarmDef.EventType,
 196                 "instructions":    alarmDef.OperationInstructions,
 197         }
 198
 199         return amLabels, amAnnotations
 200 }
 201
 202 func (a *AlarmAdapter) NewAlertmanagerClient() *client.Alertmanager {
 203         cr := clientruntime.New(a.amHost, a.amBaseUrl, a.amSchemes)
 204         return client.New(cr, strfmt.Default)
 205 }
 206
 207 func (a *AlarmAdapter) PostAlert(amLabels, amAnnotations models.LabelSet) (*alert.PostAlertsOK, error) {
 208         pa := &models.PostableAlert{
 209                 Alert: models.Alert{
 210                         GeneratorURL: strfmt.URI(""),
 211                         Labels:       amLabels,
 212                 },
 213                 Annotations: amAnnotations,
 214         }
 215         alertParams := alert.NewPostAlertsParams().WithAlerts(models.PostableAlerts{pa})
 216
 217         app.Logger.Info("Posting alerts: labels: %v, annotations: %v", amLabels, amAnnotations)
 218         ok, err := a.NewAlertmanagerClient().Alert.PostAlerts(alertParams)
 219         if err != nil {
 220                 app.Logger.Error("Posting alerts to '%s/%s' failed with error: %v", a.amHost, a.amBaseUrl, err)
 221         }
 222         return ok, err
 223 }
 224
 225 func (a *AlarmAdapter) StatusCB() bool {
 226         if !a.rmrReady {
 227                 app.Logger.Info("RMR not ready yet!")
 228         }
 229
 230         return a.rmrReady
 231 }