Support for REST interface
[ric-plt/alarm-go.git] / adapter / cmd / adapter.go
index 76112f9..f68d424 100755 (executable)
@@ -23,7 +23,6 @@ package main
 import (
        "encoding/json"
        "fmt"
-       "sync"
        "time"
 
        clientruntime "github.com/go-openapi/runtime/client"
@@ -37,67 +36,6 @@ import (
        app "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
 )
 
-type AlertStatus string
-
-const (
-       AlertStatusActive   = "active"
-       AlertStatusResolved = "resolved"
-)
-
-type AlarmAdapter struct {
-       amHost        string
-       amBaseUrl     string
-       amSchemes     []string
-       alertInterval int
-       activeAlarms  []alarm.Alarm
-       mutex         sync.Mutex
-       rmrReady      bool
-       postClear     bool
-}
-
-var Version string
-var Hash string
-
-// Main function
-func main() {
-       NewAlarmAdapter("", 0).Run(true)
-}
-
-func NewAlarmAdapter(amHost string, alertInterval int) *AlarmAdapter {
-       if alertInterval == 0 {
-               alertInterval = viper.GetInt("promAlertManager.alertInterval")
-       }
-
-       if amHost == "" {
-               amHost = viper.GetString("promAlertManager.address")
-       }
-
-       return &AlarmAdapter{
-               rmrReady:      false,
-               amHost:        amHost,
-               amBaseUrl:     viper.GetString("promAlertManager.baseUrl"),
-               amSchemes:     []string{viper.GetString("promAlertManager.schemes")},
-               alertInterval: alertInterval,
-               activeAlarms:  make([]alarm.Alarm, 0),
-       }
-}
-
-func (a *AlarmAdapter) Run(sdlcheck bool) {
-       app.Logger.SetMdc("alarmAdapter", fmt.Sprintf("%s:%s", Version, Hash))
-       app.SetReadyCB(func(d interface{}) { a.rmrReady = true }, true)
-       app.Resource.InjectStatusCb(a.StatusCB)
-
-       app.Resource.InjectRoute("/ric/v1/alarms", a.GetActiveAlarms, "GET")
-       app.Resource.InjectRoute("/ric/v1/alarms", a.RaiseAlarm, "POST")
-       app.Resource.InjectRoute("/ric/v1/alarms", a.ClearAlarm, "DELETE")
-
-       // Start background timer for re-raising alerts
-       a.postClear = sdlcheck
-       go a.StartAlertTimer()
-
-       app.RunWithParams(a, sdlcheck)
-}
-
 func (a *AlarmAdapter) StartAlertTimer() {
        tick := time.Tick(time.Duration(a.alertInterval) * time.Millisecond)
        for range tick {
@@ -133,35 +71,38 @@ func (a *AlarmAdapter) HandleAlarms(rp *app.RMRParams) (*alert.PostAlertsOK, err
        }
        app.Logger.Info("newAlarm: %v", m)
 
+       return a.ProcessAlarm(&m)
+}
+
+func (a *AlarmAdapter) ProcessAlarm(m *alarm.AlarmMessage) (*alert.PostAlertsOK, error) {
        if _, ok := alarm.RICAlarmDefinitions[m.Alarm.SpecificProblem]; !ok {
-               app.Logger.Warn("Alarm (SP='%d') not recognized, ignoring ...", m.Alarm.SpecificProblem)
+               app.Logger.Warn("Alarm (SP='%d') not recognized, suppressing ...", m.Alarm.SpecificProblem)
                return nil, nil
        }
 
        // Suppress duplicate alarms
        idx, found := a.IsMatchFound(m.Alarm)
        if found && m.AlarmAction != alarm.AlarmActionClear {
-               app.Logger.Info("Duplicate alarm ... suppressing!")
+               app.Logger.Info("Duplicate alarm found, suppressing ...")
                return nil, nil
        }
 
        // Clear alarm if found from active alarm list
        if m.AlarmAction == alarm.AlarmActionClear {
                if found {
-                       a.activeAlarms = a.RemoveAlarm(a.activeAlarms, idx)
-                       app.Logger.Info("Active alarm cleared!")
+                       a.activeAlarms = a.RemoveAlarm(a.activeAlarms, idx, "active")
 
                        if a.postClear {
                                return a.PostAlert(a.GenerateAlertLabels(m.Alarm, AlertStatusResolved))
                        }
                }
-               app.Logger.Info("No matching alarm found, ignoring!")
+               app.Logger.Info("No matching active alarm found, suppressing ...")
                return nil, nil
        }
 
        // New alarm -> update active alarms and post to Alert Manager
        if m.AlarmAction == alarm.AlarmActionRaise {
-               a.UpdateActiveAlarms(m.Alarm)
+               a.UpdateAlarmLists(m.Alarm)
                return a.PostAlert(a.GenerateAlertLabels(m.Alarm, AlertStatusActive))
        }
 
@@ -171,27 +112,39 @@ func (a *AlarmAdapter) HandleAlarms(rp *app.RMRParams) (*alert.PostAlertsOK, err
 func (a *AlarmAdapter) IsMatchFound(newAlarm alarm.Alarm) (int, bool) {
        for i, m := range a.activeAlarms {
                if m.ManagedObjectId == newAlarm.ManagedObjectId && m.ApplicationId == newAlarm.ApplicationId &&
-                       m.SpecificProblem == newAlarm.SpecificProblem && m.IdentifyingInfo == newAlarm.IdentifyingInfo {
+                       m.SpecificProblem == newAlarm.SpecificProblem && m.IdentifyingInfo == newAlarm.IdentifyingInfo &&
+                       m.PerceivedSeverity == newAlarm.PerceivedSeverity {
                        return i, true
                }
        }
        return -1, false
 }
 
-func (a *AlarmAdapter) RemoveAlarm(alarms []alarm.Alarm, i int) []alarm.Alarm {
+func (a *AlarmAdapter) RemoveAlarm(alarms []alarm.Alarm, i int, listName string) []alarm.Alarm {
        a.mutex.Lock()
        defer a.mutex.Unlock()
 
+       app.Logger.Info("Alarm '%+v' deleted from the '%s' list", alarms[i], listName)
        copy(alarms[i:], alarms[i+1:])
        return alarms[:len(alarms)-1]
 }
 
-func (a *AlarmAdapter) UpdateActiveAlarms(newAlarm alarm.Alarm) {
+func (a *AlarmAdapter) UpdateAlarmLists(newAlarm alarm.Alarm) {
        a.mutex.Lock()
        defer a.mutex.Unlock()
 
-       // For now just keep the active alarms in-memory. Use SDL later
+       // If maximum number of active alarms is reached, purge the oldest alarm
+       if len(a.activeAlarms) >= viper.GetInt("controls.maxActiveAlarms") {
+               a.activeAlarms = a.RemoveAlarm(a.activeAlarms, 0, "active")
+       }
+
+       if len(a.alarmHistory) >= viper.GetInt("controls.maxAlarmHistory") {
+               a.alarmHistory = a.RemoveAlarm(a.alarmHistory, 0, "history")
+       }
+
+       // @todo: For now just keep the alarms (both active and history) in-memory. Use SDL later for persistence
        a.activeAlarms = append(a.activeAlarms, newAlarm)
+       a.alarmHistory = append(a.alarmHistory, newAlarm)
 }
 
 func (a *AlarmAdapter) GenerateAlertLabels(newAlarm alarm.Alarm, status AlertStatus) (models.LabelSet, models.LabelSet) {
@@ -244,3 +197,45 @@ func (a *AlarmAdapter) StatusCB() bool {
 
        return a.rmrReady
 }
+
+func (a *AlarmAdapter) Run(sdlcheck bool) {
+       app.Logger.SetMdc("alarmAdapter", fmt.Sprintf("%s:%s", Version, Hash))
+       app.SetReadyCB(func(d interface{}) { a.rmrReady = true }, true)
+       app.Resource.InjectStatusCb(a.StatusCB)
+
+       app.Resource.InjectRoute("/ric/v1/alarms", a.RaiseAlarm, "POST")
+       app.Resource.InjectRoute("/ric/v1/alarms", a.ClearAlarm, "DELETE")
+       app.Resource.InjectRoute("/ric/v1/alarms/active", a.GetActiveAlarms, "GET")
+       app.Resource.InjectRoute("/ric/v1/alarms/history", a.GetAlarmHistory, "GET")
+
+       // Start background timer for re-raising alerts
+       a.postClear = sdlcheck
+       go a.StartAlertTimer()
+
+       app.RunWithParams(a, sdlcheck)
+}
+
+func NewAlarmAdapter(amHost string, alertInterval int) *AlarmAdapter {
+       if alertInterval == 0 {
+               alertInterval = viper.GetInt("controls.promAlertManager.alertInterval")
+       }
+
+       if amHost == "" {
+               amHost = viper.GetString("controls.promAlertManager.address")
+       }
+
+       return &AlarmAdapter{
+               rmrReady:      false,
+               amHost:        amHost,
+               amBaseUrl:     viper.GetString("controls.promAlertManager.baseUrl"),
+               amSchemes:     []string{viper.GetString("controls.promAlertManager.schemes")},
+               alertInterval: alertInterval,
+               activeAlarms:  make([]alarm.Alarm, 0),
+               alarmHistory:  make([]alarm.Alarm, 0),
+       }
+}
+
+// Main function
+func main() {
+       NewAlarmAdapter("", 0).Run(true)
+}