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.11

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.11
File Size Uploaded Provenance Actions
conn-check-configs-1.0.11.tar.gz 7.9 kB Without provenance Details for conn-check-configs-1.0.11.tar.gz

Built distribution (wheel)

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

Total release size: 15.3 kB

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

Download URL conn-check-configs-1.0.11.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ec3375ab5ab7b1b727281be4a8224b21a5460fa35c6a7bc2ebaad2156b362002
BLAKE2b-256 checksum
How to use checksums
8f9b813541b12fbdeb671fb76dba8acaa7e04d78204d56f0c6b68df81a8da72d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

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

Download URL conn_check_configs-1.0.11-py2-none-any.whl
Size 7.4 kB
Tags Python 2
SHA-256 checksum
How to use checksums
ef86129f953a16cad1aff3a9bbb364467d32e2ea58546846371eee4cddf3d210
BLAKE2b-256 checksum
How to use checksums
31c5a2d3205bb33a40b2525e18ff715e928734013424dd47b7da8da792e7b70d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for conn-check-configs 1.0.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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