aerospike_nagios.py simplifies nagios configurations for Aerospike clusters.
The goal is to reduce the complexity to 2 simple steps.
- Copy
aerospike_nagios.pyand dependencies to your Nagios server - Add aerospike configs into Nagios
For monitoring and alerting you should consider using the Prometheus and Grafana based Aerospike Monitoring Stack. This is the monitoring solution being developed by Aerospike.
This repository has been turned over to the community. If you wish to contribute code, go ahead and clone this repo, modify the code, and create a pull request.
Active contributors can then ask to become maintainers for the repo. The wiki can similarly be modified by any code contributor who has been granted pull permissions.
Fully compatible with Aerospike Server 4.0 - 5.1.0.7
- Can monitor any stat returned by
$ asinfo -v 'statistics' [-h host]$ asinfo -v 'namespace/<NAMESPACE NAME>' [-h host]$ asinfo -v 'sets/<NAMESPACE NAME>/<SET NAME>' [-h host]$ asinfo -v 'bins/<NAMESPACE NAME>' [-h host]$ asinfo -v 'sindex/<NAMESPACE NAME>/<SINDEX NAME>' [-h host]$ asinfo -v 'get-stats:context=xdr;dc=<DATACENTER>' [-h host]or$ asinfo -v 'dc/<DATACENTER>' [-h host]$ asinfo -v 'latency:hist=<LATCENCY STAT>' [-h host]or$ asinfo -v 'latencies:hist=<LATCENCY STAT>' [-h host]
Additional python modules are required and installed using pip:
sudo pip install -r requirements.txt
See requirements.txt.
-
Copy aerospike_nagios.py to your prefered scripts dir
eg: /opt/aerospike/bin/
-
Copy aerospike_schema.yaml and ssl directory to the same directory
-
Copy examples/aerospike.cfg into your nagios conf.d directory
/etc/nagios/conf.d if installed from repo
/usr/local/nagios/etc/objects if installed from source
Note: If you are using nrpe to monitor a remote client use the contents
of nrpe/ instead. Information for configuring nrpe can be found in the nrpe
documentation.
- Edit examples/aerospike.cfg
- Add your aerospike hosts into the hostgroup
- Change examples to reflect your current aerospike configuration
-
Edit nagios.cfg by adding a cfg_file directive that points to the location of aerospike.cfg.
cfg_file=/etc/nagios/conf.d if installed from repo
cfg_file=/usr/local/nagios/etc/objects if installed from source Note: Not required if cfg_dir directive is being used. -
Restart/reload nagios
See aerospike_nagios.py, this is the file that nagios will schedule to perform queries against Aerospike. Other than copying it to the appropriate location, you are not required to interact with it.
$ python /opt/aerospike/bin/aerospike_nagios.py --help
usage: aerospike_nagios.py [-u] [-U USER] [-P [PASSWORD]]
[--credentials-file CREDENTIALS]
[--auth-mode AUTH_MODE] [-v]
[-n NAMESPACE | -l LATENCY | -x DC]
[-t SET | -b | -i SINDEX] -s STAT [-p PORT]
[-h HOST] -c CRIT -w WARN [--timeout TIMEOUT]
[--tls-enable] [--tls-name TLS_NAME]
[--tls-keyfile TLS_KEYFILE]
[--tls-keyfile-pw TLS_KEYFILE_PW]
[--tls-certfile TLS_CERTFILE]
[--tls-cafile TLS_CAFILE] [--tls-capath TLS_CAPATH]
[--tls-ciphers TLS_CIPHERS]
[--tls-protocols TLS_PROTOCOLS]
[--tls-cert-blacklist TLS_CERT_BLACKLIST]
[--tls-crl-check] [--tls-crl-check-all]
optional arguments:
-u, --usage, --help Show this help message and exit
-U USER, --user USER user name
-P [PASSWORD], --password [PASSWORD]
password
--credentials-file CREDENTIALS
Path to the credentials file. Use this in place of
--user and --password.
--auth-mode AUTH_MODE
Authentication mode. Values: ['EXTERNAL',
'EXTERNAL_INSECURE', 'INTERNAL'] (default: INTERNAL)
-v, --verbose Enable verbose logging
-n NAMESPACE, --namespace NAMESPACE
Namespace name. eg: bar
-l LATENCY, --latency LATENCY
Histogram name e.g. {test}-write Options: see output
of "asinfo -v 'latency:hist' -l" or "asinfo -v
'latencies:hist -l "
-x DC, --xdr DC Datacenter name. eg: myDC1.
-t SET, --set SET Set name. eg: testSet. Statistic for a particular set
in a particular namespace.
-b, --bin Bin usage information for a particular namspace.
-i SINDEX, --sindex SINDEX
Secondary Index name. eg: age. Statistic for a
particular secondary index in a particular namespace.
-s STAT, --stat STAT Statistic name or in the case of --latency, as bucket.
eg: cluster_size or 1ms
-p PORT, ---port PORT
PORT for Aerospike server (default: 3000)
-h HOST, --host HOST HOST for Aerospike server (default: 127.0.0.1)
-c CRIT, --critical CRIT
Critical level
-w WARN, --warning WARN
Warning level
--timeout TIMEOUT Set timeout value in seconds to node level operations.
TLS connection does not support timeout. (default: 5)
--tls-enable Enable TLS
--tls-name TLS_NAME The expected name on the server side certificate
--tls-keyfile TLS_KEYFILE
The private keyfile for your client TLS Cert
--tls-keyfile-pw TLS_KEYFILE_PW
Password to load protected tls-keyfile
--tls-certfile TLS_CERTFILE
The client TLS cert
--tls-cafile TLS_CAFILE
The CA for the server's certificate
--tls-capath TLS_CAPATH
The path to a directory containing CA certs and/or
CRLs
--tls-ciphers TLS_CIPHERS
Ciphers to include. See https://www.openssl.org/docs/m
an1.1.0/man1/ciphers.html for cipher list format
--tls-protocols TLS_PROTOCOLS
The TLS protocol to use. Available choices: TLSv1,
TLSv1.1, TLSv1.2, all. An optional + or - can be
appended before the protocol to indicate specific
inclusion or exclusion.
--tls-cert-blacklist TLS_CERT_BLACKLIST
Blacklist including serial number of certs to revoke
--tls-crl-check Checks SSL/TLS certs against vendor's Certificate
Revocation Lists for revoked certificates. CRLs are
found in path specified by --tls-capath. Checks the
leaf certificates only
--tls-crl-check-all Check on all entries within the CRL chain -U user (Enterprise only)
-P password (Enterprise only)
To monitor a specific general statistic:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -w WARN_LEVEL -c CRIT_LEVEL
To monitor a specific metric in a namepsace:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -n YOUR_NAMESPACE -w WARN_LEVEL -c CRIT_LEVEL
To monitor a specific metric in a set:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -n YOUR_NAMESPACE -t YOUR_SET -w WARN_LEVEL -c CRIT_LEVEL
To monitor a specific metric in bins:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -n YOUR_NAMESPACE -b -w WARN_LEVEL -c CRIT_LEVEL
To monitor a specific metric in a sindex:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -n YOUR_NAMESPACE -i YOUR_SINDEX -w WARN_LEVEL -c CRIT_LEVEL
To monitor a specific metric in xdr:
aerospike_nagios.py -h YOUR_ASD_HOST -s STAT_NAME -x DATACENTER -w WARN_LEVEL -c CRIT_LEVEL
To monitor latency statistics (ASD <= 3.9):
aerospike_nagios.py -h YOUR_ASD_HOST -s BUCKET -l HISTOGRAM -w WARN_LEVEL -c CRIT_LEVEL
For possible values of HISTOGRAM run "asinfo -v 'latency:hist' -l" BUCKETS = <1ms|8ms|64ms>
To monitor latency statistics (ASD > 3.9):
aerospike_nagios.py -h YOUR_ASD_HOST -s BUCKET -l {NAMESPACE}-HISTOGRAM -w WARN_LEVEL -c CRIT_LEVEL
For possible values of HISTOGRAM run "asinfo -v 'latency:hist' -l" or "asinfo -v 'latencies:hist' -l"
eg: aerospike_nagios.py -h localhost -s 1ms -l {test}-read -w 8 -c 10
BUCKETS = <1ms|8ms|64ms> for (3.9 < ASD < 5.1)
BUCKETS = <2**i from i = 0 to i = 17> for (ASD >= 5.1)
Note: For ASD 5.1+ bucket units can also be in microseconds if the histogram
is configured correctly. For example 65536us could be a valid BUCKET.
To utilize SSL/TLS standard auth:
aerospike_nagios.py -h YOUR_ASD_HOST -p YOUR_SECURED_PORT -s STAT_NAME --tls-enable --tls-cafile YOUR_CA_PEM --tls-name YOUR_ASD_CERT_NAME -w WARN_LEVEL -c CRIT_LEVEL
Warning and Critical thresholds are specified according to Nagios' format
To not use warning and/or critical levels, set them to 0.
Example usage can be found in the examples/aerospike.cfg file.
You can specify User and Password for authentication via the -U/--user and -P/--password parameters. The Password is also an interactive prompt if you leave it empty.
If this is not preferable, you can also specify a credentials file with -c/--credentials-file. It is a simple 2 line file, with the username and password on each line, in that order. With this method, the credentials file can be secured via other means (eg: chmod 600) and prevent snooping.
AuthMode is optional parameter to specify authentication mode. It's default value is INTERNAL.
The previous implementation of the nagios plugin has been moved to the
legacy branch.