Utility/library for checking connectivity between services
Project description
conn-check allows for checking connectivity with external services.
You can write a config file that defines services that you need to have access to, and conn-check will check connectivity with each.
It supports various types of services, all of which allow for basic network checks, but some allow for confirming credentials work also.
Configuration
The configuration is done via a yaml file. The file defines a list of checks to do:
- type: tcp host: localhost port: 80 - type: ssl host: localhost port: 443 verify: true
Each check defines a type, and then options as appropriate for that type.
Check Types
tcp
A simple tcp connectivity check.
- host
The host.
- port
The port.
ssl
A check that uses SSL.
- host
The host.
- port
The port.
- verify
Whether to also verify the SSL certificate. Optional. Default: true.
udp
Check that sending a specific UDP packet gets a specific response.
- host
The host.
- port
The port.
- send
The string to send.
- expect
The string to expect in the response.
http
Check that a HTTP/HTTPS request succeeds.
- url
The URL to fetch.
- method
The method to use. Optional. Default: “GET”.
- expected_code
The status code that defines success. Optional. Default: 200.
- proxy_host
Optional HTTP proxy to connect via.
- proxy_port
Port to use with proxy_host. Default: 8000.
- headers:
Optional headers to send, as a dict of key-values. Multiple values can be given as a list under the same key.
- body:
Optional raw request body string to send.
amqp
Check that an AMQP server can be authenticated against.
- host
The host.
- port
The port.
- username
The username to authenticate with.
- password
The password to authenticate with.
- use_ssl
Whether to connect with ssl. Optional. Default: true.
- vhost
The vhost to connect to. Optional. Default ‘/’.
postgres
Check that a postgres db can be authenticated against.
- host
The host.
- port
The port.
- username
The username to authenticate with.
- password
The password to authenticate with.
- database
The database to connect to.
redis
Check that a redis server is present, optionally checking authentication.
- host
The host.
- port
The port.
- password
The password to authenticatie with. Optional.
memcached
Check that a memcached server is present (memcache also works).
- host
The host.
- port
The port.
Building wheels
To allow for easier/more portable distribution of this tool you can build conn-check and all it’s dependencies as Python wheels:
make clean-wheels make build-wheels EXTRA=amqp make build-wheels-extra EXTRA=redis make build-wheels-extra
The build-wheels make target will build conn-check and it’s base dependencies, but to include the optional extra dependencies for other checks such as amqp, redis or postgres you need to use the build-wheels-extra target with the EXTRA env value.
By default all the wheels will be placed in ./wheels.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for conn_check-1.0.5-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 79f1a521f591602478d272bc9b12e252ff76d3d40c67293253ac8eb205657dbd |
|
| MD5 | 1cfecc5487164845c3cbd08a31bec867 |
|
| BLAKE2b-256 | 285bb29449d7c0907724d3f015e1d8ab63fe36df463bacb6d94fc090d3462a03 |
