Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alerta/nagios-alerta

Forward nagios alerts to the alerta monitoring system
https://github.com/alerta/nagios-alerta

alerta event-broker naemon nagios nagios3 nagios4

Last synced: about 1 month ago
JSON representation

Forward nagios alerts to the alerta monitoring system

Host: GitHub
URL: https://github.com/alerta/nagios-alerta
Owner: alerta
License: mit
Created: 2013-09-30T11:53:59.000Z (about 11 years ago)
Default Branch: master
Last Pushed: 2021-11-09T21:03:09.000Z (about 3 years ago)
Last Synced: 2024-05-21T04:15:39.150Z (7 months ago)
Topics: alerta, event-broker, naemon, nagios, nagios3, nagios4
Language: C
Homepage: http://alerta.io
Size: 3.53 MB
Stars: 22
Watchers: 9
Forks: 15
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Nagios-to-Alerta Gateway
========================

[![build-test](https://github.com/alerta/nagios-alerta/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/alerta/nagios-alerta/actions/workflows/test.yml)

Consolidate Nagios alerts from across multiple sites into a single
"at-a-glance" console. Nagios 3 and Nagios 4 are now supported.

Transform this ...

![nagios](/docs/images/nagios3-v3.png?raw=true)

Into this ...

![alerta](/docs/images/nagios3-alerta-v3.png?raw=true)

System Requirements
------------

You'll need the following system packages to Install nagios-alerta:

In RedHat/CentOS/Fedora:
```
yum install -y git curl gcc make libcurl-devel jansson-devel
```

In Debian/Ubuntu:
```
apt-get install -y git-core curl gcc make libcurl4-openssl-dev libjansson-dev libglib2.0-dev pkg-config
```

Installation (Nagios 3)
------------

$ git clone https://github.com/alerta/nagios-alerta.git
$ cd nagios-alerta
$ make
$ sudo make install
$ sudo service nagios restart

Installation (Nagios 4)
------------

$ git clone https://github.com/alerta/nagios-alerta.git
$ cd nagios-alerta
$ make nagios4
$ sudo make install
$ sudo service nagios restart

Alerts
------

To forward host and service check results to Alerta,
modify `/etc/nagios/nagios.cfg` as follows:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080
```

To specify the environment name:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080 env=ENV_NAME_HERE
```
To specify the customer name:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080 customer=CUSTOMER_NAME_HERE
```
To provide the API key if authentication is enabled on the alerta server:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080 key=INSERT_API_KEY_HERE
```

To forward check results in Hard state only:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080 hard_only=1
```

And to enable debug mode:
```
broker_module=/usr/lib/nagios/alerta-neb.o http://localhost:8080 debug=1
```

**Note:** The default `environment` is `Production` and the default `service` is `Platform`.

Setting Environment & Service Per-Check
---------------------------------------

Use [custom object variables](https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/customobjectvars.html)
`_Environment` and `_Service` to set environment and service on a
per-check basis:

```
define host{
use generic-host ; Name of host template to use
host_name localhost
alias localhost
address 127.0.0.1
_Environment Development
_Service Network
}
```

```
define service{
use generic-service ; Name of service template to use
host_name localhost
service_description Total Processes
_Environment Production
_Service Web
check_command check_procs!250!400
}
```

Setting Customer Per-Check
--------------------------

Use [custom object variables](https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/customobjectvars.html) to set [customer_views](http://alerta.readthedocs.io/en/latest/customer-views.html)

```
define host{
use generic-host ; Name of host template to use
host_name localhost
alias localhost
address 127.0.0.1
_Customer Customer1
}
```

```
define service{
use generic-service ; Name of service template to use
host_name localhost
service_description Total Processes
_Customer Customer1
check_command check_procs!250!400
}
```

Heartbeats
----------

To configure the Nagios server to send regular heartbeats to Alerta to
ensure that Nagios and the event broker are still forwarding alerts
configure a dummy service check as follows:

1. Define a heartbeat command and add it to `/etc/nagios/commands.cfg`:
```
define command{
command_name check_heartbeat
command_line /usr/lib/nagios/plugins/check_dummy 0
}
```

2. Define a hostgroup for the Nagios servers that have the Alerta event
broker installed and add it to `/etc/nagios3/conf.d/hostgroups_nagios2.cfg`:
```
define hostgroup {
hostgroup_name nagios-servers
alias Nagios servers
members localhost
}
```

3. Define a Heartbeat service check to execute every minute and add it
to `/etc/nagios/conf.d/services_nagios2.cfg`:
```
define service {
hostgroup_name nagios-servers
service_description Heartbeat
check_command check_heartbeat
use generic-service
notification_interval 0 ; set > 0 if you want to be renotified
normal_check_interval 1
}
```

License
-------