Skip to main content
https://travis-ci.org/cjrh/aiohealthcheck.svg?branch=master https://coveralls.io/repos/github/cjrh/aiohealthcheck/badge.svg?branch=master https://img.shields.io/pypi/pyversions/aiohealthcheck.svg https://img.shields.io/github/tag/cjrh/aiohealthcheck.svg https://img.shields.io/badge/install-pip%20install%20aiohealthcheck-ff69b4.svg https://img.shields.io/pypi/v/aiohealthcheck.svg https://img.shields.io/badge/calver-YYYY.MM.MINOR-22bfda.svg

aiohealthcheck

This tiny module provides a simple TCP endpoint, suitable for a healthcheck in your microservice application. All it provides is a simple TCP endpoint on a port to allow a container orchestration service to connect to, to verify that the application is up.

Demo

Pretty much just start up a long-lived task with the provided tcp_health_endpoint() coroutine function:

loop.create_task(aiohealthcheck.tcp_health_endpoint(port=5000))

The internal TCP server will be shut down when the task is cancelled, e.g., during your app’s shutdown sequence.

Kubernetes Example Configuration

ports:
- name: liveness-port
  containerPort: 5000
livenessProbe:
  tcpSocket:
    port: liveness-port
  initialDelaySeconds: 15
  periodSeconds: 20

Metadata

Release files for aiohealthcheck 2018.7.1

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

Source distribution (sdist)

Source distribution for aiohealthcheck 2018.7.1
File Size Uploaded Provenance
aiohealthcheck-2018.7.1.tar.gz 7.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for aiohealthcheck 2018.7.1
File Interpreter ABI Platform
aiohealthcheck-2018.7.1-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 22.8 kB

Release files / aiohealthcheck-2018.7.1.tar.gz

Download URL aiohealthcheck-2018.7.1.tar.gz
Size 7.8 kB
Tags Source
SHA-256 checksum
How to use checksums
bbd9824c36e899df2ff38f9ba778edd23a58d9dab5b47fd49a0723a901492fc2
BLAKE2b-256 checksum
How to use checksums
3634f7a665ef8d06cd08791bac23ff0251e3cbda6ca4c3c53477e5e623a20a24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / aiohealthcheck-2018.7.1-py2.py3-none-any.whl

Download URL aiohealthcheck-2018.7.1-py2.py3-none-any.whl
Size 15.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7b242832ddd053bee2fd67fd613c6d17c205331c935db01945901a108c8978fa
BLAKE2b-256 checksum
How to use checksums
65849b64e78d82f668ab75175fa91c19cc866c3374b76549993ac05ef7643bf4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for aiohealthcheck 2018.7.1

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.

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