otpl-service-check 1.1.4

Distribution

https://pypi.python.org/pypi/otpl-service-check

Dependencies

See requirements.txt.

Arguments

Run with -h or --help to see command-line argument documentation.

Interface

If there is an error parsing command-line arguments, we return with exit code 3 (UNKNOWN) and print the invocation error.

If there is an error reaching Discovery and parsing the announcements for your service, we return with exit code 3 (UNKNOWN).

We log critical and warning statuses related to announcement, and return with exit codes 2 (CRITICAL) and 1 (WARNING) respectively.

Endpoint Response Codes

• 2xx: 0, OK

• 4xx: 1, WARNING

• 5xx: 2, CRITICAL

This is a bit of an abuse of HTTP response codes, but our policy is that this is the simplest and most flexible way to get rich status responses from health check endpoints.

Releasing

Set up PyPI RC file, .pypirc. E.g.:

[distutils]
index-servers =
  pypi
  pypitest

[pypitest]
repository = https://testpypi.python.org/pypi
username = cpennello_opentable

[pypi]
repository = https://pypi.python.org/pypi
username = cpennello_opentable

Suppose the version being released is a.b.c.

Create distributions: python setup.py sdist bdist_wheel

Sign distribution files:

for x in dist/*a.b.c*;do
  gpg --detach-sign -a $x
done

Use Twine, uploading to the test repo first. twine upload -r pypitest dist/*a.b.c*

Then to the real repo. twine upload -r pypi dist/*a.b.c*

Notes

Nagios and Sensu plugin API documentation:

• https://assets.nagios.com/downloads/nagioscore/docs/nagioscore/3/en/pluginapi.html

• https://sensuapp.org/docs/latest/reference/plugins