- FM performance test tool first version for review
[ric-plt/alarm-go.git] / alarm / alarm.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 alarm
22
23 import (
24         "bytes"
25         "encoding/json"
26         "errors"
27         "fmt"
28         "io/ioutil"
29         "log"
30         "net/http"
31         "os"
32         "time"
33         "unsafe"
34 )
35
36 /*
37 #cgo CFLAGS: -I../
38 #cgo LDFLAGS: -lrmr_si
39
40 #include "utils.h"
41 */
42 import "C"
43
44 // InitAlarm is the init routine which returns a new alarm instance.
45 // The MO and APP identities are given as a parameters.
46 // The identities are used when raising/clearing alarms, unless provided by the applications.
47 func InitAlarm(mo, id string) (*RICAlarm, error) {
48         r := &RICAlarm{
49                 moId:       mo,
50                 appId:      id,
51                 managerUrl: ALARM_MANAGER_HTTP_URL,
52         }
53
54         if os.Getenv("ALARM_MANAGER_URL") != "" {
55                 r.managerUrl = os.Getenv("ALARM_MANAGER_URL")
56         }
57
58         if os.Getenv("ALARM_IF_RMR") == "" {
59                 go InitRMR(r, "")
60         } else {
61                 go InitRMR(r, ALARM_MANAGER_RMR_URL)
62         }
63
64         return r, nil
65 }
66
67 // Create a new Alarm instance
68 func (r *RICAlarm) NewAlarm(sp int, severity Severity, ainfo, iinfo string) Alarm {
69         return Alarm{
70                 ManagedObjectId:   r.moId,
71                 ApplicationId:     r.appId,
72                 SpecificProblem:   sp,
73                 PerceivedSeverity: severity,
74                 AdditionalInfo:    ainfo,
75                 IdentifyingInfo:   iinfo,
76         }
77 }
78
79 // Create a new AlarmMessage instance
80 func (r *RICAlarm) NewAlarmMessage(a Alarm, alarmAction AlarmAction) AlarmMessage {
81         alarmTime := time.Now().UnixNano()
82         return AlarmMessage{a, alarmAction, alarmTime}
83 }
84
85 func (r *RICAlarm) SetManagedObjectId(mo string) {
86         r.moId = mo
87 }
88
89 func (r *RICAlarm) SetApplicationId(app string) {
90         r.appId = app
91 }
92
93 // Raise a RIC alarm
94 func (r *RICAlarm) Raise(a Alarm) error {
95         r.mutex.Lock()
96         defer r.mutex.Unlock()
97
98         m := r.NewAlarmMessage(a, AlarmActionRaise)
99         return r.sendAlarmUpdateReq(m)
100 }
101
102 // Clear a RIC alarm
103 func (r *RICAlarm) Clear(a Alarm) error {
104         r.mutex.Lock()
105         defer r.mutex.Unlock()
106
107         m := r.NewAlarmMessage(a, AlarmActionClear)
108         return r.sendAlarmUpdateReq(m)
109 }
110
111 // Re-raise a RIC alarm
112 func (r *RICAlarm) Reraise(a Alarm) error {
113         r.mutex.Lock()
114         defer r.mutex.Unlock()
115
116         m := r.NewAlarmMessage(a, AlarmActionClear)
117         if err := r.sendAlarmUpdateReq(m); err != nil {
118                 return errors.New(fmt.Sprintf("Reraise failed: %v", err))
119         }
120
121         return r.sendAlarmUpdateReq(r.NewAlarmMessage(a, AlarmActionRaise))
122 }
123
124 // Clear all alarms raised by the application
125 func (r *RICAlarm) ClearAll() error {
126         r.mutex.Lock()
127         defer r.mutex.Unlock()
128
129         a := r.NewAlarm(0, SeverityDefault, "", "")
130         m := r.NewAlarmMessage(a, AlarmActionClearAll)
131
132         return r.sendAlarmUpdateReq(m)
133 }
134
135 func (r *RICAlarm) AlarmString(a AlarmMessage) string {
136         s := "MOId=%s AppId=%s SP=%d severity=%s IA=%s"
137         return fmt.Sprintf(s, a.ManagedObjectId, a.ApplicationId, a.SpecificProblem, a.PerceivedSeverity, a.IdentifyingInfo)
138 }
139
140 func (r *RICAlarm) sendAlarmUpdateReq(a AlarmMessage) error {
141
142         payload, err := json.Marshal(a)
143         if err != nil {
144                 log.Println("json.Marshal failed with error: ", err)
145                 return err
146         }
147         log.Println("Sending alarm: ", fmt.Sprintf("%s", payload))
148
149         if r.rmrCtx == nil || !r.rmrReady {
150                 url := fmt.Sprintf("%s/%s", r.managerUrl, "ric/v1/alarms")
151                 resp, err := http.Post(url, "application/json", bytes.NewReader(payload))
152                 if err != nil || resp == nil {
153                         return fmt.Errorf("Unable to send alarm: %v", err)
154                 }
155                 log.Printf("Alarm posted to %s [status=%d]", url, resp.StatusCode)
156                 return nil
157         }
158
159         datap := C.CBytes(payload)
160         defer C.free(datap)
161         meid := C.CString("ric")
162         defer C.free(unsafe.Pointer(meid))
163
164         if state := C.rmrSend(r.rmrCtx, RIC_ALARM_UPDATE, datap, C.int(len(payload)), meid); state != C.RMR_OK {
165                 log.Println("rmrSend failed with error: ", state)
166                 return errors.New(fmt.Sprintf("rmrSend failed with error: %d", state))
167         }
168
169         return nil
170 }
171
172 func (r *RICAlarm) ReceiveMessage(cb func(AlarmMessage)) error {
173         if rbuf := C.rmrRcv(r.rmrCtx); rbuf != nil {
174                 payload := C.GoBytes(unsafe.Pointer(rbuf.payload), C.int(rbuf.len))
175                 a := AlarmMessage{}
176                 if err := json.Unmarshal(payload, &a); err == nil {
177                         cb(a)
178                 }
179         }
180         return errors.New("rmrRcv failed!")
181 }
182
183 func InitRMR(r *RICAlarm,  endpoint string) error {
184         // Setup static RT for alarm system
185         if endpoint == "" {
186                 if r.moId == "my-pod" {
187                         endpoint = "127.0.0.1:4560"
188                 } else if r.moId == "my-pod-lib" {
189                         endpoint = "127.0.0.1:4588"
190                 }
191         }
192
193         alarmRT := fmt.Sprintf("newrt|start\nrte|13111|%s\nnewrt|end\n", endpoint)
194         alarmRTFile := "/tmp/alarm.rt"
195
196         if err := ioutil.WriteFile(alarmRTFile, []byte(alarmRT), 0644); err != nil {
197                 log.Println("ioutil.WriteFile failed with error: ", err)
198                 return err
199         }
200
201         os.Setenv("RMR_SEED_RT", alarmRTFile)
202         os.Setenv("RMR_RTG_SVC", "-1")
203
204         if ctx := C.rmrInit(); ctx != nil {
205                 r.rmrCtx = ctx
206                 r.rmrReady = true
207                 return nil
208         }
209
210         return errors.New("rmrInit failed!")
211 }
212
213 func (r *RICAlarm) IsRMRReady() bool {
214         return r.rmrReady
215 }