mirror of
https://github.com/drewkerrigan/nagios-http-json.git
synced 2026-02-12 01:51:01 +01:00
Compare commits
139 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d9efd1d858 | ||
|
|
e72030a087 | ||
|
|
6b51e1bb06 | ||
|
|
3f73984f6b | ||
|
|
09a7ec080c | ||
|
|
1f52898d10 | ||
|
|
27936784c4 | ||
|
|
fa157753ce | ||
|
|
0aceabfe91 | ||
|
|
4fbb0c828a | ||
|
|
e96bba0eb8 | ||
|
|
d9ee817dfc | ||
|
|
ce9c5fdada | ||
|
|
27c710b2ea | ||
|
|
dddf8432d6 | ||
|
|
739c093702 | ||
|
|
46271c961b | ||
|
|
49b338bdb6 | ||
|
|
9f41fc491e | ||
|
|
3a22b712ab | ||
|
|
9626fc4464 | ||
|
|
c54a0040a0 | ||
|
|
ffd96dd59f | ||
|
|
0572c2f494 | ||
|
|
2e6eaeea59 | ||
|
|
428a5a6d3a | ||
|
|
e3ac06864d | ||
|
|
63542f3226 | ||
|
|
cdb2474ee0 | ||
|
|
2821a1ae66 | ||
|
|
831bfdf97b | ||
|
|
f612277772 | ||
|
|
1f440e0ff5 | ||
|
|
c23ebac77a | ||
|
|
a014944981 | ||
|
|
47a37556ba | ||
|
|
41279cad2c | ||
|
|
f7c0472cdc | ||
|
|
25fb340bbb | ||
|
|
47bdea7fc5 | ||
|
|
866a12ea07 | ||
|
|
d1e585b2dd | ||
|
|
941afeed89 | ||
|
|
b9a583f281 | ||
|
|
4c89a8a93d | ||
|
|
73557b3657 | ||
|
|
aad2376ac0 | ||
|
|
219e99386c | ||
|
|
0cbbf41b9c | ||
|
|
dd952fd571 | ||
|
|
83ee5062f5 | ||
|
|
c90b0323f5 | ||
|
|
1ac160e8c2 | ||
|
|
6fc41612c4 | ||
|
|
f567c1ca0c | ||
|
|
2c98e840e8 | ||
|
|
1a9e1e9048 | ||
|
|
4f1d29dc7e | ||
|
|
404890d918 | ||
|
|
e7cf7ca8fb | ||
|
|
71cbd98e79 | ||
|
|
5c416cd0c0 | ||
|
|
e4801227bf | ||
|
|
b7c0b0595e | ||
|
|
375da5d605 | ||
|
|
95912246a2 | ||
|
|
ba9d9b1c39 | ||
|
|
3f81e32b29 | ||
|
|
f97759f1bd | ||
|
|
e95daad8ff | ||
|
|
174686a980 | ||
|
|
24889384b0 | ||
|
|
21f48681c9 | ||
|
|
2196dba761 | ||
|
|
c2435a8cbf | ||
|
|
2289fb2af3 | ||
|
|
2541223cde | ||
|
|
209aaef041 | ||
|
|
65c3bd2a25 | ||
|
|
9c0c59d6c1 | ||
|
|
e2fce71d5a | ||
|
|
26a1b3dbe8 | ||
|
|
47547951cf | ||
|
|
7858382bbe | ||
|
|
1173420803 | ||
|
|
bcc36a6e95 | ||
|
|
d98d0396b2 | ||
|
|
8437c464e5 | ||
|
|
df2bbdbf51 | ||
|
|
823fc275c9 | ||
|
|
18b0898e72 | ||
|
|
95318954bf | ||
|
|
8e469e3d98 | ||
|
|
29f8d892ee | ||
|
|
cbdb884dc7 | ||
|
|
3a108aef5e | ||
|
|
81522fa9ab | ||
|
|
27eaaf0842 | ||
|
|
9dd6323b85 | ||
|
|
67136a4a2b | ||
|
|
d164a1250c | ||
|
|
89f42c15a0 | ||
|
|
1e707a4b6a | ||
|
|
9656265439 | ||
|
|
e463369671 | ||
|
|
357c2240ba | ||
|
|
42d1e08037 | ||
|
|
4950225393 | ||
|
|
9be6a709a2 | ||
|
|
06fab10fe2 | ||
|
|
7bdc802c2d | ||
|
|
ed7bc7175b | ||
|
|
4180ec2066 | ||
|
|
a0d0773d1a | ||
|
|
fbebf05f76 | ||
|
|
6f9048fc75 | ||
|
|
5bb09cd362 | ||
|
|
568fa6e4d0 | ||
|
|
f63ac180b6 | ||
|
|
070047cf55 | ||
|
|
8adcf2ff07 | ||
|
|
fb4e58b635 | ||
|
|
32a8884881 | ||
|
|
2644151b5f | ||
|
|
55b979f3e2 | ||
|
|
369d5115a3 | ||
|
|
ea7edf5d01 | ||
|
|
a4be4d42c6 | ||
|
|
cb0a5927c2 | ||
|
|
42e75abcad | ||
|
|
3058176ba1 | ||
|
|
e4334d0c4a | ||
|
|
b9d03c899f | ||
|
|
15c5075cc1 | ||
|
|
1be1b2e5a2 | ||
|
|
1772543ee3 | ||
|
|
fe2e830bf7 | ||
|
|
dd439998db | ||
|
|
82f4eaa48a |
26
.github/workflows/unittest.yml
vendored
Normal file
26
.github/workflows/unittest.yml
vendored
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
name: CI
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
gitHubActionForPytest:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
python-version: [3.8, 3.11, 3.12]
|
||||||
|
name: GitHub Action
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install -r requirements-dev.txt
|
||||||
|
- name: Lint
|
||||||
|
run: |
|
||||||
|
make lint
|
||||||
|
- name: Unit Test
|
||||||
|
run: |
|
||||||
|
make test
|
||||||
|
- name: Coverage
|
||||||
|
run: |
|
||||||
|
make coverage
|
||||||
65
.gitignore
vendored
Normal file
65
.gitignore
vendored
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
#Emacs
|
||||||
|
\#*
|
||||||
|
.\#*
|
||||||
|
|
||||||
|
# Byte-compiled / optimized / DLL files
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*$py.class
|
||||||
|
|
||||||
|
# Distribution / packaging
|
||||||
|
.Python
|
||||||
|
env/
|
||||||
|
build/
|
||||||
|
develop-eggs/
|
||||||
|
dist/
|
||||||
|
downloads/
|
||||||
|
eggs/
|
||||||
|
.eggs/
|
||||||
|
lib/
|
||||||
|
lib64/
|
||||||
|
parts/
|
||||||
|
sdist/
|
||||||
|
var/
|
||||||
|
*.egg-info/
|
||||||
|
.installed.cfg
|
||||||
|
*.egg
|
||||||
|
.venv/
|
||||||
|
venv/
|
||||||
|
|
||||||
|
# PyInstaller
|
||||||
|
# Usually these files are written by a python script from a template
|
||||||
|
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||||
|
*.manifest
|
||||||
|
*.spec
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
pip-delete-this-directory.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
htmlcov/
|
||||||
|
.tox/
|
||||||
|
.coverage
|
||||||
|
.coverage.*
|
||||||
|
.cache
|
||||||
|
nosetests.xml
|
||||||
|
coverage.xml
|
||||||
|
*,cover
|
||||||
|
.hypothesis/
|
||||||
|
|
||||||
|
# Translations
|
||||||
|
*.mo
|
||||||
|
*.pot
|
||||||
|
|
||||||
|
# Django stuff:
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Sphinx documentation
|
||||||
|
docs/_build/
|
||||||
|
|
||||||
|
# PyBuilder
|
||||||
|
target/
|
||||||
|
|
||||||
|
#Ipython Notebook
|
||||||
|
.ipynb_checkpoints
|
||||||
21
.pylintrc
Normal file
21
.pylintrc
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# pylint config
|
||||||
|
[MASTER]
|
||||||
|
ignore-patterns=^test.*
|
||||||
|
|
||||||
|
[MESSAGES CONTROL]
|
||||||
|
disable=fixme,
|
||||||
|
consider-using-f-string,
|
||||||
|
invalid-name,
|
||||||
|
line-too-long,
|
||||||
|
missing-function-docstring,
|
||||||
|
missing-module-docstring,
|
||||||
|
multiple-imports,
|
||||||
|
no-else-return,
|
||||||
|
redefined-outer-name,
|
||||||
|
superfluous-parens,
|
||||||
|
too-many-locals,
|
||||||
|
too-many-arguments,
|
||||||
|
too-many-branches,
|
||||||
|
too-many-instance-attributes,
|
||||||
|
too-many-return-statements,
|
||||||
|
too-many-statements
|
||||||
11
Makefile
Normal file
11
Makefile
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
.PHONY: lint test coverage
|
||||||
|
|
||||||
|
PYTHON_PATH?=python3
|
||||||
|
|
||||||
|
lint:
|
||||||
|
$(PYTHON_PATH) -m pylint check_http_json.py
|
||||||
|
test:
|
||||||
|
$(PYTHON_PATH) -m unittest discover
|
||||||
|
coverage:
|
||||||
|
$(PYTHON_PATH) -m coverage run -m unittest discover
|
||||||
|
$(PYTHON_PATH) -m coverage report -m --include check_http_json.py
|
||||||
397
README.md
397
README.md
@@ -1,13 +1,204 @@
|
|||||||
|

