pmp-check-aws-rds.py - Check Amazon RDS metrics.
Usage: pmp-check-aws-rds.py [options]
Options:
-h, --help show this help message and exit
-l, --list list of all DB instances
-n PROFILE, --profile-name=PROFILE
AWS profile from ~/.boto or /etc/boto.cfg. Default:
None, fallbacks to "[Credentials]".
-r REGION, --region=REGION
AWS region. Default: us-east-1. If set to "all", we
try to detect the instance region across all of them,
note this will be slower than you specify the region.
-i IDENT, --ident=IDENT
DB instance identifier
-p, --print print status and other details for a given DB instance
-m METRIC, --metric=METRIC
metric to check: [status, load, storage, memory]
-w WARN, --warn=WARN warning threshold
-c CRIT, --crit=CRIT critical threshold
-u UNIT, --unit=UNIT unit of thresholds for "storage" and "memory" metrics:
[percent, GB]. Default: percent
-t TIME, --time=TIME time period in minutes to query. Default: 5
-a AVG, --avg=AVG time average in minutes to request. Default: 1
-d, --debug enable debug output
This plugin is written on Python and utilizes the module boto (Python interface to Amazon Web Services) to get various RDS metrics from CloudWatch and compare them against the thresholds.
This plugin that is supposed to be run by Nagios, i.e. under nagios user, should have permissions to read the config /etc/boto.cfg or ~nagios/.boto.
Example:
[root@centos6 ~]# cat /etc/boto.cfg
[Credentials]
aws_access_key_id = THISISATESTKEY
aws_secret_access_key = thisisatestawssecretaccesskey
If you do not use this config with other tools such as our Cacti script, you can secure this file the following way:
[root@centos6 ~]# chown nagios /etc/boto.cfg
[root@centos6 ~]# chmod 600 /etc/boto.cfg
The plugin provides 4 checks and some options to list and print RDS details:
To get the list of all RDS instances under AWS account:
# ./pmp-check-aws-rds.py -l
To get the detailed status of RDS instance identified as blackbox:
# ./pmp-check-aws-rds.py -i blackbox -p
Nagios check for the overall status. Useful if you want to set the rest of the checks dependent from this one:
# ./pmp-check-aws-rds.py -i blackbox -m status
OK mysql 5.1.63. Status: available
Nagios check for CPU utilization, specify thresholds as percentage of 1-min., 5-min., 15-min. average accordingly:
# ./pmp-check-aws-rds.py -i blackbox -m load -w 90,85,80 -c 98,95,90
OK Load average: 18.36%, 18.51%, 15.95% | load1=18.36;90.0;98.0;0;100 load5=18.51;85.0;95.0;0;100 load15=15.95;80.0;90.0;0;100
Nagios check for the free memory, specify thresholds as percentage:
# ./pmp-check-aws-rds.py -i blackbox -m memory -w 5 -c 2
OK Free memory: 5.90 GB (9%) of 68 GB | free_memory=8.68;5.0;2.0;0;100
# ./pmp-check-aws-rds.py -i blackbox -m memory -u GB -w 4 -c 2
OK Free memory: 5.90 GB (9%) of 68 GB | free_memory=5.9;4.0;2.0;0;68
Nagios check for the free storage space, specify thresholds as percentage or GB:
# ./pmp-check-aws-rds.py -i blackbox -m storage -w 10 -c 5
OK Free storage: 162.55 GB (33%) of 500.0 GB | free_storage=32.51;10.0;5.0;0;100
# ./pmp-check-aws-rds.py -i blackbox -m storage -u GB -w 10 -c 5
OK Free storage: 162.55 GB (33%) of 500.0 GB | free_storage=162.55;10.0;5.0;0;500.0
By default, the region is set to us-east-1. You can re-define it globally in boto config or specify with -r option. The following command will list all instances across all regions under your AWS account:
# ./pmp-check-aws-rds.py -r all -l
The following command will show the status for the first instance identified as blackbox in all regions:
# ./pmp-check-aws-rds.py -r all -i blackbox -p
Remember, scanning regions are slower operation than specifying it explicitly.
Here is the excerpt of potential Nagios config:
define host{
use mysql-host
host_name blackbox
alias blackbox
address blackbox.abcdefgh.us-east-1.rds.amazonaws.com
}
define servicedependency{
host_name blackbox
service_description RDS Status
dependent_service_description RDS Load Average, RDS Free Storage, RDS Free Memory
execution_failure_criteria w,c,u,p
notification_failure_criteria w,c,u,p
}
define service{
use active-service
host_name blackbox
service_description RDS Status
check_command check_rds!status!0!0
}
define service{
use active-service
host_name blackbox
service_description RDS Load Average
check_command check_rds!load!90,85,80!98,95,90
}
define service{
use active-service
host_name blackbox
service_description RDS Free Storage
check_command check_rds!storage!10!5
}
define service{
use active-service
host_name blackbox
service_description RDS Free Memory
check_command check_rds!memory!5!2
}
define command{
command_name check_rds
command_line $USER1$/pmp-check-aws-rds.py -i $HOSTALIAS$ -m $ARG1$ -w $ARG2$ -c $ARG3$
}
Percona Monitoring Plugins pmp-check-aws-rds.py 1.1.7
Percona Monitoring Plugins for Nagios
For general inquiries, please send us your question and someone will contact you.
