...
Новая тревога создается при помощи запроса /api/alarm/create
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
- type – тип тревоги:
- 0 – значение опустилось ниже заданного порога
- 1 – значение превысило заданный порог
- 2 - значение равно заданной величине
- 4 - значение, монотонно возрастающее, опустилось
- 5 - значение, монотонно снижающееся, возросло
- name – имя тревоги
- value – пороговое значение
- metric – идентификатор метрики (в данном примере битрейт видео)
- node – идентификатор узла
- time – время в миллисекундах, в течение которого значение метрики должно находиться выше или ниже заданного порогаусловие срабатывания тревоги выполняется.
В данном примере создана тревога, срабатывающая, если битрейт видео опубликованного на сервере потока опустится ниже 100 кбит/с более чем на 1 секунду.
Если идентификатор узла не указан, тревога применяется ко всем узлам на бэкенд-сервере.
На одну метрику может быть назначено несколько тревог, например, ограничивая нижний и верхний пределы битрейта видео.
Изменение тревоги
Параметры тревоги могут быть изменены при помощи запроса /api/alarm/update
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
- id – идентификатор тревоги
- type – тип тревоги:
- 0 – значение опустилось ниже заданного порога
- 1 – значение превысило заданный порог
- 2 - значение равно заданной величине
- 4 - значение, монотонно возрастающее, опустилось
- 5 - значение, монотонно снижающееся, возросло
- name – имя тревоги
- value – пороговое значение
- metric – идентификатор метрики (в данном примере битрейт видео)
- node – идентификатор узла
- time – время в миллисекундах, в течение которого значение метрики должно находиться выше или ниже заданного порога.
...
Тревога может быть удалена при помощи запроса /api/alarm/delete
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
- id – идентификатор тревоги
...
Информацию о настройках тревоги можно получить при помощи запроса /api/alarm/list
API | Request | Response | Response status | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
WS API |
|
| 200 OK 400 Object not found 500 Persist exception | ||||||||||
REST API |
|
| 200 OK 400 Object not found 500 Persist exception |
Здесь:
- id – идентификатор тревоги
...
Состав полей ответа аналогичен составу полей запроса /api/alarm/update.
Получение сообщения о срабатывании тревоги
Сообщения о срабатываниях и возвратах тревог приходят, если клиент подписан на очередь /alarms. Сообщения выглядят следующим образом:
Code Block | ||
---|---|---|
| ||
MESSAGE destination:/alarms content-type:application/json;charset=UTF-8 subscription:sub-0 message-id:4-187 content-length:242 { "timestamp":1561101716609, "status":"RAISED", "alarmType":"LESS", "alarmValue":700000, "alarmName":"alarm1", "mediaId":"617691c0-93f2-11e9-8808-938c74814152", "metricEnumName":"VIDEO_RATE", "metricValue":400232, "nodeHostName":"test.flashphoner.com" } |
Здесь:
- timestamp - время срабатывания или возврата тревоги
- status - состояние тревоги:
- RAISED - срабатывание
- CLEARED - возврат
- alarmType - тип тревоги:
- LESS – значение опустилось ниже заданного порога
- MORE – значение превысило заданный порог
- EQUAL - значение равно заданной величине
- MONOTONIC_UP - значение, монотонно возрастающее, опустилось
- MONOTONIC_DOWN - значение, монотонно снижающееся, возросло
- alarmValue - пороговое значение
- alarmName - имя тревоги
- mediaId - идентификатор медиасессии потока, для которого зафиксировано событие
- metricEnumName - наименование метрики
- metricValue - значение метрики, по которому сработала или вернулась тревога
- nodeHostName - имя узла, на котором находится наблюдаемый поток