Skip to main content

Utilities for generating conn-check YAML configs from other sources, such as Django settings

Project description

This is a set of Python modules and utilities for generating conn-check config YAML from other sources, such as Django settings modules.

Supported sources

  • Django settings modules

Usage

Django

You can export common settings from a Django application using the conn-check-django command line utility, which takes the following arguments:

  • -m, --settings-module: the Python module for Django to import.

  • -d, --database-name: the database schema name if not set as NAME in the Django settings.

  • --statsd-send: Optional string to send with statsd checks (defaults to a conn-check specific metric).

  • --statsd-expect: Optional response string to expect from a statsd check.

  • -f, output-file: Optionally output to a file rather than STDOUT.

Followed by a path to the generated YAML file, for example:

$ conn-check-django -m myapp.settings /tmp/myapp-conncheck.yaml
$ conn-check /tmp/myapp-conncheck.yaml

Extending configuration generation

You may want to extend the generated checks with custom (or unsupported) settings, this can be done by creating your own script and importing all the functions/variables from the relevant conn_check_configs submodule (e.g. django), and then extending the EXTRA_CHECK_MAKERS list with your own check making functions, which must take 2 arguments: the Django settings module and the options from the CLI (usually a argparse.Namespace instance).

Building wheels

To allow for easier/more portable distribution of this tool you can build conn-check-configs and all it’s dependencies as Python wheels:

make clean-wheels
make build-wheels

The build-wheels make target will build conn-check-configs and it’s base dependencies.

By default all the wheels will be placed in ./wheels.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

conn-check-configs-1.0.4.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

conn_check_configs-1.0.4-py2-none-any.whl (6.9 kB view details)

Uploaded Python 2

File details

Details for the file conn-check-configs-1.0.4.tar.gz.

File metadata

File hashes

Hashes for conn-check-configs-1.0.4.tar.gz
Algorithm Hash digest
SHA256 eabc7a4e71c1d7e60b0e753ab7b09c63ac0ff2950c155f7e4aa206c41f2b3097
MD5 6307be315e7fe9471082b08a2e13d073
BLAKE2b-256 d860c75085e74c6ebd802bd3a44df93a2a018c2ce2bd0f389a57d753e7988de0

See more details on using hashes here.

File details

Details for the file conn_check_configs-1.0.4-py2-none-any.whl.

File metadata

File hashes

Hashes for conn_check_configs-1.0.4-py2-none-any.whl
Algorithm Hash digest
SHA256 edbaab474671a6ba1fdedc1b67076ae0e02548ceb19570515f7c03d2fc6985c2
MD5 3161f6ba3961ad27609b21f7b4268690
BLAKE2b-256 ec4559b1c0d214553e6fd52b886742bf8c00b6bd783b6790e386c54597c368c9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page