Skip to main content

Heath check on FastAPI applications.

Project description

FastAPI Health 🚑️

Latest Commit
Package version

The goal of this package is to help you to implement the Health Check API pattern.

Installation

pip install fastapi-health

Quick Start

Create the health check endpoint dynamically using different conditions. Each condition is a callable, and you can even have dependencies inside of it:

from fastapi import FastAPI, Depends
from fastapi_health import health


def get_session():
    return True


def is_database_online(session: bool = Depends(get_session)):
    return session


app = FastAPI()
app.add_api_route("/health", health([is_database_online]))

Advanced Usage

The health() method receives the following parameters:

  • conditions: A list of callables that represents the conditions of your API, it can return either bool or a dict.
  • success_output: An optional dictionary that will be the content response of a successful health call.
  • failure_output: An optional dictionary analogous to success_output for failure scenarios.
  • success_status: An integer that overwrites the default status (200) in case of success.
  • failure_status: An integer that overwrites the default status (503) in case of failure.

It's important to notice that you can have a peculiar behavior in case of hybrid return statements (bool and dict) on the conditions. For example:

from fastapi import FastAPI
from fastapi_health import health


def healthy_condition():
    return {"database": "online"}


def sick_condition():
    return False


app = FastAPI()
app.add_api_route("/health", health([healthy_condition, sick_condition]))

This will generate a response composed by the status being 503 (default failure_status), because sick_condition returns False, and the JSON body {"database": "online"}. It's not wrong, or a bug. It's meant to be like this.

License

This project is licensed under the terms of the MIT license.

Project details


Download files

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

Source Distribution

fastapi-health-0.4.0.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

fastapi_health-0.4.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file fastapi-health-0.4.0.tar.gz.

File metadata

  • Download URL: fastapi-health-0.4.0.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.11 Linux/5.11.0-27-generic

File hashes

Hashes for fastapi-health-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a0781b2359732d50cddda1195784f78950265c6b3689d7a1e6e65a21aed4d6a5
MD5 8bfd9414cd27b17e03b8f520c84c2c2b
BLAKE2b-256 ce9727bdba7462672adf9815c0ac05c6d1c1ff49527b5d5a8a4e41034a58b6c2

See more details on using hashes here.

Provenance

File details

Details for the file fastapi_health-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: fastapi_health-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.8 CPython/3.8.11 Linux/5.11.0-27-generic

File hashes

Hashes for fastapi_health-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6c1795f7596009cffa7a84d5a67a6b66bbf9d6ce79b040fd50601ed5392089f
MD5 1c271023e988dc84e2934649e3dd2da0
BLAKE2b-256 cf3dbc1003fb1708f7cfe1546a22875c38ebc901e621564aeef3bb97f32b1ab2

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page