Skip to main content

SDK for monitoring microservice dependencies via Prometheus metrics

Project description

dephealth

SDK for monitoring microservice dependencies via Prometheus metrics.

Features

  • Automatic health checking for dependencies (PostgreSQL, MySQL, Redis, RabbitMQ, Kafka, HTTP, gRPC, TCP)
  • Prometheus metrics export: app_dependency_health (Gauge 0/1), app_dependency_latency_seconds (Histogram), app_dependency_status (enum), app_dependency_status_detail (info)
  • Async architecture built on asyncio
  • FastAPI integration (middleware, lifespan, endpoints)
  • Connection pool support (preferred) and standalone checks

Installation

# Basic installation
pip install dephealth

# With specific checkers
pip install dephealth[postgres,redis]

# All checkers + FastAPI
pip install dephealth[all]

Quick Start

Standalone

from dephealth import DepHealth

dh = DepHealth()
dh.add("postgres", url="postgresql://user:pass@localhost:5432/mydb")
dh.add("redis", url="redis://localhost:6379")

await dh.start()
# Metrics are available via prometheus_client
await dh.stop()

FastAPI

from fastapi import FastAPI
from dephealth_fastapi import DepHealthFastAPI

app = FastAPI()
dh = DepHealthFastAPI(app)
dh.add("postgres", url="postgresql://user:pass@localhost:5432/mydb")

Configuration

Parameter Default Description
interval 15 Check interval (seconds)
timeout 5 Check timeout (seconds)

Supported Dependencies

Type Extra URL Format
PostgreSQL postgres postgresql://user:pass@host:5432/db
MySQL mysql mysql://user:pass@host:3306/db
Redis redis redis://host:6379
RabbitMQ amqp amqp://user:pass@host:5672/vhost
Kafka kafka kafka://host1:9092,host2:9092
HTTP http://host:8080/health
gRPC grpc host:50051 (via FromParams)
TCP tcp://host:port

License

Apache License 2.0 — see 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

dephealth-0.4.0.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dephealth-0.4.0-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file dephealth-0.4.0.tar.gz.

File metadata

  • Download URL: dephealth-0.4.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for dephealth-0.4.0.tar.gz
Algorithm Hash digest
SHA256 d313364bceeacf53854f3145a703d53fbab250bdf2858ed44de57d3c03ecd4aa
MD5 544e70152ff0cae4784c8812f84f76b4
BLAKE2b-256 e3a3cc223bee140db4be35bf75788f55b9fc059b5f29794d5017211ff5c004c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: dephealth-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 25.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for dephealth-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8ef2999a9feabccce6282bb3d1293feef01ab2b15816a1f12c750972d4f46f8a
MD5 234f96307b75f13ce9d76297a0161381
BLAKE2b-256 b95dd2593d565db6715815529ee456c05577163feac94165b2a85f788f21da97

See more details on using hashes here.

Supported by

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