Skip to main content

serverchecks

Python 3 module for fast, parallel execution of health checks on a broad range of popular Internet infrastructure protocols with multi-protocol alerting capabilities. Implemented in pure Python (no shell commands called) using asyncio library.

Install

The module comes in a number of flavours that provide additional features using third-party Python libraries.

Flavor Features Install
Core Checks: TCP, DNS (basic), TLS, URL, POP3, SMTP, IMAP. Alerts: console ,SMTP pip3 install serverchecks
DNS Checks: DNS (full) pip3 install serverchecks[dns]
DNSSEC Checks: DNSSEC, DNS (full) pip3 install serverchecks[dnssec]
XMPP Alerts: XMPP pip3 install serverchecks[xmpp]
Telegram Alerts: Telegram pip3 install serverchecks[telegram]
Matrix Alerts: Matrix pip3 install serverchecks[matrix]

Shortcut to install all flavors:

pip3 install serverchecks[dnssec,xmpp,telegram,matrix]

Usage

Create a basic configuration file checks.yaml:

verbose: yes
alert_mode: always

alerts:
  console:
  - dummy:

checks:
  basicdns:
  - fqdn: webcookies.org
  - fqdn: ipsec.pl

Run:

python -m serverchecks.main test.yaml

Sample output:

$ python -m serverchecks.main test.yaml

Initialized alert class <Console>
2 tests completed in 0.03 seconds, 2 successful, 0 failed
✓ webcookies.org 94.130.162.156
✓ ipsec.pl 98.143.148.71

Metadata

Release files for serverchecks 0.5.8

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

Source distribution (sdist)

Source distribution for serverchecks 0.5.8
File Size Uploaded
serverchecks-0.5.8.tar.gz 12.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for serverchecks 0.5.8
File Interpreter ABI Platform
serverchecks-0.5.8-py3-none-any.whl Python 3 none any Details

Total release size: 37.2 kB

Release files / serverchecks-0.5.8.tar.gz

Download URL serverchecks-0.5.8.tar.gz
Size 12.2 kB
Tags Source
SHA-256 checksum
How to use checksums
bd4cf9cde3cf34670d6ec3f152e43a7dd348cdb631f99565d3ca7b12dc756710
BLAKE2b-256 checksum
How to use checksums
dc6ce743728ad9f883e9b6e06a936fafe580a519baa6727de3c11d688e6c21c2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Release files / serverchecks-0.5.8-py3-none-any.whl

Download URL serverchecks-0.5.8-py3-none-any.whl
Size 25.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6f72fe1cb6efab7d26932e39c2549cb323dc340fdbbbffc99291f26923de12c3
BLAKE2b-256 checksum
How to use checksums
d820833a3143184d4fe32da897d9797a063950882e0432dc828d6880d5104964
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Release history Release notifications | RSS feed

This release

0.5.8 This release

2 release files

0.5.7

2 release files

0.5.6

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

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