Alignak receiver module to handle NSCA passive checks
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
alignak_module_nsca
test
.bintray-deb.json
.bintray-freebsd.json
.bintray-rpm.json
.bintray.json
.gitignore
.pylintrc
.travis.yml
AUTHORS
LICENSE
MANIFEST.in
README.rst
package.sh
requirements.txt
setup.py
version.py

README.rst

Alignak NSCA receiver Module

Alignak NSCA module for the Alignak Receiver

Development code static analysis Development code tests coverage Most recent PyPi version Join the chat #alignak on freenode.net License AGPL v3

Installation

The installation of this module will copy some configuration files in the Alignak default configuration directory (eg. /usr/local/etc/alignak). The copied files are located in the default sub-directory used for the modules (eg. arbiter/modules).

From Alignak packages repositories

More information in the online Alignak documentation. Here is only an abstract...

Debian:

# Alignak DEB stable packages
sudo echo deb https://dl.bintray.com/alignak/alignak-deb-stable xenial main | sudo tee -a /etc/apt/sources.list.d/alignak.list
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv D401AB61

sudo apt-get update
sudo apt install python-alignak-module-nsca

CentOS:

sudo vi /etc/yum.repos.d/alignak-stable.repo:
   [Alignak-rpm-stable]
   name=Alignak RPM stable packages
   baseurl=https://dl.bintray.com/alignak/alignak-rpm-stable
   gpgcheck=0
   repo_gpgcheck=0
   enabled=1

sudo yum repolist
sudo yum install python-alignak-module-nsca

From PyPI

To install the module from PyPI:

sudo pip install alignak-module-nsca

From source files

To install the module from the source files (for developing purpose):

git clone https://github.com/Alignak-monitoring-contrib/alignak-module-nsca
cd alignak-module-nsca
sudo pip install . -e

Note: using `sudo python setup.py install` will not correctly manage the package configuration files! The recommended way is really to use `pip`;)

Short description

This module for Alignak receiver reads and decodes NSCA passive notifications to dispatch them into the Alignak framework.

Features / Known limitations

Handles NSCA version 3 protocol

Check the NSCA packet timestamp for staled data (older than a certain amount of time) or 'future' data (future timestamp).

Consider the host_check service received data as a passive host check. Useful if your NSCA client does not handle correctly the passive host check syntax ;)

The NSCA module implementation is currently limited to the "xor" obfuscation/encryption.

Note

To make the module add some information in the daemon log file, define the ALIGNAK_LOG_ACTIONS environment variable. It will dump a part of the received NSCA packets...

Configuration

Once installed, this module has its own configuration file in the /usr/local/share/alignak/etc/alignak.d directory. The default configuration file is alignak-module-nsca.ini. This file is commented to help configure all the parameters.

The default configuration is convenient for 'recent' NSCA client implementing NSCA version 3.

This configuration has been tested with Linux send_nsca 2.9.1 and Windows NSClient most recent versions (from 0.4.1).

Note

received NSCA packets which are not containing version 3 information are dropped by the module!

To configure Alignak receiver to use this module:

  • edit your receiver daemon configuration file
  • add the module_alias parameter value (nsca) to the modules parameter of the daemon

To set up several NSCA listeners:

  • copy the default configuration to another file,
  • change the module alias parameter (nsca_bis)
  • change the listening port
  • edit your receiver daemon configuration file
  • add the new module_alias parameter value (nsca_bis) to the modules parameter of the daemon

Bugs, issues and contributing

Contributions to this project are welcome and encouraged ... issues in the project repository are the common way to raise an information.