)
type AlarmDefinition struct {
- AlarmId int
- AlarmText string
- EventType string
- OperationInstructions string
+ AlarmId int `json:"alarmid"`
+ AlarmText string `json:"alarmtext"`
+ EventType string `json:"eventtype"`
+ OperationInstructions string `json:"operationinstructions"`
}
-var RICAlarmDefinitions = map[int]AlarmDefinition{
- RIC_RT_DISTRIBUTION_FAILED: {
- AlarmId: RIC_RT_DISTRIBUTION_FAILED,
- AlarmText: "RIC ROUTING TABLE DISTRIBUTION FAILED",
- EventType: "Processing error",
- OperationInstructions: "Not defined",
- },
- TCP_CONNECTIVITY_LOST_TO_DBAAS: {
- AlarmId: TCP_CONNECTIVITY_LOST_TO_DBAAS,
- AlarmText: "TCP CONNECTIVITY LOST TO DBAAS",
- EventType: "Communication error",
- OperationInstructions: "Not defined",
- },
- E2_CONNECTIVITY_LOST_TO_GNODEB: {
- AlarmId: E2_CONNECTIVITY_LOST_TO_GNODEB,
- AlarmText: "E2 CONNECTIVITY LOST TO G-NODEB",
- EventType: "Communication error",
- OperationInstructions: "Not defined",
- },
- E2_CONNECTIVITY_LOST_TO_ENODEB: {
- AlarmId: E2_CONNECTIVITY_LOST_TO_ENODEB,
- AlarmText: "E2 CONNECTIVITY LOST TO E-NODEB",
- EventType: "Communication error",
- OperationInstructions: "Not defined",
- },
- ACTIVE_ALARM_EXCEED_MAX_THRESHOLD: {
- AlarmId: ACTIVE_ALARM_EXCEED_MAX_THRESHOLD,
- AlarmText: "ACTIVE ALARM EXCEED MAX THRESHOLD",
- EventType: "Warning",
- OperationInstructions: "Not defined",
- },
- ALARM_HISTORY_EXCEED_MAX_THRESHOLD: {
- AlarmId: ALARM_HISTORY_EXCEED_MAX_THRESHOLD,
- AlarmText: "ALARM HISTORY EXCEED MAX THRESHOLD",
- EventType: "Warning",
- OperationInstructions: "Not defined",
- },
-}
+var RICAlarmDefinitions map[int]*AlarmDefinition
const (
ALARM_MANAGER_HTTP_URL string = "http://service-ricplt-alarmmanager-http.ricplt:8080"
"gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
)
+type CliAlarmDefinitions struct {
+ AlarmDefinitions []*alarm.AlarmDefinition `json:"alarmdefinitions"`
+}
+
func main() {
// configure commando
SetAction(func(args map[string]commando.ArgValue, flags map[string]commando.FlagValue) {
postAlarmConfig(flags)
})
+ // Create alarm defenition
+ commando.
+ Register("define").
+ SetShortDescription("Define alarm with given parameters").
+ AddFlag("aid", "alarm identifier", commando.Int, nil).
+ AddFlag("atx", "alarm text", commando.String, nil).
+ AddFlag("ety", "event type", commando.String, nil).
+ AddFlag("oin", "operation instructions", commando.String, nil).
+ AddFlag("host", "Alarm manager host address", commando.String, "localhost").
+ AddFlag("port", "Alarm manager host address", commando.String, "8080").
+ SetAction(func(args map[string]commando.ArgValue, flags map[string]commando.FlagValue) {
+ postAlarmDefinition(flags)
+ })
// parse command-line arguments
commando.Parse(nil)
return
}
}
+
+func postAlarmDefinition(flags map[string]commando.FlagValue) {
+ host, _ := flags["host"].GetString()
+ port, _ := flags["port"].GetString()
+ alarmid, _ := flags["aid"].GetInt()
+ alarmtxt, _ := flags["atx"].GetString()
+ etype, _ := flags["ety"].GetString()
+ operation, _ := flags["oin"].GetString()
+ targetUrl := fmt.Sprintf("http://%s:%s/ric/v1/alarms/define", host, port)
+
+ var alarmdefinition alarm.AlarmDefinition
+ alarmdefinition.AlarmId = alarmid
+ alarmdefinition.AlarmText = alarmtxt
+ alarmdefinition.EventType = etype
+ alarmdefinition.OperationInstructions = operation
+
+ m := CliAlarmDefinitions{AlarmDefinitions: []*alarm.AlarmDefinition{&alarmdefinition}}
+ jsonData, err := json.Marshal(m)
+ if err != nil {
+ fmt.Println("json.Marshal failed: %v", err)
+ return
+ }
+
+ resp, err := http.Post(targetUrl, "application/json", bytes.NewBuffer(jsonData))
+ if err != nil || resp == nil {
+ fmt.Println("Couldn't fetch post alarm configuration due to error: %v", err)
+ return
+ }
+}
github.com/gorilla/mux v1.7.1
github.com/jedib0t/go-pretty v4.3.0+incompatible // indirect
github.com/mattn/go-runewidth v0.0.9 // indirect
+ github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+ github.com/modern-go/reflect2 v1.0.1 // indirect
github.com/prometheus/alertmanager v0.20.0
github.com/spf13/viper v1.6.2
github.com/stretchr/testify v1.5.1
app.Resource.InjectStatusCb(a.StatusCB)
app.AddConfigChangeListener(a.ConfigChangeCB)
+ alarm.RICAlarmDefinitions = make(map[int]*alarm.AlarmDefinition)
+
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")
app.Resource.InjectRoute("/ric/v1/alarms/config", a.SetAlarmConfig, "POST")
app.Resource.InjectRoute("/ric/v1/alarms/config", a.GetAlarmConfig, "GET")
+ app.Resource.InjectRoute("/ric/v1/alarms/define", a.SetAlarmDefinition, "POST")
+ app.Resource.InjectRoute("/ric/v1/alarms/define/{alarmId}", a.DeleteAlarmDefinition, "DELETE")
+ app.Resource.InjectRoute("/ric/v1/alarms/define", a.GetAlarmDefinition, "GET")
// Start background timer for re-raising alerts
a.postClear = sdlcheck
"testing"
"time"
"github.com/gorilla/mux"
+ "strconv"
+ "bytes"
"gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
"gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
"github.com/prometheus/alertmanager/api/v2/models"
os.Exit(M.Run())
}
+func TestSetAlarmDefinitions(t *testing.T) {
+ xapp.Logger.Info("TestSetAlarmDefinitions")
+ var alarm8004Definition alarm.AlarmDefinition
+ alarm8004Definition.AlarmId = alarm.RIC_RT_DISTRIBUTION_FAILED
+ alarm8004Definition.AlarmText = "RIC ROUTING TABLE DISTRIBUTION FAILED"
+ alarm8004Definition.EventType = "Processing error"
+ alarm8004Definition.OperationInstructions = "Not defined"
+
+ var alarm8005Definition alarm.AlarmDefinition
+ alarm8005Definition.AlarmId = alarm.TCP_CONNECTIVITY_LOST_TO_DBAAS
+ alarm8005Definition.AlarmText = "TCP CONNECTIVITY LOST TO DBAAS"
+ alarm8005Definition.EventType = "Communication error"
+ alarm8005Definition.OperationInstructions = "Not defined"
+
+ var alarm8006Definition alarm.AlarmDefinition
+ alarm8006Definition.AlarmId = alarm.E2_CONNECTIVITY_LOST_TO_GNODEB
+ alarm8006Definition.AlarmText = "E2 CONNECTIVITY LOST TO G-NODEB"
+ alarm8006Definition.EventType = "Communication error"
+ alarm8006Definition.OperationInstructions = "Not defined"
+
+ var alarm8007Definition alarm.AlarmDefinition
+ alarm8007Definition.AlarmId = alarm.E2_CONNECTIVITY_LOST_TO_ENODEB
+ alarm8007Definition.AlarmText = "E2 CONNECTIVITY LOST TO E-NODEB"
+ alarm8007Definition.EventType = "Communication error"
+ alarm8007Definition.OperationInstructions = "Not defined"
+
+ var alarm8008Definition alarm.AlarmDefinition
+ alarm8008Definition.AlarmId = alarm.ACTIVE_ALARM_EXCEED_MAX_THRESHOLD
+ alarm8008Definition.AlarmText = "ACTIVE ALARM EXCEED MAX THRESHOLD"
+ alarm8008Definition.EventType = "storage warning"
+ alarm8008Definition.OperationInstructions = "clear alarms or raise threshold"
+
+ var alarm8009Definition alarm.AlarmDefinition
+ alarm8009Definition.AlarmId = alarm.ALARM_HISTORY_EXCEED_MAX_THRESHOLD
+ alarm8009Definition.AlarmText = "ALARM HISTORY EXCEED MAX THRESHOLD"
+ alarm8009Definition.EventType = "storage warning"
+ alarm8009Definition.OperationInstructions = "clear alarms or raise threshold"
+
+ pbodyParams := RicAlarmDefinitions{AlarmDefinitions: []*alarm.AlarmDefinition{&alarm8004Definition, &alarm8005Definition, &alarm8006Definition, &alarm8007Definition, &alarm8008Definition, &alarm8009Definition}}
+ pbodyEn, _ := json.Marshal(pbodyParams)
+ req, _ := http.NewRequest("POST", "/ric/v1/alarms/define", bytes.NewBuffer(pbodyEn))
+ handleFunc := http.HandlerFunc(alarmManager.SetAlarmDefinition)
+ response := executeRequest(req, handleFunc)
+ status := checkResponseCode(t, http.StatusOK, response.Code)
+ xapp.Logger.Info("status = %v", status)
+
+}
+
+func TestGetAlarmDefinitions(t *testing.T) {
+ xapp.Logger.Info("TestGetAlarmDefinitions")
+ var alarmDefinition alarm.AlarmDefinition
+ req, _ := http.NewRequest("GET", "/ric/v1/alarms/define", nil)
+ vars := map[string]string{"alarmId": strconv.FormatUint(8004, 10)}
+ req = mux.SetURLVars(req, vars)
+ handleFunc := http.HandlerFunc(alarmManager.GetAlarmDefinition)
+ response := executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusOK, response.Code)
+ json.NewDecoder(response.Body).Decode(&alarmDefinition)
+ xapp.Logger.Info("alarm definition = %v", alarmDefinition)
+ if alarmDefinition.AlarmId != alarm.RIC_RT_DISTRIBUTION_FAILED || alarmDefinition.AlarmText != "RIC ROUTING TABLE DISTRIBUTION FAILED" {
+ t.Errorf("Incorrect alarm definition")
+ }
+}
+
+func TestDeleteAlarmDefinitions(t *testing.T) {
+ xapp.Logger.Info("TestDeleteAlarmDefinitions")
+ //Get all
+ var ricAlarmDefinitions RicAlarmDefinitions
+ req, _ := http.NewRequest("GET", "/ric/v1/alarms/define", nil)
+ req = mux.SetURLVars(req, nil)
+ handleFunc := http.HandlerFunc(alarmManager.GetAlarmDefinition)
+ response := executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusOK, response.Code)
+ json.NewDecoder(response.Body).Decode(&ricAlarmDefinitions)
+ for _, alarmDefinition := range ricAlarmDefinitions.AlarmDefinitions {
+ xapp.Logger.Info("alarm definition = %v", *alarmDefinition)
+ }
+
+ //Delete 8004
+ req, _ = http.NewRequest("DELETE", "/ric/v1/alarms/define", nil)
+ vars := map[string]string{"alarmId": strconv.FormatUint(8004, 10)}
+ req = mux.SetURLVars(req, vars)
+ handleFunc = http.HandlerFunc(alarmManager.DeleteAlarmDefinition)
+ response = executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusOK, response.Code)
+
+ //Get 8004 fail
+ req, _ = http.NewRequest("GET", "/ric/v1/alarms/define", nil)
+ vars = map[string]string{"alarmId": strconv.FormatUint(8004, 10)}
+ req = mux.SetURLVars(req, vars)
+ handleFunc = http.HandlerFunc(alarmManager.GetAlarmDefinition)
+ response = executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusBadRequest, response.Code)
+
+ //Set 8004 success
+ var alarm8004Definition alarm.AlarmDefinition
+ alarm8004Definition.AlarmId = alarm.RIC_RT_DISTRIBUTION_FAILED
+ alarm8004Definition.AlarmText = "RIC ROUTING TABLE DISTRIBUTION FAILED"
+ alarm8004Definition.EventType = "Processing error"
+ alarm8004Definition.OperationInstructions = "Not defined"
+ pbodyParams := RicAlarmDefinitions{AlarmDefinitions: []*alarm.AlarmDefinition{&alarm8004Definition}}
+ pbodyEn, _ := json.Marshal(pbodyParams)
+ req, _ = http.NewRequest("POST", "/ric/v1/alarms/define", bytes.NewBuffer(pbodyEn))
+ handleFunc = http.HandlerFunc(alarmManager.SetAlarmDefinition)
+ response = executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusOK, response.Code)
+
+ //Get 8004 success
+ req, _ = http.NewRequest("GET", "/ric/v1/alarms/define", nil)
+ vars = map[string]string{"alarmId": strconv.FormatUint(8004, 10)}
+ req = mux.SetURLVars(req, vars)
+ handleFunc = http.HandlerFunc(alarmManager.GetAlarmDefinition)
+ response = executeRequest(req, handleFunc)
+ checkResponseCode(t, http.StatusOK, response.Code)
+}
+
func TestNewAlarmStoredAndPostedSucess(t *testing.T) {
+ xapp.Logger.Info("TestNewAlarmStoredAndPostedSucess")
ts := CreatePromAlertSimulator(t, "POST", "/api/v2/alerts", http.StatusOK, models.LabelSet{})
defer ts.Close()
}
func TestAlarmClearedSucess(t *testing.T) {
+ xapp.Logger.Info("TestAlarmClearedSucess")
ts := CreatePromAlertSimulator(t, "POST", "/api/v2/alerts", http.StatusOK, models.LabelSet{})
defer ts.Close()
}
func TestMultipleAlarmsRaisedSucess(t *testing.T) {
+ xapp.Logger.Info("TestMultipleAlarmsRaisedSucess")
ts := CreatePromAlertSimulator(t, "POST", "/api/v2/alerts", http.StatusOK, models.LabelSet{})
defer ts.Close()
}
func TestMultipleAlarmsClearedSucess(t *testing.T) {
+ xapp.Logger.Info("TestMultipleAlarmsClearedSucess")
ts := CreatePromAlertSimulator(t, "POST", "/api/v2/alerts", http.StatusOK, models.LabelSet{})
defer ts.Close()
}
func TestAlarmsSuppresedSucess(t *testing.T) {
+ xapp.Logger.Info("TestAlarmsSuppresedSucess")
ts := CreatePromAlertSimulator(t, "POST", "/api/v2/alerts", http.StatusOK, models.LabelSet{})
defer ts.Close()
func TestInvalidAlarms(t *testing.T) {
+ xapp.Logger.Info("TestInvalidAlarms")
a := alarmer.NewAlarm(1111, alarm.SeverityMajor, "Some App data", "eth 0 1")
assert.Nil(t, alarmer.Raise(a), "raise failed")
time.Sleep(time.Duration(2) * time.Second)
}
func TestAlarmHandlingErrorCases(t *testing.T) {
+ xapp.Logger.Info("TestAlarmHandlingErrorCases")
ok, err := alarmManager.HandleAlarms(&xapp.RMRParams{})
assert.Equal(t, err.Error(), "unexpected end of JSON input")
assert.Nil(t, ok, "raise failed")
}
func TestConsumeUnknownMessage(t *testing.T) {
+ xapp.Logger.Info("TestConsumeUnknownMessage")
err := alarmManager.Consume(&xapp.RMRParams{})
assert.Nil(t, err, "raise failed")
}
func TestStatusCallback(t *testing.T) {
+ xapp.Logger.Info("TestStatusCallback")
assert.Equal(t, true, alarmManager.StatusCB())
}
}
return true
}
-
import (
"encoding/json"
- "net/http"
- "time"
-
"gerrit.o-ran-sc.org/r/ric-plt/alarm-go/alarm"
app "gerrit.o-ran-sc.org/r/ric-plt/xapp-frame/pkg/xapp"
+ "github.com/gorilla/mux"
+ "net/http"
+ "strconv"
+ "time"
)
+func (a *AlarmManager) respondWithError(w http.ResponseWriter, code int, message string) {
+ a.respondWithJSON(w, code, map[string]string{"error": message})
+}
+
func (a *AlarmManager) respondWithJSON(w http.ResponseWriter, code int, payload interface{}) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(code)
}
}
+func (a *AlarmManager) SetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
+
+ app.Logger.Debug("POST arrived for creating alarm definition ")
+ /* If body is nil then return error */
+ if r.Body == nil {
+ app.Logger.Error("POST - body is empty")
+ a.respondWithError(w, http.StatusBadRequest, "No data in request body.")
+ return
+ }
+ defer r.Body.Close()
+
+ /* Parameters are available. Check if they are valid */
+ var alarmDefinitions RicAlarmDefinitions
+ err := json.NewDecoder(r.Body).Decode(&alarmDefinitions)
+ if err != nil {
+ app.Logger.Error("POST - received alarm definition parameters are invalid - " + err.Error())
+ a.respondWithError(w, http.StatusBadRequest, "Invalid data in request body.")
+ return
+ }
+
+ for _, alarmDefinition := range alarmDefinitions.AlarmDefinitions {
+ _, exists := alarm.RICAlarmDefinitions[alarmDefinition.AlarmId]
+ if exists {
+ app.Logger.Error("POST - alarm definition already exists for %v", alarmDefinition.AlarmId)
+ } else {
+ ricAlarmDefintion := new(alarm.AlarmDefinition)
+ ricAlarmDefintion.AlarmId = alarmDefinition.AlarmId
+ ricAlarmDefintion.AlarmText = alarmDefinition.AlarmText
+ ricAlarmDefintion.EventType = alarmDefinition.EventType
+ ricAlarmDefintion.OperationInstructions = alarmDefinition.OperationInstructions
+ alarm.RICAlarmDefinitions[alarmDefinition.AlarmId] = ricAlarmDefintion
+ }
+ }
+
+ a.respondWithJSON(w, http.StatusOK, nil)
+ return
+}
+
+func (a *AlarmManager) DeleteAlarmDefinition(w http.ResponseWriter, r *http.Request) {
+ pathParams := mux.Vars(r)
+ alarmId, alarmIdok := pathParams["alarmId"]
+ if alarmIdok {
+ if ialarmId, err := strconv.Atoi(alarmId); err == nil {
+ delete(alarm.RICAlarmDefinitions, ialarmId)
+ } else {
+ app.Logger.Error("DELETE - alarmId string to int conversion failed %v", alarmId)
+ a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
+ return
+ }
+ } else {
+ app.Logger.Error("DELETE - alarmId does not exist %v", alarmId)
+ a.respondWithError(w, http.StatusBadRequest, "Invalid path parameter")
+ return
+
+ }
+}
+
+func (a *AlarmManager) GetAlarmDefinition(w http.ResponseWriter, r *http.Request) {
+ var ricAlarmDefinitions RicAlarmDefinitions
+ pathParams := mux.Vars(r)
+ alarmId, alarmIdok := pathParams["alarmId"]
+ if alarmIdok {
+ if ialarmId, err := strconv.Atoi(alarmId); err == nil {
+ alarmDefinition, ok := alarm.RICAlarmDefinitions[ialarmId]
+ if ok {
+ app.Logger.Debug("Successfully returned alarm defintion for alarm id %v", ialarmId)
+ a.respondWithJSON(w, http.StatusOK, alarmDefinition)
+ return
+
+ } else {
+ app.Logger.Error("Requested alarm id not found %v", ialarmId)
+ a.respondWithError(w, http.StatusBadRequest, "Non existent alarmId")
+ return
+ }
+ } else {
+ app.Logger.Error("alarmId string to int conversion failed %v", alarmId)
+ a.respondWithError(w, http.StatusBadRequest, "Invalid alarmId")
+ return
+ }
+ } else {
+ app.Logger.Debug("GET arrived for all alarm definitions ")
+ for _, alarmDefinition := range alarm.RICAlarmDefinitions {
+ ricAlarmDefinitions.AlarmDefinitions = append(ricAlarmDefinitions.AlarmDefinitions, alarmDefinition)
+ }
+ app.Logger.Debug("Successfully returned all alarm definitions")
+ a.respondWithJSON(w, http.StatusOK, ricAlarmDefinitions)
+ }
+}
+
func (a *AlarmManager) doAction(w http.ResponseWriter, r *http.Request, isRaiseAlarm bool) error {
app.Logger.Info("doAction: request received = %t", isRaiseAlarm)
var Version string
var Hash string
+type RicAlarmDefinitions struct {
+ AlarmDefinitions []*alarm.AlarmDefinition `json:"alarmdefinitions"`
+}
Code Review / ric-plt / alarm-go.git / commitdiff