Skip to main content

conn-check-configs

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 -f /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.

Metadata

Release files for conn-check-configs 1.0.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for conn-check-configs 1.0.9
File Size Uploaded
conn-check-configs-1.0.9.tar.gz 18.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for conn-check-configs 1.0.9
File Interpreter ABI Platform
conn_check_configs-1.0.9-py2-none-any.whl Python 2 none any Details

Total release size: 25.5 kB

Release files / conn-check-configs-1.0.9.tar.gz

Download URL conn-check-configs-1.0.9.tar.gz
Size 18.2 kB
Tags Source
SHA-256 checksum
How to use checksums
464fd720da6562abeabb96c172646757c4cfc54948318f265574ce9a673b6010
BLAKE2b-256 checksum
How to use checksums
b9a0690efc4a843ffaddbe28b2988172349ad2dd445574f3ea5a76f9cecf1ad0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / conn_check_configs-1.0.9-py2-none-any.whl

Download URL conn_check_configs-1.0.9-py2-none-any.whl
Size 7.3 kB
Tags Python 2
SHA-256 checksum
How to use checksums
89066301e2ba06a260a8da58251cacbc3328f1ffb1b38353fe0dbd54f8b8cf96
BLAKE2b-256 checksum
How to use checksums
601f4866e6888aee0d40e70eebdb39f6ed6b5ec304f6bae445f7aa87f3657cd2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.0.11

2 release files

1.0.10

2 release files

This release

1.0.9 This release

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page