|
||||||
|
|
||||||
# Nagios Json Plugin
|
# Nagios Json Plugin
|
||||||
|
|
||||||
This is a generic plugin for Nagios which checks json values from a given HTTP endpoint against argument specified rules and determines the status and performance data for that service.
|
This is a generic plugin for Nagios which checks json values from a given HTTP endpoint against argument specified rules and determines the status and performance data for that service.
|
||||||
|
|
||||||
### Installation
|
## Links
|
||||||
|
|
||||||
#### Requirements
|
* [CLI Usage](#cli-usage)
|
||||||
|
* [Examples](#examples)
|
||||||
|
* [Riak Stats](docs/RIAK.md)
|
||||||
|
* [Docker](docs/DOCKER.md)
|
||||||
|
* [Nagios Installation](#nagios-installation)
|
||||||
|
|
||||||
* Nagios
|
## CLI Usage
|
||||||
* Python
|
|
||||||
|
Executing `./check_http_json.py -h` will yield the following details:
|
||||||
|
|
||||||
|
```
|
||||||
|
usage: check_http_json.py [-h] [-d] [-s] -H HOST [-k] [-V] [--cacert CACERT]
|
||||||
|
[--cert CERT] [--key KEY] [-P PORT] [-p PATH]
|
||||||
|
[-t TIMEOUT] [-B AUTH] [-D DATA] [-A HEADERS]
|
||||||
|
[-f FIELD_SEPARATOR] [-F VALUE_SEPARATOR]
|
||||||
|
[-w [KEY_THRESHOLD_WARNING [KEY_THRESHOLD_WARNING ...]]]
|
||||||
|
[-c [KEY_THRESHOLD_CRITICAL [KEY_THRESHOLD_CRITICAL ...]]]
|
||||||
|
[-e [KEY_LIST [KEY_LIST ...]]]
|
||||||
|
[-E [KEY_LIST_CRITICAL [KEY_LIST_CRITICAL ...]]]
|
||||||
|
[-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]]
|
||||||
|
[-Q [KEY_VALUE_LIST_CRITICAL [KEY_VALUE_LIST_CRITICAL ...]]]
|
||||||
|
[-u [KEY_VALUE_LIST_UNKNOWN [KEY_VALUE_LIST_UNKNOWN ...]]]
|
||||||
|
[-y [KEY_VALUE_LIST_NOT [KEY_VALUE_LIST_NOT ...]]]
|
||||||
|
[-Y [KEY_VALUE_LIST_NOT_CRITICAL [KEY_VALUE_LIST_NOT_CRITICAL ...]]]
|
||||||
|
[-m [METRIC_LIST [METRIC_LIST ...]]]
|
||||||
|
|
||||||
|
Check HTTP JSON Nagios Plugin
|
||||||
|
|
||||||
|
Generic Nagios plugin which checks json values from a given endpoint against
|
||||||
|
argument specified rules and determines the status and performance data for
|
||||||
|
that service.
|
||||||
|
|
||||||
|
Version: 2.2.0 (2024-05-14)
|
||||||
|
|
||||||
|
options:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
-d, --debug debug mode
|
||||||
|
-v, --verbose Verbose mode. Multiple -v options increase the verbosity
|
||||||
|
-s, --ssl use TLS to connect to remote host
|
||||||
|
-H HOST, --host HOST remote host to query
|
||||||
|
-k, --insecure do not check server SSL certificate
|
||||||
|
-X {GET,POST}, --request {GET,POST}
|
||||||
|
Specifies a custom request method to use when communicating with the HTTP server
|
||||||
|
-V, --version print version of this plugin
|
||||||
|
--cacert CACERT SSL CA certificate
|
||||||
|
--cert CERT SSL client certificate
|
||||||
|
--key KEY SSL client key ( if not bundled into the cert )
|
||||||
|
-P PORT, --port PORT TCP port
|
||||||
|
-p PATH, --path PATH Path
|
||||||
|
-t TIMEOUT, --timeout TIMEOUT
|
||||||
|
Connection timeout (seconds)
|
||||||
|
--unreachable-state UNREACHABLE_STATE
|
||||||
|
Exit with specified code if URL unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)
|
||||||
|
-B AUTH, --basic-auth AUTH
|
||||||
|
Basic auth string "username:password"
|
||||||
|
-D DATA, --data DATA The http payload to send as a POST
|
||||||
|
-A HEADERS, --headers HEADERS
|
||||||
|
The http headers in JSON format.
|
||||||
|
-f SEPARATOR, --field_separator SEPARATOR
|
||||||
|
JSON Field separator, defaults to "."; Select element in an array with "(" ")"
|
||||||
|
-F VALUE_SEPARATOR, --value_separator VALUE_SEPARATOR
|
||||||
|
JSON Value separator, defaults to ":"
|
||||||
|
-w [KEY_THRESHOLD_WARNING ...], --warning [KEY_THRESHOLD_WARNING ...]
|
||||||
|
Warning threshold for these values (key1[>alias],WarnRange key2[>alias],WarnRange). WarnRange is in the format
|
||||||
|
[@]start:end, more information at nagios-plugins.org/doc/guidelines.html.
|
||||||
|
-c [KEY_THRESHOLD_CRITICAL ...], --critical [KEY_THRESHOLD_CRITICAL ...]
|
||||||
|
Critical threshold for these values (key1[>alias],CriticalRange key2[>alias],CriticalRange. CriticalRange is in
|
||||||
|
the format [@]start:end, more information at nagios-plugins.org/doc/guidelines.html.
|
||||||
|
-e [KEY_LIST ...], --key_exists [KEY_LIST ...]
|
||||||
|
Checks existence of these keys to determine status. Return warning if key is not present.
|
||||||
|
-E [KEY_LIST_CRITICAL ...], --key_exists_critical [KEY_LIST_CRITICAL ...]
|
||||||
|
Same as -e but return critical if key is not present.
|
||||||
|
-q [KEY_VALUE_LIST ...], --key_equals [KEY_VALUE_LIST ...]
|
||||||
|
Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values
|
||||||
|
can be delimited with colon (key,value1:value2). Return warning if equality check fails
|
||||||
|
-Q [KEY_VALUE_LIST_CRITICAL ...], --key_equals_critical [KEY_VALUE_LIST_CRITICAL ...]
|
||||||
|
Same as -q but return critical if equality check fails.
|
||||||
|
-u [KEY_VALUE_LIST_UNKNOWN ...], --key_equals_unknown [KEY_VALUE_LIST_UNKNOWN ...]
|
||||||
|
Same as -q but return unknown if equality check fails.
|
||||||
|
-y [KEY_VALUE_LIST_NOT ...], --key_not_equals [KEY_VALUE_LIST_NOT ...]
|
||||||
|
Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values
|
||||||
|
can be delimited with colon (key,value1:value2). Return warning if equality check succeeds
|
||||||
|
-Y [KEY_VALUE_LIST_NOT_CRITICAL ...], --key_not_equals_critical [KEY_VALUE_LIST_NOT_CRITICAL ...]
|
||||||
|
Same as -q but return critical if equality check succeeds.
|
||||||
|
-m [METRIC_LIST ...], --key_metric [METRIC_LIST ...]
|
||||||
|
Gathers the values of these keys (key[>alias], UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for Nagios
|
||||||
|
performance data. More information about Range format and units of measure for nagios can be found at nagios-
|
||||||
|
plugins.org/doc/guidelines.html Additional formats for this parameter are: (key[>alias]),
|
||||||
|
(key[>alias],UnitOfMeasure), (key[>alias],UnitOfMeasure,WarnRange, CriticalRange).
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Key Naming
|
||||||
|
|
||||||
|
**Data for key** `value`:
|
||||||
|
|
||||||
|
{ "value": 1000 }
|
||||||
|
|
||||||
|
**Data for key** `capacity.value`:
|
||||||
|
|
||||||
|
{
|
||||||
|
"capacity": {
|
||||||
|
"value": 1000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
**Data for key** `(0).capacity.value`:
|
||||||
|
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"capacity": {
|
||||||
|
"value": 1000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
**Data for keys of all items in a list** `(*).capacity.value`:
|
||||||
|
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"capacity": {
|
||||||
|
"value": 1000
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"capacity": {
|
||||||
|
"value": 2200
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
**Data for separator** `-f _` **and key** `(0)_gauges_jvm.buffers.direct.capacity_value`:
|
||||||
|
|
||||||
|
[
|
||||||
|
{
|
||||||
|
"gauges": {
|
||||||
|
"jvm.buffers.direct.capacity":
|
||||||
|
"value": 1000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
**Data for keys** `ring_members(0)`, `ring_members(1)`, `ring_members(2)`:
|
||||||
|
|
||||||
|
{
|
||||||
|
"ring_members": [
|
||||||
|
"riak1@127.0.0.1",
|
||||||
|
"riak2@127.0.0.1",
|
||||||
|
"riak3@127.0.0.1"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
### Thresholds and Ranges
|
||||||
|
|
||||||
|
**Data**:
|
||||||
|
|
||||||
|
{ "metric": 1000 }
|
||||||
|
|
||||||
|
#### Relevant Commands
|
||||||
|
|
||||||
|
* **Warning:** `./check_http_json.py -H <host>:<port> -p <path> -w "metric,RANGE"`
|
||||||
|
* **Critical:** `./check_http_json.py -H <host>:<port> -p <path> -c "metric,RANGE"`
|
||||||
|
* **Metrics with Warning:** `./check_http_json.py -H <host>:<port> -p <path> -w "metric,RANGE"`
|
||||||
|
* **Metrics with Critical:**
|
||||||
|
|
||||||
|
./check_http_json.py -H <host>:<port> -p <path> -w "metric,,,RANGE"
|
||||||
|
./check_http_json.py -H <host>:<port> -p <path> -w "metric,,,,MIN,MAX"
|
||||||
|
|
||||||
|
#### Range Definitions
|
||||||
|
|
||||||
|
* **Format:** [@]START:END
|
||||||
|
* **Generates a Warning or Critical if...**
|
||||||
|
* **Value is less than 0 or greater than 1000:** `1000` or `0:1000`
|
||||||
|
* **Value is greater than or equal to 1000, or less than or equal to 0:** `@1000` or `@0:1000`
|
||||||
|
* **Value is less than 1000:** `1000:`
|
||||||
|
* **Value is greater than 1000:** `~:1000`
|
||||||
|
* **Value is greater than or equal to 1000:** `@1000:`
|
||||||
|
|
||||||
|
More info about Nagios Range format and Units of Measure can be found at [https://nagios-plugins.org/doc/guidelines.html](https://nagios-plugins.org/doc/guidelines.html).
|
||||||
|
|
||||||
|
#### Using Headers
|
||||||
|
|
||||||
|
* `./check_http_json.py -H <host>:<port> -p <path> -A '{"content-type": "application/json"}' -w "metric,RANGE"`
|
||||||
|
|
||||||
|
## Nagios Installation
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
* Python 3.6+
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
Assuming a standard installation of Nagios, the plugin can be executed from the machine that Nagios is running on.
|
Assuming a standard installation of Nagios, the plugin can be executed from the machine that Nagios is running on.
|
||||||
|
|
||||||
@@ -35,207 +226,15 @@ Add the following command definition to your commands config (`commands.config`)
|
|||||||
|
|
||||||
define command{
|
define command{
|
||||||
command_name <command_name>
|
command_name <command_name>
|
||||||
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H <host>:<port> -p <path> [-e|-q|-l|-g <rules>] [-m <metrics>]
|
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H <host>:<port> -p <path> [-e|-q|-w|-c <rules>] [-m <metrics>]
|
||||||
}
|
}
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
More info about options in Usage.
|
## Icinga2 configuration
|
||||||
|
|
||||||
### CLI Usage
|
The Icinga2 command definition can be found here: (contrib/icinga2_check_command_definition.conf)
|
||||||
|
|
||||||
Executing `./check_http_json.py -h` will yield the following details:
|
|
||||||
|
|
||||||
```
|
|
||||||
usage: check_http_json.py [-h] -H HOST [-B AUTH] [-p PATH]
|
|
||||||
[-e [KEY_LIST [KEY_LIST ...]]]
|
|
||||||
[-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]]
|
|
||||||
[-l [KEY_LTE_LIST [KEY_LTE_LIST ...]]]
|
|
||||||
[-g [KEY_GTE_LIST [KEY_GTE_LIST ...]]]
|
|
||||||
[-m [METRIC_LIST [METRIC_LIST ...]]] [-s]
|
|
||||||
[-f SEPARATOR] [-d]
|
|
||||||
|
|
||||||
Nagios plugin which checks json values from a given endpoint against argument
|
|
||||||
specified rules and determines the status and performance data for that
|
|
||||||
service
|
|
||||||
|
|
||||||
optional arguments:
|
|
||||||
-h, --help show this help message and exit
|
|
||||||
-H HOST, --host HOST Host.
|
|
||||||
-B AUTH, --basic-auth AUTH
|
|
||||||
Basic auth string "username:password"
|
|
||||||
-p PATH, --path PATH Path.
|
|
||||||
-e [KEY_LIST [KEY_LIST ...]], --key_exists [KEY_LIST [KEY_LIST ...]]
|
|
||||||
Checks existence of these keys to determine status.
|
|
||||||
-q [KEY_VALUE_LIST [KEY_VALUE_LIST ...]], --key_equals [KEY_VALUE_LIST [KEY_VALUE_LIST ...]]
|
|
||||||
Checks equality of these keys and values (key,value
|
|
||||||
key2,value2) to determine status.
|
|
||||||
-l [KEY_LTE_LIST [KEY_LTE_LIST ...]], --key_lte [KEY_LTE_LIST [KEY_LTE_LIST ...]]
|
|
||||||
Checks that these keys and values (key,value
|
|
||||||
key2,value2) are less than or equal to the returned
|
|
||||||
json value to determine status.
|
|
||||||
-g [KEY_GTE_LIST [KEY_GTE_LIST ...]], --key_gte [KEY_GTE_LIST [KEY_GTE_LIST ...]]
|
|
||||||
Checks that these keys and values (key,value
|
|
||||||
key2,value2) are greater than or equal to the returned
|
|
||||||
json value to determine status.
|
|
||||||
-m [METRIC_LIST [METRIC_LIST ...]], --key_metric [METRIC_LIST [METRIC_LIST ...]]
|
|
||||||
Gathers the values of these keys
|
|
||||||
(key,UnitOfMeasure,Min,Max,WarnRange,CriticalRange)
|
|
||||||
for Nagios performance data. More information about
|
|
||||||
Range format and units of measure for nagios can be
|
|
||||||
found at https://nagios-
|
|
||||||
plugins.org/doc/guidelines.html Additional formats for
|
|
||||||
this parameter are: (key), (key,UnitOfMeasure),
|
|
||||||
(key,UnitOfMeasure,Min,Max).
|
|
||||||
-s, --ssl HTTPS mode.
|
|
||||||
-f SEPARATOR, --field_separator SEPARATOR
|
|
||||||
Json Field separator, defaults to "." ; Select element
|
|
||||||
in an array with "(" ")"
|
|
||||||
-d, --debug Debug mode.
|
|
||||||
```
|
|
||||||
|
|
||||||
Access a specific JSON field by following this syntax: `alpha.beta.gamma(3).theta.omega(0)`
|
|
||||||
Dots are field separators (changeable), parantheses are for entering arrays.
|
|
||||||
|
|
||||||
More info about Nagios Range format and Units of Measure can be found at [https://nagios-plugins.org/doc/guidelines.html](https://nagios-plugins.org/doc/guidelines.html).
|
|
||||||
|
|
||||||
### Docker Info Example Plugin
|
|
||||||
|
|
||||||
#### Description
|
|
||||||
|
|
||||||
Let's say we want to use `check_http_json.py` to read from Docker's `/info` HTTP API endpoint with the following parameters:
|
|
||||||
|
|
||||||
##### Connection information
|
|
||||||
|
|
||||||
* Host = 127.0.0.1:4243
|
|
||||||
* Path = /info
|
|
||||||
|
|
||||||
##### Rules for "aliveness"
|
|
||||||
|
|
||||||
* Verify that the key `Containers` exists in the outputted JSON
|
|
||||||
* Verify that the key `IPv4Forwarding` has a value of `1`
|
|
||||||
* Verify that the key `Debug` has a value less than or equal to `2`
|
|
||||||
* Verify that the key `Images` has a value greater than or equal to `1`
|
|
||||||
* If any of these criteria are not met, report a WARNING to Nagios
|
|
||||||
|
|
||||||
##### Gather Metrics
|
|
||||||
|
|
||||||
* Report value of the key `Containers` with a MinValue of 0 and a MaxValue of 1000 as performance data
|
|
||||||
* Report value of the key `Images` as performance data
|
|
||||||
* Report value of the key `NEventsListener` as performance data
|
|
||||||
* Report value of the key `NFd` as performance data
|
|
||||||
* Report value of the key `NGoroutines` as performance data
|
|
||||||
* Report value of the key `SwapLimit` as performance data
|
|
||||||
|
|
||||||
#### Service Definition
|
|
||||||
|
|
||||||
`localhost.cfg`
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
define service {
|
|
||||||
use local-service
|
|
||||||
host_name localhost
|
|
||||||
service_description Docker info status checker
|
|
||||||
check_command check_docker
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Command Definition with Arguments
|
|
||||||
|
|
||||||
`commands.cfg`
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
define command{
|
|
||||||
command_name check_docker
|
|
||||||
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p info -e Containers -q IPv4Forwarding,1 -l Debug,2 -g Images,1 -m Containers,,0,1000 Images NEventsListener NFd NGoroutines SwapLimit
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Sample Output
|
|
||||||
|
|
||||||
```
|
|
||||||
OK: Status OK.|'Containers'=1;0;1000 'Images'=11;0;0 'NEventsListener'=3;0;0 'NFd'=10;0;0 'NGoroutines'=14;0;0 'SwapLimit'=1;0;0
|
|
||||||
```
|
|
||||||
|
|
||||||
### Docker Container Monitor Example Plugin
|
|
||||||
|
|
||||||
`check_http_json.py` is generic enough to read and evaluate rules on any HTTP endpoint that returns JSON. In this example we'll get the status of a specific container using it's ID which camn be found by using the list containers endpoint (`curl http://127.0.0.1:4243/containers/json?all=1`).
|
|
||||||
|
|
||||||
##### Connection information
|
|
||||||
|
|
||||||
* Host = 127.0.0.1:4243
|
|
||||||
* Path = /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json
|
|
||||||
|
|
||||||
##### Rules for "aliveness"
|
|
||||||
|
|
||||||
* Verify that the key `ID` exists and is equal to the value `2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615`
|
|
||||||
* Verify that the key `State.Running` has a value of `True`
|
|
||||||
|
|
||||||
#### Service Definition
|
|
||||||
|
|
||||||
`localhost.cfg`
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
define service {
|
|
||||||
use local-service
|
|
||||||
host_name localhost
|
|
||||||
service_description Docker container liveness check
|
|
||||||
check_command check_my_container
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Command Definition with Arguments
|
|
||||||
|
|
||||||
`commands.cfg`
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
define command{
|
|
||||||
command_name check_my_container
|
|
||||||
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json -q ID,2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615 State.Running,True
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Sample Output
|
|
||||||
|
|
||||||
```
|
|
||||||
WARNING: Status check failed, reason: Value True for key State.Running did not match.
|
|
||||||
```
|
|
||||||
|
|
||||||
The plugin threw a warning because the Container ID I used on my system has the following State object:
|
|
||||||
|
|
||||||
```
|
|
||||||
u'State': {...
|
|
||||||
u'Running': False,
|
|
||||||
...
|
|
||||||
```
|
|
||||||
|
|
||||||
If I change the command to have the parameter -q parameter `State.Running,False`, the output becomes:
|
|
||||||
|
|
||||||
```
|
|
||||||
OK: Status OK.
|
|
||||||
```
|
|
||||||
|
|
||||||
### Dropwizard / Fieldnames Containing '.' Example
|
|
||||||
|
|
||||||
Simply choose a separator to deal with data such as this:
|
|
||||||
|
|
||||||
```
|
|
||||||
{ "gauges": { "jvm.buffers.direct.capacity": {"value": 215415}}}
|
|
||||||
```
|
|
||||||
|
|
||||||
In this example I've chosen `_` to separate `guages` from `jvm` and `capacity` from `value`. The CLI invocation then becomes:
|
|
||||||
|
|
||||||
```
|
|
||||||
./check_http_json.py -H localhost:8081 -p metrics --key_exists gauges_jvm.buffers.direct.capacity_value -f _
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -1,260 +1,674 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
import urllib.request, urllib.error, urllib.parse
|
||||||
|
import base64
|
||||||
|
import json
|
||||||
|
import argparse
|
||||||
|
import sys
|
||||||
|
import ssl
|
||||||
|
from urllib.error import HTTPError
|
||||||
|
from urllib.error import URLError
|
||||||
|
|
||||||
|
plugin_description = \
|
||||||
"""
|
"""
|
||||||
Check HTTP JSON Nagios Plugin
|
Check HTTP JSON Nagios Plugin
|
||||||
|
|
||||||
Generic Nagios plugin which checks json values from a given endpoint against argument specified rules
|
Generic Nagios plugin which checks json values from a given endpoint against
|
||||||
and determines the status and performance data for that service.
|
argument specified rules and determines the status and performance data for
|
||||||
|
that service.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import httplib, urllib, urllib2, base64
|
OK_CODE = 0
|
||||||
import json
|
WARNING_CODE = 1
|
||||||
import argparse
|
CRITICAL_CODE = 2
|
||||||
from pprint import pprint
|
UNKNOWN_CODE = 3
|
||||||
from urllib2 import HTTPError
|
|
||||||
from urllib2 import URLError
|
|
||||||
|
|
||||||
|
__version__ = '2.2.0'
|
||||||
|
__version_date__ = '2024-05-14'
|
||||||
|
|
||||||
class NagiosHelper:
|
class NagiosHelper:
|
||||||
"""Help with Nagios specific status string formatting."""
|
"""
|
||||||
code = 0
|
Help with Nagios specific status string formatting.
|
||||||
message_prefixes = {0: 'OK', 1: 'WARNING', 2: 'CRITICAL', 3: 'UNKNOWN'}
|
"""
|
||||||
message_text = ''
|
|
||||||
performance_data = ''
|
|
||||||
|
|
||||||
def getMessage(self):
|
message_prefixes = {OK_CODE: 'OK',
|
||||||
"""Build a status-prefixed message with optional performance data generated externally"""
|
WARNING_CODE: 'WARNING',
|
||||||
text = "%s" % self.message_prefixes[self.code]
|
CRITICAL_CODE: 'CRITICAL',
|
||||||
if self.message_text:
|
UNKNOWN_CODE: 'UNKNOWN'}
|
||||||
text += ": %s" % self.message_text
|
performance_data = ''
|
||||||
if self.performance_data:
|
warning_message = ''
|
||||||
text += "|%s" % self.performance_data
|
critical_message = ''
|
||||||
return text
|
unknown_message = ''
|
||||||
|
|
||||||
def setCodeAndMessage(self, code, text):
|
def getMessage(self, message=''):
|
||||||
self.code = code
|
"""
|
||||||
self.message_text = text
|
Build a status-prefixed message with optional performance data
|
||||||
|
generated externally
|
||||||
|
"""
|
||||||
|
|
||||||
|
message += self.warning_message
|
||||||
|
message += self.critical_message
|
||||||
|
message += self.unknown_message
|
||||||
|
code = self.message_prefixes[self.getCode()]
|
||||||
|
output = "{code}: Status {code}. {message}".format(code=code, message=message.strip())
|
||||||
|
if self.performance_data:
|
||||||
|
output = "{code}: {perf_data} Status {code}. {message}|{perf_data}".format(
|
||||||
|
code=code,
|
||||||
|
message=message.strip(),
|
||||||
|
perf_data=self.performance_data)
|
||||||
|
return output.strip()
|
||||||
|
|
||||||
|
def getCode(self):
|
||||||
|
code = OK_CODE
|
||||||
|
if (self.warning_message != ''):
|
||||||
|
code = WARNING_CODE
|
||||||
|
if (self.critical_message != ''):
|
||||||
|
code = CRITICAL_CODE
|
||||||
|
if (self.unknown_message != ''):
|
||||||
|
code = UNKNOWN_CODE
|
||||||
|
return code
|
||||||
|
|
||||||
|
def append_message(self, code, msg):
|
||||||
|
if code > 2 or code < 0:
|
||||||
|
self.unknown_message += msg
|
||||||
|
if code == 1:
|
||||||
|
self.warning_message += msg
|
||||||
|
if code == 2:
|
||||||
|
self.critical_message += msg
|
||||||
|
|
||||||
|
def append_metrics(self, metrics):
|
||||||
|
(performance_data, warning_message, critical_message) = metrics
|
||||||
|
self.performance_data += performance_data
|
||||||
|
self.append_message(WARNING_CODE, warning_message)
|
||||||
|
self.append_message(CRITICAL_CODE, critical_message)
|
||||||
|
|
||||||
def ok(self, text): self.setCodeAndMessage(0, text)
|
|
||||||
def warning(self, text): self.setCodeAndMessage(1, text)
|
|
||||||
def critical(self, text): self.setCodeAndMessage(2, text)
|
|
||||||
def unknown(self, text): self.setCodeAndMessage(3, text)
|
|
||||||
|
|
||||||
class JsonHelper:
|
class JsonHelper:
|
||||||
"""Perform simple comparison operations against values in a given JSON dict"""
|
"""
|
||||||
def __init__(self, json_data, separator):
|
Perform simple comparison operations against values in a given
|
||||||
self.data = json_data
|
JSON dict
|
||||||
self.separator = separator
|
"""
|
||||||
self.arrayOpener = '('
|
|
||||||
self.arrayCloser = ')'
|
|
||||||
|
|
||||||
def getSubElement(self, key, data):
|
def __init__(self, json_data, separator, value_separator):
|
||||||
separatorIndex = key.find(self.separator)
|
self.data = json_data
|
||||||
partialKey = key[:separatorIndex]
|
self.separator = separator
|
||||||
remainingKey = key[separatorIndex + 1:]
|
self.value_separator = value_separator
|
||||||
if partialKey in data:
|
self.arrayOpener = '('
|
||||||
return self.get(remainingKey, data[partialKey])
|
self.arrayCloser = ')'
|
||||||
else:
|
|
||||||
return (None, 'not_found')
|
|
||||||
|
|
||||||
def getSubArrayElement(self, key, data):
|
def getSubElement(self, key, data):
|
||||||
subElemKey = key[:key.find(self.arrayOpener)]
|
separatorIndex = key.find(self.separator)
|
||||||
index = int(key[key.find(self.arrayOpener) + 1:key.find(self.arrayCloser)])
|
partialKey = key[:separatorIndex]
|
||||||
remainingKey = key[key.find(self.arrayCloser + self.separator) + 2:]
|
remainingKey = key[separatorIndex + 1:]
|
||||||
if key.find(self.arrayCloser + self.separator) == -1:
|
if partialKey in data:
|
||||||
remainingKey = key[key.find(self.arrayCloser) + 1:]
|
return self.get(remainingKey, data[partialKey])
|
||||||
|
return (None, 'not_found')
|
||||||
|
|
||||||
if subElemKey in data:
|
def getSubArrayElement(self, key, data):
|
||||||
if index < len(data[subElemKey]):
|
subElemKey = key[:key.find(self.arrayOpener)]
|
||||||
return self.get(remainingKey, data[subElemKey][index])
|
index = int(key[key.find(self.arrayOpener) +
|
||||||
else:
|
1:key.find(self.arrayCloser)])
|
||||||
return (None, 'not_found')
|
remainingKey = key[key.find(self.arrayCloser + self.separator) + 2:]
|
||||||
else:
|
|
||||||
return (None, 'not_found')
|
|
||||||
|
|
||||||
def equals(self, key, value): return self.exists(key) and str(self.get(key)) == value
|
if key.find(self.arrayCloser + self.separator) == -1:
|
||||||
def lte(self, key, value): return self.exists(key) and float(self.get(key)) <= float(value)
|
remainingKey = key[key.find(self.arrayCloser) + 1:]
|
||||||
def gte(self, key, value): return self.exists(key) and float(self.get(key)) >= float(value)
|
if subElemKey in data:
|
||||||
def exists(self, key): return (self.get(key) != (None, 'not_found'))
|
if index < len(data[subElemKey]):
|
||||||
def get(self, key, temp_data=''):
|
return self.get(remainingKey, data[subElemKey][index])
|
||||||
"""Can navigate nested json keys with a dot format (Element.Key.NestedKey). Returns (None, 'not_found') if not found"""
|
else:
|
||||||
if temp_data:
|
return (None, 'not_found')
|
||||||
data = temp_data
|
if index >= len(data):
|
||||||
else:
|
return (None, 'not_found')
|
||||||
data = self.data
|
else:
|
||||||
|
if not subElemKey:
|
||||||
|
return self.get(remainingKey, data[index])
|
||||||
|
else:
|
||||||
|
return (None, 'not_found')
|
||||||
|
|
||||||
if len(key) <= 0:
|
def equals(self, key, value):
|
||||||
return data
|
return self.exists(key) and \
|
||||||
|
str(self.get(key)) in value.split(self.value_separator)
|
||||||
|
|
||||||
|
def lte(self, key, value):
|
||||||
|
return self.exists(key) and float(self.get(key)) <= float(value)
|
||||||
|
|
||||||
|
def lt(self, key, value):
|
||||||
|
return self.exists(key) and float(self.get(key)) < float(value)
|
||||||
|
|
||||||
|
def gte(self, key, value):
|
||||||
|
return self.exists(key) and float(self.get(key)) >= float(value)
|
||||||
|
|
||||||
|
def gt(self, key, value):
|
||||||
|
return self.exists(key) and float(self.get(key)) > float(value)
|
||||||
|
|
||||||
|
def exists(self, key):
|
||||||
|
return (self.get(key) != (None, 'not_found'))
|
||||||
|
|
||||||
|
def get(self, key, temp_data=''):
|
||||||
|
"""
|
||||||
|
Can navigate nested json keys with a dot format
|
||||||
|
(Element.Key.NestedKey). Returns (None, 'not_found') if not found
|
||||||
|
"""
|
||||||
|
|
||||||
|
if temp_data != '':
|
||||||
|
data = temp_data
|
||||||
|
else:
|
||||||
|
data = self.data
|
||||||
|
if len(key) <= 0:
|
||||||
|
return data
|
||||||
|
if key.find(self.separator) != -1 and \
|
||||||
|
key.find(self.arrayOpener) != -1:
|
||||||
|
if key.find(self.separator) < key.find(self.arrayOpener):
|
||||||
|
return self.getSubElement(key, data)
|
||||||
|
else:
|
||||||
|
return self.getSubArrayElement(key, data)
|
||||||
|
else:
|
||||||
|
if key.find(self.separator) != -1:
|
||||||
|
return self.getSubElement(key, data)
|
||||||
|
else:
|
||||||
|
if key.find(self.arrayOpener) != -1:
|
||||||
|
return self.getSubArrayElement(key, data)
|
||||||
|
else:
|
||||||
|
if isinstance(data, dict) and key in data:
|
||||||
|
return data[key]
|
||||||
|
else:
|
||||||
|
return (None, 'not_found')
|
||||||
|
|
||||||
|
def expandKey(self, key, keys):
|
||||||
|
if '(*)' not in key:
|
||||||
|
keys.append(key)
|
||||||
|
return keys
|
||||||
|
subElemKey = ''
|
||||||
|
if key.find('(*)') > 0:
|
||||||
|
subElemKey = key[:key.find('(*)')-1]
|
||||||
|
remainingKey = key[key.find('(*)')+3:]
|
||||||
|
elemData = self.get(subElemKey)
|
||||||
|
if elemData == (None, 'not_found'):
|
||||||
|
keys.append(key)
|
||||||
|
return keys
|
||||||
|
if subElemKey != '':
|
||||||
|
subElemKey = subElemKey + '.'
|
||||||
|
for i in range(len(elemData)):
|
||||||
|
newKey = subElemKey + '(' + str(i) + ')' + remainingKey
|
||||||
|
newKeys = self.expandKey(newKey, [])
|
||||||
|
for j in newKeys:
|
||||||
|
keys.append(j)
|
||||||
|
|
||||||
|
return keys
|
||||||
|
|
||||||
|
|
||||||
|
def _getKeyAlias(original_key):
|
||||||
|
key = original_key
|
||||||
|
alias = original_key
|
||||||
|
if '>' in original_key:
|
||||||
|
keys = original_key.split('>')
|
||||||
|
if len(keys) == 2:
|
||||||
|
key, alias = keys
|
||||||
|
return key, alias
|
||||||
|
|
||||||
if key.find(self.separator) != -1 and key.find(self.arrayOpener) != -1 :
|
|
||||||
if key.find(self.separator) < key.find(self.arrayOpener) :
|
|
||||||
return self.getSubElement(key, data)
|
|
||||||
else:
|
|
||||||
return self.getSubArrayElement(key, data)
|
|
||||||
else:
|
|
||||||
if key.find(self.separator) != -1 :
|
|
||||||
return self.getSubElement(key, data)
|
|
||||||
else:
|
|
||||||
if key.find(self.arrayOpener) != -1 :
|
|
||||||
return self.getSubArrayElement(key, data)
|
|
||||||
else:
|
|
||||||
if key in data:
|
|
||||||
return data[key]
|
|
||||||
else:
|
|
||||||
return (None, 'not_found')
|
|
||||||
|
|
||||||
class JsonRuleProcessor:
|
class JsonRuleProcessor:
|
||||||
"""Perform checks and gather values from a JSON dict given rules and metrics definitions"""
|
"""
|
||||||
def __init__(self, json_data, rules_args):
|
Perform checks and gather values from a JSON dict given rules
|
||||||
self.data = json_data
|
and metrics definitions
|
||||||
self.rules = rules_args
|
"""
|
||||||
separator = '.'
|
|
||||||
if self.rules.separator: separator = self.rules.separator
|
|
||||||
self.helper = JsonHelper(self.data, separator)
|
|
||||||
|
|
||||||
debugPrint(rules_args.debug, "separator:%s" % separator)
|
def __init__(self, json_data, rules_args):
|
||||||
|
self.data = json_data
|
||||||
|
self.rules = rules_args
|
||||||
|
separator = '.'
|
||||||
|
value_separator = ':'
|
||||||
|
if self.rules.separator:
|
||||||
|
separator = self.rules.separator
|
||||||
|
if self.rules.value_separator:
|
||||||
|
value_separator = self.rules.value_separator
|
||||||
|
self.helper = JsonHelper(self.data, separator, value_separator)
|
||||||
|
debugPrint(rules_args.debug, "rules: %s" % rules_args)
|
||||||
|
debugPrint(rules_args.debug, "separator: %s" % separator)
|
||||||
|
debugPrint(rules_args.debug, "value_separator: %s" % value_separator)
|
||||||
|
self.metric_list = self.expandKeys(self.rules.metric_list)
|
||||||
|
self.key_threshold_warning = self.expandKeys(
|
||||||
|
self.rules.key_threshold_warning)
|
||||||
|
self.key_threshold_critical = self.expandKeys(
|
||||||
|
self.rules.key_threshold_critical)
|
||||||
|
self.key_value_list = self.expandKeys(self.rules.key_value_list)
|
||||||
|
self.key_value_list_not = self.expandKeys(
|
||||||
|
self.rules.key_value_list_not)
|
||||||
|
self.key_list = self.expandKeys(self.rules.key_list)
|
||||||
|
self.key_value_list_critical = self.expandKeys(
|
||||||
|
self.rules.key_value_list_critical)
|
||||||
|
self.key_value_list_not_critical = self.expandKeys(
|
||||||
|
self.rules.key_value_list_not_critical)
|
||||||
|
self.key_list_critical = self.expandKeys(self.rules.key_list_critical)
|
||||||
|
self.key_value_list_unknown = self.expandKeys(
|
||||||
|
self.rules.key_value_list_unknown)
|
||||||
|
|
||||||
def isAlive(self):
|
def expandKeys(self, src):
|
||||||
"""Return a tuple with liveness and reason for not liveness given existence, equality, and comparison rules"""
|
if src is None:
|
||||||
reason = ''
|
return []
|
||||||
|
dest = []
|
||||||
|
for key in src:
|
||||||
|
newKeys = self.helper.expandKey(key, [])
|
||||||
|
for k in newKeys:
|
||||||
|
dest.append(k)
|
||||||
|
return dest
|
||||||
|
|
||||||
if self.rules.key_list != None:
|
def checkExists(self, exists_list):
|
||||||
for k in self.rules.key_list:
|
failure = ''
|
||||||
if (self.helper.exists(k) == False):
|
for k in exists_list:
|
||||||
reason += " Key %s did not exist." % k
|
key, alias = _getKeyAlias(k)
|
||||||
|
if (self.helper.exists(key) is False):
|
||||||
|
failure += " Key %s did not exist." % alias
|
||||||
|
return failure
|
||||||
|
|
||||||
if self.rules.key_value_list != None:
|
def checkEquality(self, equality_list):
|
||||||
for kv in self.rules.key_value_list:
|
failure = ''
|
||||||
k, v = kv.split(',')
|
for kv in equality_list:
|
||||||
if (self.helper.equals(k, v) == False):
|
k, v = kv.split(',')
|
||||||
reason += " Value %s for key %s did not match." % (v, k)
|
key, alias = _getKeyAlias(k)
|
||||||
|
if not self.helper.equals(key, v):
|
||||||
|
failure += " Key %s mismatch. %s != %s" % (alias, v,
|
||||||
|
self.helper.get(key))
|
||||||
|
return failure
|
||||||
|
|
||||||
if self.rules.key_lte_list != None:
|
def checkNonEquality(self, equality_list):
|
||||||
for kv in self.rules.key_lte_list:
|
failure = ''
|
||||||
k, v = kv.split(',')
|
for kv in equality_list:
|
||||||
if (self.helper.lte(k, v) == False):
|
k, v = kv.split(',')
|
||||||
reason += " Value %s was not less than or equal to value for key %s." % (v, k)
|
key, alias = _getKeyAlias(k)
|
||||||
|
if self.helper.equals(key, v):
|
||||||
|
failure += " Key %s match found. %s == %s" % (alias, v,
|
||||||
|
self.helper.get(key))
|
||||||
|
return failure
|
||||||
|
|
||||||
if self.rules.key_gte_list != None:
|
def checkThreshold(self, key, alias, r):
|
||||||
for kv in self.rules.key_gte_list:
|
failure = ''
|
||||||
k, v = kv.split(',')
|
invert = False
|
||||||
if (self.helper.gte(k, v) == False):
|
start = 0
|
||||||
reason += " Value %s was not greater than or equal to value for key %s." % (v, k)
|
end = 'infinity'
|
||||||
|
if r.startswith('@'):
|
||||||
|
invert = True
|
||||||
|
r = r[1:]
|
||||||
|
vals = r.split(':')
|
||||||
|
if len(vals) == 1:
|
||||||
|
end = vals[0]
|
||||||
|
if len(vals) == 2:
|
||||||
|
start = vals[0]
|
||||||
|
if vals[1] != '':
|
||||||
|
end = vals[1]
|
||||||
|
if(start == '~'):
|
||||||
|
if (invert and self.helper.lte(key, end)):
|
||||||
|
failure += " Value (%s) for key %s was less than or equal to %s." % \
|
||||||
|
(self.helper.get(key), alias, end)
|
||||||
|
elif (not invert and self.helper.gt(key, end)):
|
||||||
|
failure += " Value (%s) for key %s was greater than %s." % \
|
||||||
|
(self.helper.get(key), alias, end)
|
||||||
|
elif(end == 'infinity'):
|
||||||
|
if (invert and self.helper.gte(key, start)):
|
||||||
|
failure += " Value (%s) for key %s was greater than or equal to %s." % \
|
||||||
|
(self.helper.get(key), alias, start)
|
||||||
|
elif (not invert and self.helper.lt(key, start)):
|
||||||
|
failure += " Value (%s) for key %s was less than %s." % \
|
||||||
|
(self.helper.get(key), alias, start)
|
||||||
|
else:
|
||||||
|
if (invert and self.helper.gte(key, start) and
|
||||||
|
self.helper.lte(key, end)):
|
||||||
|
failure += " Value (%s) for key %s was inside the range %s:%s." % \
|
||||||
|
(self.helper.get(key), alias, start, end)
|
||||||
|
elif (not invert and (self.helper.lt(key, start) or
|
||||||
|
self.helper.gt(key, end))):
|
||||||
|
failure += " Value (%s) for key %s was outside the range %s:%s." % \
|
||||||
|
(self.helper.get(key), alias, start, end)
|
||||||
|
|
||||||
is_alive = (reason == '')
|
return failure
|
||||||
|
|
||||||
return (is_alive, reason)
|
def checkThresholds(self, threshold_list):
|
||||||
|
failure = ''
|
||||||
|
for threshold in threshold_list:
|
||||||
|
k, r = threshold.split(',')
|
||||||
|
key, alias = _getKeyAlias(k)
|
||||||
|
failure += self.checkThreshold(key, alias, r)
|
||||||
|
return failure
|
||||||
|
|
||||||
def getMetrics(self):
|
def checkWarning(self):
|
||||||
"""Return a Nagios specific performance metrics string given keys and parameter definitions"""
|
failure = ''
|
||||||
metrics = ''
|
if self.key_threshold_warning is not None:
|
||||||
|
failure += self.checkThresholds(self.key_threshold_warning)
|
||||||
|
if self.key_value_list is not None:
|
||||||
|
failure += self.checkEquality(self.key_value_list)
|
||||||
|
if self.key_value_list_not is not None:
|
||||||
|
failure += self.checkNonEquality(self.key_value_list_not)
|
||||||
|
if self.key_list is not None:
|
||||||
|
failure += self.checkExists(self.key_list)
|
||||||
|
return failure
|
||||||
|
|
||||||
if self.rules.metric_list != None:
|
def checkCritical(self):
|
||||||
for metric in self.rules.metric_list:
|
failure = ''
|
||||||
key = metric
|
if not self.data:
|
||||||
minimum = maximum = warn_range = crit_range = 0
|
failure = " Empty JSON data."
|
||||||
uom = ''
|
if self.key_threshold_critical is not None:
|
||||||
|
failure += self.checkThresholds(self.key_threshold_critical)
|
||||||
|
if self.key_value_list_critical is not None:
|
||||||
|
failure += self.checkEquality(self.key_value_list_critical)
|
||||||
|
if self.key_value_list_not_critical is not None:
|
||||||
|
failure += self.checkNonEquality(self.key_value_list_not_critical)
|
||||||
|
if self.key_list_critical is not None:
|
||||||
|
failure += self.checkExists(self.key_list_critical)
|
||||||
|
return failure
|
||||||
|
|
||||||
if ',' in metric:
|
def checkUnknown(self):
|
||||||
vals = metric.split(',')
|
unknown = ''
|
||||||
|
if self.key_value_list_unknown is not None:
|
||||||
|
unknown += self.checkEquality(self.key_value_list_unknown)
|
||||||
|
return unknown
|
||||||
|
|
||||||
if len(vals) == 2:
|
def checkMetrics(self):
|
||||||
key,uom = vals
|
"""
|
||||||
if len(vals) == 4:
|
Return a Nagios specific performance metrics string given keys
|
||||||
key,uom,minimum,maximum = vals
|
and parameter definitions
|
||||||
if len(vals) == 6:
|
"""
|
||||||
key,uom,minimum,maximum,warn_range,crit_range = vals
|
|
||||||
|
|
||||||
if self.helper.exists(key):
|
metrics = ''
|
||||||
metrics += "'%s'=%s" % (key, self.helper.get(key))
|
warning = ''
|
||||||
if uom: metrics += uom
|
critical = ''
|
||||||
metrics += ";%s" % minimum
|
if self.metric_list is not None:
|
||||||
metrics += ";%s" % maximum
|
for metric in self.metric_list:
|
||||||
if warn_range: metrics += ";%s" % warn_range
|
key = metric
|
||||||
if crit_range: metrics += ";%s" % crit_range
|
minimum = maximum = warn_range = crit_range = None
|
||||||
|
uom = ''
|
||||||
metrics += ' '
|
if ',' in metric:
|
||||||
|
vals = metric.split(',')
|
||||||
|
if len(vals) == 2:
|
||||||
|
key, uom = vals
|
||||||
|
if len(vals) == 4:
|
||||||
|
key, uom, warn_range, crit_range = vals
|
||||||
|
if len(vals) == 6:
|
||||||
|
key, uom, warn_range, crit_range, \
|
||||||
|
minimum, maximum = vals
|
||||||
|
key, alias = _getKeyAlias(key)
|
||||||
|
if self.helper.exists(key):
|
||||||
|
metrics += "'%s'=%s" % (alias, self.helper.get(key))
|
||||||
|
if uom:
|
||||||
|
metrics += uom
|
||||||
|
if warn_range is not None:
|
||||||
|
warning += self.checkThreshold(key, alias, warn_range)
|
||||||
|
metrics += ";%s" % warn_range
|
||||||
|
if crit_range is not None:
|
||||||
|
critical += self.checkThreshold(key, alias, crit_range)
|
||||||
|
metrics += ";%s" % crit_range
|
||||||
|
if minimum is not None:
|
||||||
|
critical += self.checkThreshold(key, alias, minimum +
|
||||||
|
':')
|
||||||
|
metrics += ";%s" % minimum
|
||||||
|
if maximum is not None:
|
||||||
|
critical += self.checkThreshold(key, alias, '~:' +
|
||||||
|
maximum)
|
||||||
|
metrics += ";%s" % maximum
|
||||||
|
metrics += ' '
|
||||||
|
return ("%s" % metrics, warning, critical)
|
||||||
|
|
||||||
|
|
||||||
return "%s" % metrics
|
def parseArgs(args):
|
||||||
|
"""
|
||||||
|
CLI argument definitions and parsing
|
||||||
|
"""
|
||||||
|
|
||||||
def parseArgs():
|
parser = argparse.ArgumentParser(
|
||||||
parser = argparse.ArgumentParser(description=
|
description=plugin_description + '\n\nVersion: %s (%s)'
|
||||||
'Nagios plugin which checks json values from a given endpoint against argument specified rules\
|
%(__version__, __version_date__),
|
||||||
and determines the status and performance data for that service')
|
formatter_class=argparse.RawDescriptionHelpFormatter
|
||||||
|
)
|
||||||
|
|
||||||
parser.add_argument('-H', '--host', dest='host', required=True, help='Host.')
|
parser.add_argument('-d', '--debug', action='store_true',
|
||||||
parser.add_argument('-B', '--basic-auth', dest='auth', required=False, help='Basic auth string "username:password"')
|
help='debug mode')
|
||||||
parser.add_argument('-p', '--path', dest='path', help='Path.')
|
parser.add_argument('-v', '--verbose', action='count', default=0,
|
||||||
parser.add_argument('-e', '--key_exists', dest='key_list', nargs='*',
|
help='Verbose mode. Multiple -v options increase the verbosity')
|
||||||
help='Checks existence of these keys to determine status.')
|
|
||||||
parser.add_argument('-q', '--key_equals', dest='key_value_list', nargs='*',
|
|
||||||
help='Checks equality of these keys and values (key,value key2,value2) to determine status.')
|
|
||||||
parser.add_argument('-l', '--key_lte', dest='key_lte_list', nargs='*',
|
|
||||||
help='Checks that these keys and values (key,value key2,value2) are less than or equal to\
|
|
||||||
the returned json value to determine status.')
|
|
||||||
parser.add_argument('-g', '--key_gte', dest='key_gte_list', nargs='*',
|
|
||||||
help='Checks that these keys and values (key,value key2,value2) are greater than or equal to\
|
|
||||||
the returned json value to determine status.')
|
|
||||||
parser.add_argument('-m', '--key_metric', dest='metric_list', nargs='*',
|
|
||||||
help='Gathers the values of these keys (key,UnitOfMeasure,Min,Max,WarnRange,CriticalRange) for Nagios performance data.\
|
|
||||||
More information about Range format and units of measure for nagios can be found at https://nagios-plugins.org/doc/guidelines.html\
|
|
||||||
Additional formats for this parameter are: (key), (key,UnitOfMeasure), (key,UnitOfMeasure,Min,Max).')
|
|
||||||
parser.add_argument('-s', '--ssl', action='store_true', help='HTTPS mode.')
|
|
||||||
parser.add_argument('-f', '--field_separator', dest='separator', help='Json Field separator, defaults to "." ; Select element in an array with "(" ")"')
|
|
||||||
parser.add_argument('-d', '--debug', action='store_true', help='Debug mode.')
|
|
||||||
|
|
||||||
return parser.parse_args()
|
parser.add_argument('-s', '--ssl', action='store_true',
|
||||||
|
help='use TLS to connect to remote host')
|
||||||
|
parser.add_argument('-H', '--host', dest='host',
|
||||||
|
required=not ('-V' in args or '--version' in args),
|
||||||
|
help='remote host to query')
|
||||||
|
parser.add_argument('-k', '--insecure', action='store_true',
|
||||||
|
help='do not check server SSL certificate')
|
||||||
|
parser.add_argument('-X', '--request', dest='method', default='GET', choices=['GET', 'POST'],
|
||||||
|
help='Specifies a custom request method to use when communicating with the HTTP server')
|
||||||
|
parser.add_argument('-V', '--version', action='store_true',
|
||||||
|
help='print version of this plugin')
|
||||||
|
parser.add_argument('--cacert',
|
||||||
|
dest='cacert', help='SSL CA certificate')
|
||||||
|
parser.add_argument('--cert',
|
||||||
|
dest='cert', help='SSL client certificate')
|
||||||
|
parser.add_argument('--key', dest='key',
|
||||||
|
help='SSL client key ( if not bundled into the cert )')
|
||||||
|
parser.add_argument('-P', '--port', dest='port', help='TCP port')
|
||||||
|
parser.add_argument('-p', '--path', dest='path', help='Path')
|
||||||
|
parser.add_argument('-t', '--timeout', type=int,
|
||||||
|
help='Connection timeout (seconds)')
|
||||||
|
parser.add_argument('--unreachable-state', type=int, default=3,
|
||||||
|
help='Exit with specified code if URL unreachable. Examples: 1 for Warning, 2 for Critical, 3 for Unknown (default: 3)')
|
||||||
|
parser.add_argument('-B', '--basic-auth', dest='auth',
|
||||||
|
help='Basic auth string "username:password"')
|
||||||
|
parser.add_argument('-D', '--data', dest='data',
|
||||||
|
help='The http payload to send as a POST')
|
||||||
|
parser.add_argument('-A', '--headers', dest='headers',
|
||||||
|
help='The http headers in JSON format.')
|
||||||
|
parser.add_argument('-f', '--field_separator', dest='separator',
|
||||||
|
help='''JSON Field separator, defaults to ".";
|
||||||
|
Select element in an array with "(" ")"''')
|
||||||
|
parser.add_argument('-F', '--value_separator', dest='value_separator',
|
||||||
|
help='''JSON Value separator, defaults to ":"''')
|
||||||
|
parser.add_argument('-w', '--warning', dest='key_threshold_warning',
|
||||||
|
nargs='*',
|
||||||
|
help='''Warning threshold for these values
|
||||||
|
(key1[>alias],WarnRange key2[>alias],WarnRange).
|
||||||
|
WarnRange is in the format [@]start:end, more
|
||||||
|
information at
|
||||||
|
nagios-plugins.org/doc/guidelines.html.''')
|
||||||
|
parser.add_argument('-c', '--critical', dest='key_threshold_critical',
|
||||||
|
nargs='*',
|
||||||
|
help='''Critical threshold for these values
|
||||||
|
(key1[>alias],CriticalRange key2[>alias],CriticalRange.
|
||||||
|
CriticalRange is in the format [@]start:end, more
|
||||||
|
information at
|
||||||
|
nagios-plugins.org/doc/guidelines.html.''')
|
||||||
|
parser.add_argument('-e', '--key_exists', dest='key_list', nargs='*',
|
||||||
|
help='''Checks existence of these keys to determine
|
||||||
|
status. Return warning if key is not present.''')
|
||||||
|
parser.add_argument('-E', '--key_exists_critical',
|
||||||
|
dest='key_list_critical',
|
||||||
|
nargs='*',
|
||||||
|
help='''Same as -e but return critical if key is
|
||||||
|
not present.''')
|
||||||
|
parser.add_argument('-q', '--key_equals', dest='key_value_list', nargs='*',
|
||||||
|
help='''Checks equality of these keys and values
|
||||||
|
(key[>alias],value key2,value2) to determine status.
|
||||||
|
Multiple key values can be delimited with colon
|
||||||
|
(key,value1:value2). Return warning if equality
|
||||||
|
check fails''')
|
||||||
|
parser.add_argument('-Q', '--key_equals_critical',
|
||||||
|
dest='key_value_list_critical', nargs='*',
|
||||||
|
help='''Same as -q but return critical if
|
||||||
|
equality check fails.''')
|
||||||
|
parser.add_argument('-u', '--key_equals_unknown',
|
||||||
|
dest='key_value_list_unknown', nargs='*',
|
||||||
|
help='''Same as -q but return unknown if
|
||||||
|
equality check fails.''')
|
||||||
|
parser.add_argument('-y', '--key_not_equals',
|
||||||
|
dest='key_value_list_not', nargs='*',
|
||||||
|
help='''Checks equality of these keys and values
|
||||||
|
(key[>alias],value key2,value2) to determine status.
|
||||||
|
Multiple key values can be delimited with colon
|
||||||
|
(key,value1:value2). Return warning if equality
|
||||||
|
check succeeds''')
|
||||||
|
parser.add_argument('-Y', '--key_not_equals_critical',
|
||||||
|
dest='key_value_list_not_critical', nargs='*',
|
||||||
|
help='''Same as -q but return critical if equality
|
||||||
|
check succeeds.''')
|
||||||
|
parser.add_argument('-m', '--key_metric', dest='metric_list', nargs='*',
|
||||||
|
help='''Gathers the values of these keys (key[>alias],
|
||||||
|
UnitOfMeasure,WarnRange,CriticalRange,Min,Max) for
|
||||||
|
Nagios performance data. More information about Range
|
||||||
|
format and units of measure for nagios can be found at
|
||||||
|
nagios-plugins.org/doc/guidelines.html
|
||||||
|
Additional formats for this parameter are:
|
||||||
|
(key[>alias]), (key[>alias],UnitOfMeasure),
|
||||||
|
(key[>alias],UnitOfMeasure,WarnRange,
|
||||||
|
CriticalRange).''')
|
||||||
|
|
||||||
|
return parser.parse_args(args)
|
||||||
|
|
||||||
|
|
||||||
|
def debugPrint(debug_flag, message):
|
||||||
|
"""
|
||||||
|
Print debug messages if -d is set.
|
||||||
|
"""
|
||||||
|
if not debug_flag:
|
||||||
|
return
|
||||||
|
|
||||||
|
print(message)
|
||||||
|
|
||||||
|
def verbosePrint(verbose_flag, when, message):
|
||||||
|
"""
|
||||||
|
Print verbose messages if -v is set.
|
||||||
|
Since -v can be used multiple times, the when parameter sets the required amount before printing
|
||||||
|
"""
|
||||||
|
if not verbose_flag:
|
||||||
|
return
|
||||||
|
if verbose_flag >= when:
|
||||||
|
print(message)
|
||||||
|
|
||||||
|
def prepare_context(args):
|
||||||
|
"""
|
||||||
|
Prepare TLS Context
|
||||||
|
"""
|
||||||
|
nagios = NagiosHelper()
|
||||||
|
|
||||||
|
context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
|
||||||
|
context.options |= ssl.OP_NO_SSLv2
|
||||||
|
context.options |= ssl.OP_NO_SSLv3
|
||||||
|
|
||||||
|
if args.insecure:
|
||||||
|
context.check_hostname = False
|
||||||
|
context.verify_mode = ssl.CERT_NONE
|
||||||
|
else:
|
||||||
|
context.verify_mode = ssl.CERT_OPTIONAL
|
||||||
|
context.load_default_certs()
|
||||||
|
if args.cacert:
|
||||||
|
try:
|
||||||
|
context.load_verify_locations(args.cacert)
|
||||||
|
except ssl.SSLError:
|
||||||
|
nagios.append_message(UNKNOWN_CODE, 'Error loading SSL CA cert "%s"!' % args.cacert)
|
||||||
|
if args.cert:
|
||||||
|
try:
|
||||||
|
context.load_cert_chain(args.cert, keyfile=args.key)
|
||||||
|
except ssl.SSLError:
|
||||||
|
if args.key:
|
||||||
|
nagios.append_message(UNKNOWN_CODE, 'Error loading SSL cert. Make sure key "%s" belongs to cert "%s"!' % (args.key, args.cert))
|
||||||
|
else:
|
||||||
|
nagios.append_message(UNKNOWN_CODE, 'Error loading SSL cert. Make sure "%s" contains the key as well!' % (args.cert))
|
||||||
|
|
||||||
|
if nagios.getCode() != OK_CODE:
|
||||||
|
print(nagios.getMessage())
|
||||||
|
sys.exit(nagios.getCode())
|
||||||
|
|
||||||
|
return context
|
||||||
|
|
||||||
|
|
||||||
|
def make_request(args, url, context):
|
||||||
|
"""
|
||||||
|
Performs the actual request to the given URL
|
||||||
|
"""
|
||||||
|
req = urllib.request.Request(url, method=args.method)
|
||||||
|
req.add_header("User-Agent", "check_http_json")
|
||||||
|
if args.auth:
|
||||||
|
authbytes = str(args.auth).encode()
|
||||||
|
base64str = base64.encodebytes(authbytes).decode().replace('\n', '')
|
||||||
|
req.add_header('Authorization', 'Basic %s' % base64str)
|
||||||
|
if args.headers:
|
||||||
|
headers = json.loads(args.headers)
|
||||||
|
debugPrint(args.debug, "Headers:\n %s" % headers)
|
||||||
|
for header in headers:
|
||||||
|
req.add_header(header, headers[header])
|
||||||
|
if args.timeout and args.data:
|
||||||
|
databytes = str(args.data).encode()
|
||||||
|
response = urllib.request.urlopen(req, timeout=args.timeout,
|
||||||
|
data=databytes, context=context)
|
||||||
|
elif args.timeout:
|
||||||
|
response = urllib.request.urlopen(req, timeout=args.timeout,
|
||||||
|
context=context)
|
||||||
|
elif args.data:
|
||||||
|
databytes = str(args.data).encode()
|
||||||
|
response = urllib.request.urlopen(req, data=databytes, context=context)
|
||||||
|
else:
|
||||||
|
# pylint: disable=consider-using-with
|
||||||
|
response = urllib.request.urlopen(req, context=context)
|
||||||
|
|
||||||
|
return response.read()
|
||||||
|
|
||||||
|
|
||||||
|
def main(cliargs):
|
||||||
|
"""
|
||||||
|
Main entrypoint for CLI
|
||||||
|
"""
|
||||||
|
|
||||||
|
args = parseArgs(cliargs)
|
||||||
|
nagios = NagiosHelper()
|
||||||
|
context = None
|
||||||
|
|
||||||
|
if args.version:
|
||||||
|
print('Version: %s - Date: %s' % (__version__, __version_date__))
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
|
if args.ssl:
|
||||||
|
url = "https://%s" % args.host
|
||||||
|
context = prepare_context(args)
|
||||||
|
else:
|
||||||
|
url = "http://%s" % args.host
|
||||||
|
if args.port:
|
||||||
|
url += ":%s" % args.port
|
||||||
|
if args.path:
|
||||||
|
url += "/%s" % args.path
|
||||||
|
|
||||||
|
debugPrint(args.debug, "url: %s" % url)
|
||||||
|
json_data = ''
|
||||||
|
|
||||||
|
try:
|
||||||
|
json_data = make_request(args, url, context)
|
||||||
|
except HTTPError as e:
|
||||||
|
# Try to recover from HTTP Error, if there is JSON in the response
|
||||||
|
if "json" in e.info().get_content_subtype():
|
||||||
|
json_data = e.read()
|
||||||
|
else:
|
||||||
|
nagios.append_message(UNKNOWN_CODE, " Could not find JSON in HTTP body. HTTPError[%s], url:%s" % (str(e.code), url))
|
||||||
|
except URLError as e:
|
||||||
|
# Some users might prefer another exit code if the URL wasn't reached
|
||||||
|
exit_code = args.unreachable_state
|
||||||
|
nagios.append_message(exit_code, " URLError[%s], url:%s" % (str(e.reason), url))
|
||||||
|
# Since we don't got any data, we can simply exit
|
||||||
|
print(nagios.getMessage())
|
||||||
|
sys.exit(nagios.getCode())
|
||||||
|
|
||||||
|
try:
|
||||||
|
data = json.loads(json_data)
|
||||||
|
except ValueError as e:
|
||||||
|
nagios.append_message(UNKNOWN_CODE, " JSON Parser error: %s" % str(e))
|
||||||
|
else:
|
||||||
|
verbosePrint(args.verbose, 1, json.dumps(data, indent=2))
|
||||||
|
# Apply rules to returned JSON data
|
||||||
|
processor = JsonRuleProcessor(data, args)
|
||||||
|
nagios.append_message(WARNING_CODE, processor.checkWarning())
|
||||||
|
nagios.append_message(CRITICAL_CODE, processor.checkCritical())
|
||||||
|
nagios.append_metrics(processor.checkMetrics())
|
||||||
|
nagios.append_message(UNKNOWN_CODE, processor.checkUnknown())
|
||||||
|
|
||||||
|
# Print Nagios specific string and exit appropriately
|
||||||
|
print(nagios.getMessage())
|
||||||
|
sys.exit(nagios.getCode())
|
||||||
|
|
||||||
def debugPrint(debug_flag, message, pretty_flag=False):
|
|
||||||
if debug_flag:
|
|
||||||
if pretty_flag:
|
|
||||||
pprint(message)
|
|
||||||
else:
|
|
||||||
print message
|
|
||||||
|
|
||||||
"""Program entry point"""
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
args = parseArgs()
|
# Program entry point
|
||||||
nagios = NagiosHelper()
|
main(sys.argv[1:])
|
||||||
|
|
||||||
if args.ssl:
|
#EOF
|
||||||
url = "https://%s" % args.host
|
|
||||||
else:
|
|
||||||
url = "http://%s" % args.host
|
|
||||||
|
|
||||||
if args.path: url += "/%s" % args.path
|
|
||||||
debugPrint(args.debug, "url:%s" % url)
|
|
||||||
|
|
||||||
# Attempt to reach the endpoint
|
|
||||||
try:
|
|
||||||
req = urllib2.Request(url)
|
|
||||||
if args.auth:
|
|
||||||
base64str = base64.encodestring(args.auth).replace('\n', '')
|
|
||||||
req.add_header('Authorization', 'Basic %s' % base64str)
|
|
||||||
response = urllib2.urlopen(req)
|
|
||||||
except HTTPError as e:
|
|
||||||
nagios.unknown("HTTPError[%s], url:%s" % (str(e.code), url))
|
|
||||||
except URLError as e:
|
|
||||||
nagios.critical("URLError[%s], url:%s" % (str(e.reason), url))
|
|
||||||
else:
|
|
||||||
jsondata = response.read()
|
|
||||||
data = json.loads(jsondata)
|
|
||||||
|
|
||||||
debugPrint(args.debug, 'json:')
|
|
||||||
debugPrint(args.debug, data, True)
|
|
||||||
|
|
||||||
# Apply rules to returned JSON data
|
|
||||||
processor = JsonRuleProcessor(data, args)
|
|
||||||
is_alive, reason = processor.isAlive()
|
|
||||||
|
|
||||||
if is_alive:
|
|
||||||
# Rules all passed, attempt to get performance data
|
|
||||||
nagios.performance_data = processor.getMetrics()
|
|
||||||
nagios.ok("Status OK.")
|
|
||||||
else:
|
|
||||||
nagios.warning("Status check failed, reason:%s" % reason)
|
|
||||||
|
|
||||||
# Print Nagios specific string and exit appropriately
|
|
||||||
print nagios.getMessage()
|
|
||||||
exit(nagios.code)
|
|
||||||
|
|||||||
106
contrib/icinga2_check_command_definition.conf
Normal file
106
contrib/icinga2_check_command_definition.conf
Normal file
@@ -0,0 +1,106 @@
|
|||||||
|
object CheckCommand "http_json" {
|
||||||
|
import "plugin-check-command"
|
||||||
|
|
||||||
|
command = [ PluginDir + "/check_http_json.py" ]
|
||||||
|
|
||||||
|
arguments = {
|
||||||
|
"--host" = {
|
||||||
|
value = "$address$"
|
||||||
|
description = "Hostname or address of the interface to query"
|
||||||
|
required = true
|
||||||
|
}
|
||||||
|
"--port" = {
|
||||||
|
value = "$http_json_port$"
|
||||||
|
description = "TCP port number"
|
||||||
|
}
|
||||||
|
"--path" = {
|
||||||
|
value = "$http_json_path$"
|
||||||
|
description = "URL path to query (i.e.: /v1/service/xyz)"
|
||||||
|
}
|
||||||
|
"--timeout" = {
|
||||||
|
value = "$http_json_timeout$"
|
||||||
|
description = "Connection timeout (seconds)"
|
||||||
|
}
|
||||||
|
"--basic-auth" = {
|
||||||
|
value = "$http_json_basic_auth$"
|
||||||
|
description = "Basic auth string 'username:password'"
|
||||||
|
}
|
||||||
|
"--ssl" = {
|
||||||
|
set_if = "$http_json_ssl$"
|
||||||
|
description = "use TLS to connect to remote host"
|
||||||
|
}
|
||||||
|
"--insecure" = {
|
||||||
|
set_if = "$http_json_insecure$"
|
||||||
|
description = "do not check server SSL certificate"
|
||||||
|
}
|
||||||
|
"--cacert" = {
|
||||||
|
value = "$http_json_cacert_file$"
|
||||||
|
description = "path of cacert file to validate server cert"
|
||||||
|
}
|
||||||
|
"--cert" = {
|
||||||
|
value = "$http_json_cert_file$"
|
||||||
|
description = "client certificate in PEM format"
|
||||||
|
}
|
||||||
|
"--key" = {
|
||||||
|
value = "$http_json_key_file$"
|
||||||
|
description = "client certificate key file in PEM format ( if not bundled into the cert )"
|
||||||
|
}
|
||||||
|
"--data" = {
|
||||||
|
value = "$http_json_post_data$"
|
||||||
|
description = "the http payload to send as a POST"
|
||||||
|
}
|
||||||
|
"--headers" = {
|
||||||
|
value = "$http_json_headers$"
|
||||||
|
description = "additional http headers in JSON format to send with the request"
|
||||||
|
}
|
||||||
|
"--field_separator" = {
|
||||||
|
value = "$http_json_field_separator$"
|
||||||
|
description = "JSON Field separator, defaults to '.'; Select element in an array with '(' ')'"
|
||||||
|
}
|
||||||
|
"--value_separator" = {
|
||||||
|
value = "$http_json_value_separator$"
|
||||||
|
description = "JSON Value separator, defaults to ':'"
|
||||||
|
}
|
||||||
|
"--warning" = {
|
||||||
|
value = "$http_json_warning$"
|
||||||
|
description = "Warning threshold for these values, WarningRange is in the format [@]start:end"
|
||||||
|
}
|
||||||
|
"--critical" = {
|
||||||
|
value = "$http_json_critical$"
|
||||||
|
description = "Critical threshold for these values, CriticalRange is in the format [@]start:end"
|
||||||
|
}
|
||||||
|
"--key_exists" = {
|
||||||
|
value = "$http_json_key_exists$"
|
||||||
|
description = "Checks existence of these keys to determine status. Return warning if key is not present."
|
||||||
|
}
|
||||||
|
"--key_exists_critical" = {
|
||||||
|
value = "$http_json_key_exists_critical$"
|
||||||
|
description = "Checks existence of these keys to determine status. Return critical if key is not present."
|
||||||
|
}
|
||||||
|
"--key_equals" = {
|
||||||
|
value = "$http_json_key_equals$"
|
||||||
|
description = "Checks equality of these keys and values. Return warning if equality check fails"
|
||||||
|
}
|
||||||
|
"--key_equals_critical" = {
|
||||||
|
value = "$http_json_key_equals_critical$"
|
||||||
|
description = "Checks equality of these keys and values. Return critical if equality check fails"
|
||||||
|
}
|
||||||
|
"--key_equals_unknown" = {
|
||||||
|
value = "$http_json_key_equals_unknown$"
|
||||||
|
description = "Checks equality of these keys and values. Return unknown if equality check fails"
|
||||||
|
}
|
||||||
|
"--key_not_equals" = {
|
||||||
|
value = "$http_json_key_not_equals$"
|
||||||
|
description = "Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values can be delimited with colon (key,value1:value2). Return warning if equality check succeeds."
|
||||||
|
}
|
||||||
|
"--key_not_equals_critical" = {
|
||||||
|
value = "$http_json_key_not_equals_critical$"
|
||||||
|
description = "Checks equality of these keys and values (key[>alias],value key2,value2) to determine status. Multiple key values can be delimited with colon (key,value1:value2). Return critical if equality check succeeds."
|
||||||
|
}
|
||||||
|
"--key_metric" = {
|
||||||
|
value = "$http_json_key_metric$"
|
||||||
|
description = "Gathers the values of these keys"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
115
docs/DOCKER.md
Normal file
115
docs/DOCKER.md
Normal file
@@ -0,0 +1,115 @@
|
|||||||
|
### Docker Info Example Plugin
|
||||||
|
|
||||||
|
#### Description
|
||||||
|
|
||||||
|
Let's say we want to use `check_http_json.py` to read from Docker's `/info` HTTP API endpoint with the following parameters:
|
||||||
|
|
||||||
|
##### Connection information
|
||||||
|
|
||||||
|
* Host = 127.0.0.1:4243
|
||||||
|
* Path = /info
|
||||||
|
|
||||||
|
##### Rules for "aliveness"
|
||||||
|
|
||||||
|
* Verify that the key `Containers` exists in the outputted JSON
|
||||||
|
* Verify that the key `IPv4Forwarding` has a value of `1`
|
||||||
|
* Verify that the key `Debug` has a value less than or equal to `2`
|
||||||
|
* Verify that the key `Images` has a value greater than or equal to `1`
|
||||||
|
* If any of these criteria are not met, report a WARNING to Nagios
|
||||||
|
|
||||||
|
##### Gather Metrics
|
||||||
|
|
||||||
|
* Report value of the key `Containers` with a MinValue of 0 and a MaxValue of 1000 as performance data
|
||||||
|
* Report value of the key `Images` as performance data
|
||||||
|
* Report value of the key `NEventsListener` as performance data
|
||||||
|
* Report value of the key `NFd` as performance data
|
||||||
|
* Report value of the key `NGoroutines` as performance data
|
||||||
|
* Report value of the key `SwapLimit` as performance data
|
||||||
|
|
||||||
|
#### Service Definition
|
||||||
|
|
||||||
|
`localhost.cfg`
|
||||||
|
|
||||||
|
```
|
||||||
|
define service {
|
||||||
|
use local-service
|
||||||
|
host_name localhost
|
||||||
|
service_description Docker info status checker
|
||||||
|
check_command check_docker
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Command Definition with Arguments
|
||||||
|
|
||||||
|
`commands.cfg`
|
||||||
|
|
||||||
|
```
|
||||||
|
define command{
|
||||||
|
command_name check_docker
|
||||||
|
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p info -e Containers -q IPv4Forwarding,1 -w Debug,2:2 -c Images,1:1 -m Containers,0:250,0:500,0,1000 Images NEventsListener NFd NGoroutines SwapLimit
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.|'Containers'=1;0;1000 'Images'=11;0;0 'NEventsListener'=3;0;0 'NFd'=10;0;0 'NGoroutines'=14;0;0 'SwapLimit'=1;0;0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker Container Monitor Example Plugin
|
||||||
|
|
||||||
|
`check_http_json.py` is generic enough to read and evaluate rules on any HTTP endpoint that returns JSON. In this example we'll get the status of a specific container using it's ID which camn be found by using the list containers endpoint (`curl http://127.0.0.1:4243/containers/json?all=1`).
|
||||||
|
|
||||||
|
##### Connection information
|
||||||
|
|
||||||
|
* Host = 127.0.0.1:4243
|
||||||
|
* Path = /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json
|
||||||
|
|
||||||
|
##### Rules for "aliveness"
|
||||||
|
|
||||||
|
* Verify that the key `ID` exists and is equal to the value `2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615`
|
||||||
|
* Verify that the key `State.Running` has a value of `True`
|
||||||
|
|
||||||
|
#### Service Definition
|
||||||
|
|
||||||
|
`localhost.cfg`
|
||||||
|
|
||||||
|
```
|
||||||
|
define service {
|
||||||
|
use local-service
|
||||||
|
host_name localhost
|
||||||
|
service_description Docker container liveness check
|
||||||
|
check_command check_my_container
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Command Definition with Arguments
|
||||||
|
|
||||||
|
`commands.cfg`
|
||||||
|
|
||||||
|
```
|
||||||
|
define command{
|
||||||
|
command_name check_my_container
|
||||||
|
command_line /usr/bin/python /usr/local/nagios/libexec/plugins/check_http_json.py -H 127.0.0.1:4243 -p /containers/2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615/json -q ID,2356e8ccb3de8308ccb16cf8f5d157bc85ded5c3d8327b0dfb11818222b6f615 State.Running,True
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
WARNING: Status check failed, reason: Value True for key State.Running did not match.
|
||||||
|
```
|
||||||
|
|
||||||
|
The plugin threw a warning because the Container ID I used on my system has the following State object:
|
||||||
|
|
||||||
|
```
|
||||||
|
u'State': {...
|
||||||
|
u'Running': False,
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
If I change the command to have the parameter -q parameter `State.Running,False`, the output becomes:
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.
|
||||||
|
```
|
||||||
227
docs/RIAK.md
Normal file
227
docs/RIAK.md
Normal file
@@ -0,0 +1,227 @@
|
|||||||
|
# Riak Stats Example
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
|
For this example we're going to use `check_http_json.py` as a pure CLI tool to read Riak's `/stats` endpoint
|
||||||
|
|
||||||
|
## Connection information
|
||||||
|
|
||||||
|
* Host = 127.0.0.1:8098
|
||||||
|
* Path = /stats
|
||||||
|
|
||||||
|
## JSON Stats Data
|
||||||
|
|
||||||
|
* Full Riak HTTP Stats information can be found here: [http://docs.basho.com/riak/latest/dev/references/http/status/](http://docs.basho.com/riak/latest/dev/references/http/status/)
|
||||||
|
* Information related to specific interesting stats can be found here: [http://docs.basho.com/riak/latest/ops/running/stats-and-monitoring/](http://docs.basho.com/riak/latest/ops/running/stats-and-monitoring/)
|
||||||
|
|
||||||
|
## Connectivity Check
|
||||||
|
|
||||||
|
* `ring_members`: We can use an existence check to monitor the number of ring members
|
||||||
|
* `connected_nodes`: Similarly we can check the number of nodes that are in communication with this node, but this list will be empty in a 1 node cluster
|
||||||
|
|
||||||
|
#### Sample Command
|
||||||
|
|
||||||
|
For a single node dev "cluster", you might have a `ring_members` value like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
"ring_members": [
|
||||||
|
"riak@127.0.0.1"
|
||||||
|
],
|
||||||
|
```
|
||||||
|
|
||||||
|
To validate that we have a single node, we can use this check:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./check_http_json.py -H localhost -P 8098 -p stats -E "ring_members(0)"
|
||||||
|
OK: Status OK.
|
||||||
|
```
|
||||||
|
|
||||||
|
If we were expecting at least 2 nodes in the cluster, we would use this check:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./check_http_json.py -H localhost -P 8098 -p stats -E "ring_members(1)"
|
||||||
|
CRITICAL: Status CRITICAL. Key ring_members(1) did not exist.
|
||||||
|
```
|
||||||
|
|
||||||
|
Obviously this fails because we only had a single `ring_member`. If we prefer to only get a warning instead of a critical for this check, we just use the correct flag:
|
||||||
|
|
||||||
|
```
|
||||||
|
$ ./check_http_json.py -H localhost -P 8098 -p stats -e "ring_members(1)"
|
||||||
|
WARNING: Status WARNING. Key ring_members(1) did not exist.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gather Metrics
|
||||||
|
|
||||||
|
The thresholds for acceptable values for these metrics will vary from system to system, following are the stats we'll be checking:
|
||||||
|
|
||||||
|
### Throughput Metrics:
|
||||||
|
|
||||||
|
* `node_gets`
|
||||||
|
* `node_puts`
|
||||||
|
* `vnode_counter_update`
|
||||||
|
* `vnode_set_update`
|
||||||
|
* `vnode_map_update`
|
||||||
|
* `search_query_throughput_one`
|
||||||
|
* `search_index_throughtput_one`
|
||||||
|
* `consistent_gets`
|
||||||
|
* `consistent_puts`
|
||||||
|
* `vnode_index_reads`
|
||||||
|
|
||||||
|
#### Sample Command
|
||||||
|
|
||||||
|
```
|
||||||
|
./check_http_json.py -H localhost -P 8098 -p stats -m \
|
||||||
|
"node_gets" \
|
||||||
|
"node_puts" \
|
||||||
|
"vnode_counter_update" \
|
||||||
|
"vnode_set_update" \
|
||||||
|
"vnode_map_update" \
|
||||||
|
"search_query_throughput_one" \
|
||||||
|
"search_index_throughtput_one" \
|
||||||
|
"consistent_gets" \
|
||||||
|
"consistent_puts" \
|
||||||
|
"vnode_index_reads"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.|'node_gets'=0 'node_puts'=0 'vnode_counter_update'=0 'vnode_set_update'=0 'vnode_map_update'=0 'search_query_throughput_one'=0 'consistent_gets'=0 'consistent_puts'=0 'vnode_index_reads'=0
|
||||||
|
```
|
||||||
|
|
||||||
|
### Latency Metrics:
|
||||||
|
|
||||||
|
* `node_get_fsm_time_mean,_median,_95,_99,_100`
|
||||||
|
* `node_put_fsm_time_mean,_median,_95,_99,_100`
|
||||||
|
* `object_counter_merge_time_mean,_median,_95,_99,_100`
|
||||||
|
* `object_set_merge_time_mean,_median,_95,_99,_100`
|
||||||
|
* `object_map_merge_time_mean,_median,_95,_99,_100`
|
||||||
|
* `search_query_latency_median,_min,_95,_99,_999`
|
||||||
|
* `search_index_latency_median,_min,_95,_99,_999`
|
||||||
|
* `consistent_get_time_mean,_median,_95,_99,_100`
|
||||||
|
* `consistent_put_time_mean,_median,_95,_99,_100`
|
||||||
|
|
||||||
|
#### Sample Command
|
||||||
|
|
||||||
|
```
|
||||||
|
./check_http_json.py -H localhost -P 8098 -p stats -m \
|
||||||
|
"node_get_fsm_time_mean,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_time_median,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_time_95,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_time_99,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_time_100,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_time_mean,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_time_median,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_time_95,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_time_99,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_time_100,,0:100,0:1000" \
|
||||||
|
"object_counter_merge_time_mean,,0:100,0:1000" \
|
||||||
|
"object_counter_merge_time_median,,0:100,0:1000" \
|
||||||
|
"object_counter_merge_time_95,,0:100,0:1000" \
|
||||||
|
"object_counter_merge_time_99,,0:100,0:1000" \
|
||||||
|
"object_counter_merge_time_100,,0:100,0:1000" \
|
||||||
|
"object_set_merge_time_mean,,0:100,0:1000" \
|
||||||
|
"object_set_merge_time_median,,0:100,0:1000" \
|
||||||
|
"object_set_merge_time_95,,0:100,0:1000" \
|
||||||
|
"object_set_merge_time_99,,0:100,0:1000" \
|
||||||
|
"object_set_merge_time_100,,0:100,0:1000" \
|
||||||
|
"object_map_merge_time_mean,,0:100,0:1000" \
|
||||||
|
"object_map_merge_time_median,,0:100,0:1000" \
|
||||||
|
"object_map_merge_time_95,,0:100,0:1000" \
|
||||||
|
"object_map_merge_time_99,,0:100,0:1000" \
|
||||||
|
"object_map_merge_time_100,,0:100,0:1000" \
|
||||||
|
"consistent_get_time_mean,,0:100,0:1000" \
|
||||||
|
"consistent_get_time_median,,0:100,0:1000" \
|
||||||
|
"consistent_get_time_95,,0:100,0:1000" \
|
||||||
|
"consistent_get_time_99,,0:100,0:1000" \
|
||||||
|
"consistent_get_time_100,,0:100,0:1000" \
|
||||||
|
"consistent_put_time_mean,,0:100,0:1000" \
|
||||||
|
"consistent_put_time_median,,0:100,0:1000" \
|
||||||
|
"consistent_put_time_95,,0:100,0:1000" \
|
||||||
|
"consistent_put_time_99,,0:100,0:1000" \
|
||||||
|
"consistent_put_time_100,,0:100,0:1000" \
|
||||||
|
"search_query_latency_median,,0:100,0:1000" \
|
||||||
|
"search_query_latency_min,,0:100,0:1000" \
|
||||||
|
"search_query_latency_95,,0:100,0:1000" \
|
||||||
|
"search_query_latency_99,,0:100,0:1000" \
|
||||||
|
"search_query_latency_999,,0:100,0:1000" \
|
||||||
|
"search_index_latency_median,,0:100,0:1000" \
|
||||||
|
"search_index_latency_min,,0:100,0:1000" \
|
||||||
|
"search_index_latency_95,,0:100,0:1000" \
|
||||||
|
"search_index_latency_99,,0:100,0:1000" \
|
||||||
|
"search_index_latency_999,,0:100,0:1000"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.|'node_get_fsm_time_mean'=0;0:100;0:1000 'node_get_fsm_time_median'=0;0:100;0:1000 'node_get_fsm_time_95'=0;0:100;0:1000 'node_get_fsm_time_99'=0;0:100;0:1000 'node_get_fsm_time_100'=0;0:100;0:1000 'node_put_fsm_time_mean'=0;0:100;0:1000 'node_put_fsm_time_median'=0;0:100;0:1000 'node_put_fsm_time_95'=0;0:100;0:1000 'node_put_fsm_time_99'=0;0:100;0:1000 'node_put_fsm_time_100'=0;0:100;0:1000 'object_counter_merge_time_mean'=0;0:100;0:1000 'object_counter_merge_time_median'=0;0:100;0:1000 'object_counter_merge_time_95'=0;0:100;0:1000 'object_counter_merge_time_99'=0;0:100;0:1000 'object_counter_merge_time_100'=0;0:100;0:1000 'object_set_merge_time_mean'=0;0:100;0:1000 'object_set_merge_time_median'=0;0:100;0:1000 'object_set_merge_time_95'=0;0:100;0:1000 'object_set_merge_time_99'=0;0:100;0:1000 'object_set_merge_time_100'=0;0:100;0:1000 'object_map_merge_time_mean'=0;0:100;0:1000 'object_map_merge_time_median'=0;0:100;0:1000 'object_map_merge_time_95'=0;0:100;0:1000 'object_map_merge_time_99'=0;0:100;0:1000 'object_map_merge_time_100'=0;0:100;0:1000 'consistent_get_time_mean'=0;0:100;0:1000 'consistent_get_time_median'=0;0:100;0:1000 'consistent_get_time_95'=0;0:100;0:1000 'consistent_get_time_99'=0;0:100;0:1000 'consistent_get_time_100'=0;0:100;0:1000 'consistent_put_time_mean'=0;0:100;0:1000 'consistent_put_time_median'=0;0:100;0:1000 'consistent_put_time_95'=0;0:100;0:1000 'consistent_put_time_99'=0;0:100;0:1000 'consistent_put_time_100'=0;0:100;0:1000 'search_query_latency_median'=0;0:100;0:1000 'search_query_latency_min'=0;0:100;0:1000 'search_query_latency_95'=0;0:100;0:1000 'search_query_latency_99'=0;0:100;0:1000 'search_query_latency_999'=0;0:100;0:1000 'search_index_latency_median'=0;0:100;0:1000 'search_index_latency_min'=0;0:100;0:1000 'search_index_latency_95'=0;0:100;0:1000 'search_index_latency_99'=0;0:100;0:1000 'search_index_latency_999'=0;0:100;0:1000
|
||||||
|
```
|
||||||
|
|
||||||
|
### Erlang Resource Usage Metrics:
|
||||||
|
|
||||||
|
* `sys_process_count`
|
||||||
|
* `memory_processes`
|
||||||
|
* `memory_processes_used`
|
||||||
|
|
||||||
|
#### Sample Command
|
||||||
|
|
||||||
|
```
|
||||||
|
./check_http_json.py -H localhost -P 8098 -p stats -m \
|
||||||
|
"sys_process_count,,0:5000,0:10000" \
|
||||||
|
"memory_processes,,0:50000000,0:100000000" \
|
||||||
|
"memory_processes_used,,0:50000000,0:100000000"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.|'sys_process_count'=1637;0:5000;0:10000 'memory_processes'=46481112;0:50000000;0:100000000 'memory_processes_used'=46476880;0:50000000;0:100000000
|
||||||
|
```
|
||||||
|
|
||||||
|
### General Riak Load / Health Metrics:
|
||||||
|
|
||||||
|
* `node_get_fsm_siblings_mean,_median,_95,_99,_100`
|
||||||
|
* `node_get_fsm_objsize_mean,_median,_95,_99,_100`
|
||||||
|
* `riak_search_vnodeq_mean,_median,_95,_99,_100`
|
||||||
|
* `search_index_fail_one`
|
||||||
|
* `pbc_active`
|
||||||
|
* `pbc_connects`
|
||||||
|
* `read_repairs`
|
||||||
|
* `list_fsm_active`
|
||||||
|
* `node_get_fsm_rejected`
|
||||||
|
* `node_put_fsm_rejected`
|
||||||
|
|
||||||
|
#### Sample Command
|
||||||
|
|
||||||
|
```
|
||||||
|
./check_http_json.py -H localhost -P 8098 -p stats -m \
|
||||||
|
"node_get_fsm_siblings_mean,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_siblings_median,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_siblings_95,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_siblings_99,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_siblings_100,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_objsize_mean,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_objsize_median,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_objsize_95,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_objsize_99,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_objsize_100,,0:100,0:1000" \
|
||||||
|
"riak_search_vnodeq_mean,,0:100,0:1000" \
|
||||||
|
"riak_search_vnodeq_median,,0:100,0:1000" \
|
||||||
|
"riak_search_vnodeq_95,,0:100,0:1000" \
|
||||||
|
"riak_search_vnodeq_99,,0:100,0:1000" \
|
||||||
|
"riak_search_vnodeq_100,,0:100,0:1000" \
|
||||||
|
"search_index_fail_one,,0:100,0:1000" \
|
||||||
|
"pbc_active,,0:100,0:1000" \
|
||||||
|
"pbc_connects,,0:100,0:1000" \
|
||||||
|
"read_repairs,,0:100,0:1000" \
|
||||||
|
"list_fsm_active,,0:100,0:1000" \
|
||||||
|
"node_get_fsm_rejected,,0:100,0:1000" \
|
||||||
|
"node_put_fsm_rejected,,0:100,0:1000"
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Sample Output
|
||||||
|
|
||||||
|
```
|
||||||
|
OK: Status OK.|'node_get_fsm_siblings_mean'=0;0:100;0:1000 'node_get_fsm_siblings_median'=0;0:100;0:1000 'node_get_fsm_siblings_95'=0;0:100;0:1000 'node_get_fsm_siblings_99'=0;0:100;0:1000 'node_get_fsm_siblings_100'=0;0:100;0:1000 'node_get_fsm_objsize_mean'=0;0:100;0:1000 'node_get_fsm_objsize_median'=0;0:100;0:1000 'node_get_fsm_objsize_95'=0;0:100;0:1000 'node_get_fsm_objsize_99'=0;0:100;0:1000 'node_get_fsm_objsize_100'=0;0:100;0:1000 'search_index_fail_one'=0;0:100;0:1000 'pbc_active'=0;0:100;0:1000 'pbc_connects'=0;0:100;0:1000 'read_repairs'=0;0:100;0:1000 'list_fsm_active'=0;0:100;0:1000 'node_get_fsm_rejected'=0;0:100;0:1000 'node_put_fsm_rejected'=0;0:100;0:1000
|
||||||
|
```
|
||||||
2
requirements-dev.txt
Normal file
2
requirements-dev.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
coverage==6.5.0
|
||||||
|
pylint==2.17.7
|
||||||
0
test/__init__.py
Normal file
0
test/__init__.py
Normal file
2
test/requirements.txt
Normal file
2
test/requirements.txt
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
coverage==5.0.3
|
||||||
|
pylint==2.4.4
|
||||||
34
test/test_args.py
Normal file
34
test/test_args.py
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.append('..')
|
||||||
|
|
||||||
|
from check_http_json import *
|
||||||
|
|
||||||
|
|
||||||
|
class ArgsTest(unittest.TestCase):
|
||||||
|
"""
|
||||||
|
Tests for argsparse
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_parser_defaults(self):
|
||||||
|
parser = parseArgs(['-H', 'foobar'])
|
||||||
|
self.assertFalse(parser.debug)
|
||||||
|
self.assertFalse(parser.ssl)
|
||||||
|
self.assertFalse(parser.insecure)
|
||||||
|
|
||||||
|
def test_parser_with_debug(self):
|
||||||
|
parser = parseArgs(['-H', 'foobar', '-d'])
|
||||||
|
self.assertTrue(parser.debug)
|
||||||
|
|
||||||
|
def test_parser_with_port(self):
|
||||||
|
parser = parseArgs(['-H', 'foobar', '-P', '8888'])
|
||||||
|
self.assertEqual(parser.port, '8888')
|
||||||
|
|
||||||
|
def test_parser_with_separator(self):
|
||||||
|
parser = parseArgs(['-H', 'foobar', '-f', '_', '-F', '_'])
|
||||||
|
self.assertEqual(parser.separator, '_')
|
||||||
|
self.assertEqual(parser.value_separator, '_')
|
||||||
304
test/test_check_http_json.py
Normal file
304
test/test_check_http_json.py
Normal file
@@ -0,0 +1,304 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
|
||||||
|
import json
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.append('..')
|
||||||
|
|
||||||
|
from check_http_json import *
|
||||||
|
|
||||||
|
|
||||||
|
OK_CODE = 0
|
||||||
|
WARNING_CODE = 1
|
||||||
|
CRITICAL_CODE = 2
|
||||||
|
UNKNOWN_CODE = 3
|
||||||
|
|
||||||
|
|
||||||
|
class RulesHelper:
|
||||||
|
separator = '.'
|
||||||
|
value_separator = ':'
|
||||||
|
debug = False
|
||||||
|
key_threshold_warning = None
|
||||||
|
key_value_list = None
|
||||||
|
key_value_list_not = None
|
||||||
|
key_list = None
|
||||||
|
key_threshold_critical = None
|
||||||
|
key_value_list_critical = None
|
||||||
|
key_value_list_not_critical = None
|
||||||
|
key_value_list_unknown = None
|
||||||
|
key_list_critical = None
|
||||||
|
metric_list = None
|
||||||
|
|
||||||
|
def dash_m(self, data):
|
||||||
|
self.metric_list = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_e(self, data):
|
||||||
|
self.key_list = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_E(self, data):
|
||||||
|
self.key_list_critical = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_q(self, data):
|
||||||
|
self.key_value_list = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_Q(self, data):
|
||||||
|
self.key_value_list_critical = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_y(self, data):
|
||||||
|
self.key_value_list_not = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_Y(self, data):
|
||||||
|
self.key_value_list_not_critical = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_U(self, data):
|
||||||
|
self.key_value_list_unknown = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_w(self, data):
|
||||||
|
self.key_threshold_warning = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
def dash_c(self, data):
|
||||||
|
self.key_threshold_critical = data
|
||||||
|
return self
|
||||||
|
|
||||||
|
|
||||||
|
class UtilTest(unittest.TestCase):
|
||||||
|
"""
|
||||||
|
Tests for the util fucntions
|
||||||
|
"""
|
||||||
|
|
||||||
|
rules = RulesHelper()
|
||||||
|
|
||||||
|
def check_data(self, args, jsondata, code):
|
||||||
|
data = json.loads(jsondata)
|
||||||
|
nagios = NagiosHelper()
|
||||||
|
processor = JsonRuleProcessor(data, args)
|
||||||
|
nagios.append_message(WARNING_CODE, processor.checkWarning())
|
||||||
|
nagios.append_message(CRITICAL_CODE, processor.checkCritical())
|
||||||
|
nagios.append_metrics(processor.checkMetrics())
|
||||||
|
nagios.append_message(UNKNOWN_CODE, processor.checkUnknown())
|
||||||
|
self.assertEqual(code, nagios.getCode())
|
||||||
|
|
||||||
|
def test_metrics(self):
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric,,1:4,1:5']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric,,1:5,1:4']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,6,10']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric,,1:5,1:5,1,4']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric,s,@1:4,@6:10,1,10']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['(*).value,s,1:5,1:5']),
|
||||||
|
'[{"value": 5},{"value": 100}]', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_m(['metric>foobar,,1:4,1:5']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
|
||||||
|
def test_unknown(self):
|
||||||
|
self.check_data(RulesHelper().dash_U(['metric,0']),
|
||||||
|
'{"metric": 3}', UNKNOWN_CODE)
|
||||||
|
|
||||||
|
def test_array(self):
|
||||||
|
self.check_data(RulesHelper().dash_q(['foo(0),bar']),
|
||||||
|
'{"foo": ["bar"]}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_q(['foo(0),foo']),
|
||||||
|
'{"foo": ["bar"]}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_Q(['foo(1),bar']),
|
||||||
|
'{"foo": ["bar"]}', CRITICAL_CODE)
|
||||||
|
|
||||||
|
def test_exists(self):
|
||||||
|
self.check_data(RulesHelper().dash_e(['nothere']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_E(['nothere']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_e(['metric']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
|
||||||
|
def test_equality(self):
|
||||||
|
self.check_data(RulesHelper().dash_q(['metric,6']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_Q(['metric,6']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_q(['metric,5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
|
||||||
|
def test_equality_colon(self):
|
||||||
|
"""
|
||||||
|
See https://github.com/drewkerrigan/nagios-http-json/issues/43
|
||||||
|
"""
|
||||||
|
rules = RulesHelper()
|
||||||
|
rules.value_separator = '_'
|
||||||
|
|
||||||
|
# This should not fail
|
||||||
|
self.check_data(rules.dash_q(['metric,foo:bar']),
|
||||||
|
'{"metric": "foo:bar"}', OK_CODE)
|
||||||
|
|
||||||
|
def test_non_equality(self):
|
||||||
|
self.check_data(RulesHelper().dash_y(['metric,6']),
|
||||||
|
'{"metric": 6}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_Y(['metric,6']),
|
||||||
|
'{"metric": 6}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_y(['metric,5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
|
||||||
|
def test_warning_thresholds(self):
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,5:']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,~:5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,1:5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@5:']),
|
||||||
|
'{"metric": 4}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@~:5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@1:5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,5']),
|
||||||
|
'{"metric": 6}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,5:']),
|
||||||
|
'{"metric": 4}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,~:5']),
|
||||||
|
'{"metric": 6}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,1:5']),
|
||||||
|
'{"metric": 6}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@5']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@5:']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@~:5']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['metric,@1:5']),
|
||||||
|
'{"metric": 5}', WARNING_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_w(['(*).value,@1:5']),
|
||||||
|
'[{"value": 5},{"value": 1000}]', WARNING_CODE)
|
||||||
|
|
||||||
|
def test_critical_thresholds(self):
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,5:']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,~:5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,1:5']),
|
||||||
|
'{"metric": 5}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@5:']),
|
||||||
|
'{"metric": 4}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@~:5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@1:5']),
|
||||||
|
'{"metric": 6}', OK_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,5']),
|
||||||
|
'{"metric": 6}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,5:']),
|
||||||
|
'{"metric": 4}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,~:5']),
|
||||||
|
'{"metric": 6}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,1:5']),
|
||||||
|
'{"metric": 6}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@5']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@5:']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@~:5']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['metric,@1:5']),
|
||||||
|
'{"metric": 5}', CRITICAL_CODE)
|
||||||
|
self.check_data(RulesHelper().dash_c(['(*).value,@1:5']),
|
||||||
|
'[{"value": 5},{"value": 1000}]', CRITICAL_CODE)
|
||||||
|
|
||||||
|
def test_separator(self):
|
||||||
|
rules = RulesHelper()
|
||||||
|
rules.separator = '_'
|
||||||
|
self.check_data(
|
||||||
|
rules.dash_q(
|
||||||
|
['(0)_gauges_jvm.buffers.direct.capacity(1)_value,1234']),
|
||||||
|
'''[{ "gauges": { "jvm.buffers.direct.capacity": [
|
||||||
|
{"value": 215415},{"value": 1234}]}}]''',
|
||||||
|
OK_CODE)
|
||||||
|
self.check_data(
|
||||||
|
rules.dash_q(
|
||||||
|
['(*)_gauges_jvm.buffers.direct.capacity(1)_value,1234']),
|
||||||
|
'''[{ "gauges": { "jvm.buffers.direct.capacity": [
|
||||||
|
{"value": 215415},{"value": 1234}]}},
|
||||||
|
{ "gauges": { "jvm.buffers.direct.capacity": [
|
||||||
|
{"value": 215415},{"value": 1235}]}}]''',
|
||||||
|
WARNING_CODE)
|
||||||
|
|
||||||
|
def test_array_with_missing_element(self):
|
||||||
|
"""
|
||||||
|
See https://github.com/drewkerrigan/nagios-http-json/issues/34
|
||||||
|
"""
|
||||||
|
rules = RulesHelper()
|
||||||
|
|
||||||
|
# This should simply work
|
||||||
|
data = '[{"Node": "there"}]'
|
||||||
|
self.check_data(rules.dash_q(['(0).Node,there']), data, OK_CODE)
|
||||||
|
|
||||||
|
# This should warn us
|
||||||
|
data = '[{"Node": "othervalue"}]'
|
||||||
|
self.check_data(rules.dash_q(['(0).Node,there']), data, WARNING_CODE)
|
||||||
|
|
||||||
|
# # This should not throw an IndexError
|
||||||
|
data = '[{"Node": "foobar"}]'
|
||||||
|
self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing']), data, WARNING_CODE)
|
||||||
|
self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing', '(2).Node,alsomissing']), data, WARNING_CODE)
|
||||||
|
|
||||||
|
# This should not throw a KeyError
|
||||||
|
data = '{}'
|
||||||
|
self.check_data(rules.dash_q(['(0).Node,foobar', '(1).Node,missing']), data, CRITICAL_CODE)
|
||||||
|
|
||||||
|
def test_subelem(self):
|
||||||
|
|
||||||
|
rules = RulesHelper()
|
||||||
|
data = '{"foo": {"foo": {"foo": "bar"}}}'
|
||||||
|
|
||||||
|
self.check_data(rules.dash_E(['foo.foo.foo.foo.foo']), data, CRITICAL_CODE)
|
||||||
|
|
||||||
|
def test_subarrayelem_missing_elem(self):
|
||||||
|
|
||||||
|
rules = RulesHelper()
|
||||||
|
data = '[{"capacity": {"value": 1000}},{"capacity": {"value": 2200}}]'
|
||||||
|
|
||||||
|
self.check_data(rules.dash_E(['(*).capacity.value']), data, OK_CODE)
|
||||||
|
self.check_data(rules.dash_E(['(*).capacity.value.too_deep']), data, CRITICAL_CODE)
|
||||||
|
# Should not throw keyerror
|
||||||
|
self.check_data(rules.dash_E(['foo']), data, CRITICAL_CODE)
|
||||||
|
|
||||||
|
|
||||||
|
def test_empty_key_value_array(self):
|
||||||
|
"""
|
||||||
|
https://github.com/drewkerrigan/nagios-http-json/issues/61
|
||||||
|
"""
|
||||||
|
|
||||||
|
rules = RulesHelper()
|
||||||
|
|
||||||
|
# This should simply work
|
||||||
|
data = '[{"update_status": "finished"},{"update_status": "finished"}]'
|
||||||
|
self.check_data(rules.dash_q(['(*).update_status,finished']), data, OK_CODE)
|
||||||
|
|
||||||
|
# This should warn us
|
||||||
|
data = '[{"update_status": "finished"},{"update_status": "failure"}]'
|
||||||
|
self.check_data(rules.dash_q(['(*).update_status,finished']), data, WARNING_CODE)
|
||||||
|
|
||||||
|
# This should throw an error
|
||||||
|
data = '[]'
|
||||||
|
self.check_data(rules.dash_q(['(*).update_status,warn_me']), data, CRITICAL_CODE)
|
||||||
48
test/test_cli.py
Normal file
48
test/test_cli.py
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
import unittest.mock as mock
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
|
||||||
|
sys.path.append('..')
|
||||||
|
|
||||||
|
from check_http_json import debugPrint
|
||||||
|
from check_http_json import verbosePrint
|
||||||
|
|
||||||
|
|
||||||
|
class CLITest(unittest.TestCase):
|
||||||
|
"""
|
||||||
|
Tests for CLI
|
||||||
|
"""
|
||||||
|
|
||||||
|
def setUp(self):
|
||||||
|
"""
|
||||||
|
Defining the exitcodes
|
||||||
|
"""
|
||||||
|
|
||||||
|
self.exit_0 = 0 << 8
|
||||||
|
self.exit_1 = 1 << 8
|
||||||
|
self.exit_2 = 2 << 8
|
||||||
|
self.exit_3 = 3 << 8
|
||||||
|
|
||||||
|
def test_debugprint(self):
|
||||||
|
with mock.patch('builtins.print') as mock_print:
|
||||||
|
debugPrint(True, 'debug')
|
||||||
|
mock_print.assert_called_once_with('debug')
|
||||||
|
|
||||||
|
def test_verbose(self):
|
||||||
|
with mock.patch('builtins.print') as mock_print:
|
||||||
|
verbosePrint(0, 3, 'verbose')
|
||||||
|
mock_print.assert_not_called()
|
||||||
|
|
||||||
|
verbosePrint(3, 3, 'verbose')
|
||||||
|
mock_print.assert_called_once_with('verbose')
|
||||||
|
|
||||||
|
def test_cli_without_params(self):
|
||||||
|
|
||||||
|
command = '/usr/bin/env python3 check_http_json.py > /dev/null 2>&1'
|
||||||
|
status = os.system(command)
|
||||||
|
|
||||||
|
self.assertEqual(status, self.exit_2)
|
||||||
131
test/test_main.py
Normal file
131
test/test_main.py
Normal file
@@ -0,0 +1,131 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
|
||||||
|
import unittest
|
||||||
|
import unittest.mock as mock
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
|
||||||
|
sys.path.append('..')
|
||||||
|
|
||||||
|
from check_http_json import main
|
||||||
|
|
||||||
|
|
||||||
|
class MockResponse():
|
||||||
|
def __init__(self, status_code=200, content='{"foo": "bar"}'):
|
||||||
|
self.status_code = status_code
|
||||||
|
self.content = content
|
||||||
|
|
||||||
|
def read(self):
|
||||||
|
return self.content
|
||||||
|
|
||||||
|
|
||||||
|
class MainTest(unittest.TestCase):
|
||||||
|
"""
|
||||||
|
Tests for Main
|
||||||
|
"""
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
def test_main_version(self, mock_print):
|
||||||
|
args = ['--version']
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
mock_print.assert_called_once()
|
||||||
|
self.assertEqual(test.exception.code, 0)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
@mock.patch('urllib.request.urlopen')
|
||||||
|
def test_main_with_ssl(self, mock_request, mock_print):
|
||||||
|
args = '-H localhost --ssl'.split(' ')
|
||||||
|
|
||||||
|
mock_request.return_value = MockResponse()
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertEqual(test.exception.code, 0)
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
@mock.patch('urllib.request.urlopen')
|
||||||
|
def test_main_with_parse_error(self, mock_request, mock_print):
|
||||||
|
args = '-H localhost'.split(' ')
|
||||||
|
|
||||||
|
mock_request.return_value = MockResponse(content='not JSON')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertTrue('Parser error' in str(mock_print.call_args))
|
||||||
|
self.assertEqual(test.exception.code, 3)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
def test_main_with_url_error(self, mock_print):
|
||||||
|
args = '-H localhost'.split(' ')
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertTrue('URLError' in str(mock_print.call_args))
|
||||||
|
self.assertEqual(test.exception.code, 3)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
@mock.patch('urllib.request.urlopen')
|
||||||
|
def test_main_with_http_error_no_json(self, mock_request, mock_print):
|
||||||
|
args = '-H localhost'.split(' ')
|
||||||
|
|
||||||
|
mock_request.return_value = MockResponse(content='not JSON', status_code=503)
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertTrue('Parser error' in str(mock_print.call_args))
|
||||||
|
self.assertEqual(test.exception.code, 3)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
@mock.patch('urllib.request.urlopen')
|
||||||
|
def test_main_with_http_error_valid_json(self, mock_request, mock_print):
|
||||||
|
args = '-H localhost'.split(' ')
|
||||||
|
|
||||||
|
mock_request.return_value = MockResponse(status_code=503)
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertEqual(test.exception.code, 0)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
def test_main_with_tls(self, mock_print):
|
||||||
|
args = ['-H', 'localhost',
|
||||||
|
'--ssl',
|
||||||
|
'--cacert',
|
||||||
|
'test/tls/ca-root.pem',
|
||||||
|
'--cert',
|
||||||
|
'test/tls/cert.pem',
|
||||||
|
'--key',
|
||||||
|
'test/tls/key.pem']
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertTrue('https://localhost' in str(mock_print.call_args))
|
||||||
|
self.assertEqual(test.exception.code, 3)
|
||||||
|
|
||||||
|
@mock.patch('builtins.print')
|
||||||
|
def test_main_with_tls_wrong_ca(self, mock_print):
|
||||||
|
args = ['-H', 'localhost',
|
||||||
|
'--ssl',
|
||||||
|
'--cacert',
|
||||||
|
'test/tls/key.pem',
|
||||||
|
'--cert',
|
||||||
|
'test/tls/cert.pem',
|
||||||
|
'--key',
|
||||||
|
'test/tls/key.pem']
|
||||||
|
|
||||||
|
with self.assertRaises(SystemExit) as test:
|
||||||
|
main(args)
|
||||||
|
|
||||||
|
self.assertTrue('Error loading SSL CA' in str(mock_print.call_args))
|
||||||
|
self.assertEqual(test.exception.code, 3)
|
||||||
51
test/test_nagioshelper.py
Normal file
51
test/test_nagioshelper.py
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
|
||||||
|
import json
|
||||||
|
import unittest
|
||||||
|
from unittest.mock import patch
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.append('..')
|
||||||
|
|
||||||
|
from check_http_json import *
|
||||||
|
|
||||||
|
|
||||||
|
class NagiosHelperTest(unittest.TestCase):
|
||||||
|
"""
|
||||||
|
Tests for the NagiosHelper
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_getcode_default(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
self.assertEqual(0, helper.getCode())
|
||||||
|
|
||||||
|
def test_getcode_warning(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
helper.warning_message = 'foobar'
|
||||||
|
self.assertEqual(1, helper.getCode())
|
||||||
|
|
||||||
|
def test_getcode_critical(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
helper.critical_message = 'foobar'
|
||||||
|
self.assertEqual(2, helper.getCode())
|
||||||
|
|
||||||
|
def test_getcode_unknown(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
helper.unknown_message = 'foobar'
|
||||||
|
self.assertEqual(3, helper.getCode())
|
||||||
|
|
||||||
|
def test_getmessage_default(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
self.assertEqual('OK: Status OK.', helper.getMessage())
|
||||||
|
|
||||||
|
def test_getmessage_perfomance_data(self):
|
||||||
|
|
||||||
|
helper = NagiosHelper()
|
||||||
|
helper.performance_data = 'foobar'
|
||||||
|
self.assertEqual('OK: foobar Status OK. |foobar', helper.getMessage())
|
||||||
21
test/tls/ca-root.pem
Normal file
21
test/tls/ca-root.pem
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDbTCCAlWgAwIBAgIUB6EZDl3ajJgJsoLzyC9DrOQQpKowDQYJKoZIhvcNAQEN
|
||||||
|
BQAwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoM
|
||||||
|
GEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDAgFw0yNDAzMTgwODE5MDhaGA8yMDUx
|
||||||
|
MDgwMzA4MTkwOFowRTELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUx
|
||||||
|
ITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDCCASIwDQYJKoZIhvcN
|
||||||
|
AQEBBQADggEPADCCAQoCggEBALVxioj+6zw6Snr+B1JOivC8Of6YptVYym5ICiHX
|
||||||
|
wjpbSVVe+Py/P2LDb/uQ1QkAENlpvChFqSaRBZU5keXYS/DaFb2Evb2/zf5qIdWU
|
||||||
|
2ju8B5V13gXSeaNNetyEn1Ivvk0lOCQo2RwEZXuStpLS4Q32rkRBvkoL+RXDc1NX
|
||||||
|
c3RwcU1p9ybgBqAC7FYdV82sgHGugIrbzkjfFREJXp1AnqvKAdk39b1CnPxfmPZC
|
||||||
|
nzPPetfr3iivH8yVO5rodU/LDtQNph22JR94YvPB89QO+bZ9bw2GHtPdAKFew9HF
|
||||||
|
UxM1fmy381Mq2iS3KUq5vsC1jMe8slUAIFYEDzoPvOz+MpcCAwEAAaNTMFEwHQYD
|
||||||
|
VR0OBBYEFOmCb+JnMzX29hwgtXSzrN+m6mTDMB8GA1UdIwQYMBaAFOmCb+JnMzX2
|
||||||
|
9hwgtXSzrN+m6mTDMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQENBQADggEB
|
||||||
|
AAkTD8K4UO4uO4i6p2BCofbhVm9LYA0ulmLO8Uro0U491TeEDOQpgMFAK+b2gZIU
|
||||||
|
zvDHoCMn3UPVxHKl7XzDgLZVkYYEc2s9vArxk5vSnFmh3XvlDu2SO5gSLB2sf68A
|
||||||
|
2+Jz2x6z9tjWWdZCGJWU/iwMbG2Y3JMHyv1NMF8cyOclJaSDNBAwF5c5sdlGTLKb
|
||||||
|
WHGXzVqHSAFlGcHtQrcEKclHiuzw2G3LZzwghGk0XzxwvyKrnAEy408RY0mfNLtz
|
||||||
|
32KHqYtrip0RYlGWKP7/7q6i0D8muEFW/I4emFI0z0I/1CcYZZS8tQkWaPf/wCN0
|
||||||
|
llTD1kKJACsIMaqkkyy+EZM=
|
||||||
|
-----END CERTIFICATE-----
|
||||||
19
test/tls/cert.pem
Normal file
19
test/tls/cert.pem
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
-----BEGIN CERTIFICATE-----
|
||||||
|
MIIDDzCCAfcCFBOrBcHIH2x9xcUyUeDid0cvBxWtMA0GCSqGSIb3DQEBDQUAMEUx
|
||||||
|
CzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRl
|
||||||
|
cm5ldCBXaWRnaXRzIFB0eSBMdGQwIBcNMjQwMzE4MDgxOTM1WhgPMjA1MTA4MDMw
|
||||||
|
ODE5MzVaMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYD
|
||||||
|
VQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwggEeMA0GCSqGSIb3DQEBAQUA
|
||||||
|
A4IBCwAwggEGAoH+ALuzyIhEATF5YyAOsXKfr2mttF2HyJvEscGcoA7YetT57bjJ
|
||||||
|
5lg944kc3QH/wTEdrGda3cwh3OXdUuyR7Wrm9jPw38hMArx/fWPkiISOShrUSHGd
|
||||||
|
Qyy2bT+zxBaUo+pomyrlqlgwGlbxuwTAlTSFcI+i7yXrckl2HRj40EW4FNsYpPzv
|
||||||
|
maxRXs0kg0J2JLTYF+fHlqlYbSX/hRU9wz2DYfkRSS0+OYJNSmqK0jayUsdZYurG
|
||||||
|
gbPwOCgQ0QxLLh7P8z4sOanRowqUzqTI77cyUugEJRyoi+LJr4r0EwMTBX3STgPh
|
||||||
|
S9B78+LNvwOrLrZFUhr144RfO9QPLnz0uWcCAwEAATANBgkqhkiG9w0BAQ0FAAOC
|
||||||
|
AQEAeIR21PfLzgpL7WDBE2KgwI78nVc1wY9nwoAxSBzHjS0Olve3r9MaVzAKn5ZS
|
||||||
|
xHtv8oroXjhTcczCIzxii6Imp6u0iIr3QVBIceofxrH3aWmICURcC9l+dIiY6sk9
|
||||||
|
Ct8P8gm/Erv2iF/7bnsARwDnw0f41fC9eXtHZ7WLRQrc7tLHpjL0Z7bT77ysQJVK
|
||||||
|
C1SWtBnq3afmwH3R1wVHENn0JVFQpBp+vqWU5KIlvjcz49yPU+aNODk1rJsHMlgS
|
||||||
|
x2iddwF31GNOxNfXtw8fdw4UDUl2wYoZ45w2e2pXt4pbN43m0Wys1eQZdk3tyR6G
|
||||||
|
AZOLP05073mLtbVlFRmcTdXIGg==
|
||||||
|
-----END CERTIFICATE-----
|
||||||
27
test/tls/key.pem
Normal file
27
test/tls/key.pem
Normal file
@@ -0,0 +1,27 @@
|
|||||||
|
-----BEGIN PRIVATE KEY-----
|
||||||
|
MIIEqAIBADANBgkqhkiG9w0BAQEFAASCBJIwggSOAgEAAoH+ALuzyIhEATF5YyAO
|
||||||
|
sXKfr2mttF2HyJvEscGcoA7YetT57bjJ5lg944kc3QH/wTEdrGda3cwh3OXdUuyR
|
||||||
|
7Wrm9jPw38hMArx/fWPkiISOShrUSHGdQyy2bT+zxBaUo+pomyrlqlgwGlbxuwTA
|
||||||
|
lTSFcI+i7yXrckl2HRj40EW4FNsYpPzvmaxRXs0kg0J2JLTYF+fHlqlYbSX/hRU9
|
||||||
|
wz2DYfkRSS0+OYJNSmqK0jayUsdZYurGgbPwOCgQ0QxLLh7P8z4sOanRowqUzqTI
|
||||||
|
77cyUugEJRyoi+LJr4r0EwMTBX3STgPhS9B78+LNvwOrLrZFUhr144RfO9QPLnz0
|
||||||
|
uWcCAwEAAQKB/UQAYzMy5/fDkWzoxdLQFV3E56ZG7h+4x+lr0/Ts6rtD/KLIyqHH
|
||||||
|
ciqXgV4bCSPBK1eabOZqkjvYzhUU3R2wpRu2NWy8VPVzfrr07ZyQbDqCE+jNX6vQ
|
||||||
|
P44nk2/W0/e1hBmrcOZYLwK2utmC58tKWLhBAEENpq8EkpAcfF/1y9aRHKYwNnH7
|
||||||
|
vouoQibN5NTs5m8s0VyjRTDwRZja98eWnn5NfU3orqYO8fSlF6CyzDtoyhMco6zR
|
||||||
|
0skBgMzRYCRTuJpV+KekC7XFYyiJ6XZN5DKLbbqP6Y7YR8wjyFEruoGCS0mZH2H0
|
||||||
|
9/rhTsJram1B2zohXHPsHJGGGv12/7kCfw5C7yda+8Yv0NmRp1F+EJYb75SCAWIP
|
||||||
|
kzN/xvjP2bMKa6oSzU0DOga3Wc4ijJHDaND8rqdPqQe3zXFr1nPdBrybLSJ6k5CN
|
||||||
|
4Dd6ENJWVWino0L460kpLtlBG6TsgmB8bkwhjWVE6Vgt4Vila+a3TGRXeniaRzdw
|
||||||
|
icNOtMrjYlUCfw0pWEvO2uFq0DbNZbmzC2j5ClFcU96CAl4AqKG2PiGnuSy9TKVZ
|
||||||
|
c5OiXFmyoig7v4LJzaKLSqVIN4hVBU80/MlhvG+dpeimvLaQKNtlZQethIs5hXlB
|
||||||
|
R1XfaPhq6BQiYmQ3tufyS/0Es2OY+Cs3LU1uDB8qVzonlmnIi69OwMsCfwRPISfJ
|
||||||
|
C+4UIIy8v8uVxbk1c6xxo61Xe2jCIQKo+uRoL6PRzoqIgQ3qdI4eTk70tkT/NF6F
|
||||||
|
aVNVrBOrO78Cd7ihQn/6fX/d/nOExHRpdaELlf70a1NNyEQIsiug8rvonQMP2ENT
|
||||||
|
ERZ9tmssgG/Tzpc6/1xVcVNFA7spmuL61YkCfwnu2zGTc0PO7kd96rkktIbL9YqD
|
||||||
|
6NQ0QH8bdildtjSGNc3bLB5ajUytq48Sryk4NogJr8Vt5K8q+qZMrE4kCmgd+C4w
|
||||||
|
x4b3V9Ncp0k1k/MgdLjyd5aUurbHfpyFapPPg3xpRAR3q/vP8WdIintrECiw1jsr
|
||||||
|
JFvChtVdQnbTM9MCfw41RcjNwCaIG+uXc8bD6Yf+NyXD8zP6ZDywmBlkMWlGSzx4
|
||||||
|
xM8J+wQiQsNWthDBbF7inJc+lbtJiEe4YOPkbjCYVZRHribL65HKJlEUv6M9bvQo
|
||||||
|
3P1DS5tDrwo6z9UPs4tD1SgF9fDu/xA7fwPF1RTvuW07MhFJWlDo4FSWS9c=
|
||||||
|
-----END PRIVATE KEY-----
|
||||||
Reference in New Issue
Block a user