blob: 9bab960b1de804c2752254aa12e2e31182fa93f7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
|
# Health API Calls
## Enabled Alarms
NetData enables alarms on demand, i.e. when the chart they should be linked to starts collecting data. So, although many more alarms are configured, only the useful ones are enabled.
To get the list of all enabled alarms:
`http://your.netdata.ip:19999/api/v1/alarms?all`
## Raised Alarms
This API call will return the alarms currently in WARNING or CRITICAL state.
`http://your.netdata.ip:19999/api/v1/alarms`
## Event Log
The size of the alarm log is configured in `netdata.conf`. There are 2 settings: the rotation of the alarm log file and the in memory size of the alarm log.
```
[health]
health db file = /var/lib/netdata/health/health-log.db
in memory max health log entries = 1000
rotate log every lines = 2000
```
The API call retrieves all entries of the alarm log:
`http://your.netdata.ip:19999/api/v1/alarm_log`
## Alarm Log Incremental Updates
`http://your.netdata.ip:19999/api/v1/alarm_log?after=UNIQUEID`
The above returns all the events in the alarm log that occurred after UNIQUEID (you poll it once without `after=`, remember the last UNIQUEID of the returned set, which you give back to get incrementally the next events).
## Alarm badges
The following will return an SVG badge of the alarm named `NAME`, attached to the chart named `CHART`.
`http://your.netdata.ip:19999/api/v1/badge.svg?alarm=NAME&chart=CHART`
|
