Skip to main content

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

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 files for conn-check 1.0.2

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 1.0.2
File Size Uploaded
conn-check-1.0.2.tar.gz 13.3 kB Details

Built distribution (wheel)

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

Total release size: 55.0 kB

Release files / conn-check-1.0.2.tar.gz

Download URL conn-check-1.0.2.tar.gz
Size 13.3 kB
Tags Source
SHA-256 checksum
How to use checksums
cc8f32e7f35e2e39cb0bc5c60ab38bff0d85bd1e9afaeebca8653b95626bdbaf
BLAKE2b-256 checksum
How to use checksums
623f6a3e232483d2e24ec3503ea4d60a8d3f85b82ceedd0779b00e482d2e4d08
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / conn_check-1.0.2-py2-none-any.whl

Download URL conn_check-1.0.2-py2-none-any.whl
Size 41.6 kB
Tags Python 2
SHA-256 checksum
How to use checksums
99a2928a777d091abfc6958d6a16787c93353d23880d553fe282770cb896eced
BLAKE2b-256 checksum
How to use checksums
63e98ef8f3831662cbdc023ce6358a764633aa628c1ba2ac3e116151232d2b7f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

1.5.0

2 release files

1.4.1

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.18

2 release files

1.0.15

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.10

2 release files

1.0.9

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

This release

1.0.2 This release

2 release files

1.0.1

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