Skip to main content

aiohealthcheck: super-simple TCP health-check endpoint

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for aiohealthcheck, version 2018.7.1
Filename, size File type Python version Upload date Hashes
Filename, size aiohealthcheck-2018.7.1-py2.py3-none-any.whl (15.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size aiohealthcheck-2018.7.1.tar.gz (7.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page