This collector creates an 'Alarms' menu with one line plot showing alarm states over time. Alarm states are mapped to integer values according to the below default mapping. Any alarm status types not in this mapping will be ignored (Note: This mapping can be changed by editing the
status_map in the
alarms.conf file). If you would like to learn more about the different alarm statuses check out the docs here.
Below is an example of the chart produced when running
stress-ng --all 2 for a few minutes. You can see the various warning and critical alarms raised.
Enable the collector and restart Netdata.
sudo ./edit-config python.d.conf
# Set `alarms: no` to `alarms: yes`
sudo systemctl restart netdata
If needed, edit the
python.d/alarms.conf configuration file using
edit-config from the your agent's config
directory, which is usually at
cd /etc/netdata # Replace this path with your Netdata config directory, if different
sudo ./edit-config python.d/alarms.conf
alarms specific part of the
alarms.conf file should look like this:
# what url to pull data from
# define how to map alarm status to numbers for the chart
# set to true to include a chart with calculated alarm values over time
# define the type of chart for plotting status over time e.g. 'line' or 'stacked'
# a "," separated list of words you want to filter alarm names for. For example 'cpu,load' would filter for only
# alarms with "cpu" or "load" in alarm name. Default includes all.
# a "," separated list of words you want to exclude based on alarm name. For example 'cpu,load' would exclude
# all alarms with "cpu" or "load" in alarm name. Default excludes None.
It will default to pulling all alarms at each time step from the Netdata rest api at
To troubleshoot issues with the
alarms module, run the
python.d.plugin with the debug option enabled. The
output will give you the output of the data collection job or error messages on why the collector isn't working.
First, navigate to your plugins directory, usually they are located under
/usr/libexec/netdata/plugins.d/. If that's
not the case on your system, open
netdata.conf and look for the setting
plugins directory. Once you're in the
plugin's directory, switch to the
sudo su -s /bin/bash netdata
Now you can manually run the
alarms module in debug mode:
./python.d.plugin alarms debug trace
Was this page helpful?
Need more help?
- Join our community
- Submit a bug or feature request for the FOSS agent
- Submit a bug or feature request for the Netdata cloud