Welcome to Probirka’s documentation!

Probirka is a framework-agnostic library for running health probes in Python applications, with built-in probes and integrations for popular HTTP frameworks.

GitHub Repository

Contents:

• Installation
• Usage
  • Basic Example
  • Health Check Orchestrator
  • Creating Custom Checks
  • Adding Metadata to Checks
  • Grouping Checks
  • Allowing Failures
  • Setting Timeouts
  • Caching Results
• Ready-made Probes
  • Client or connection string
  • Late-bound clients
  • HTTP probes
  • TCP probe
  • How failures are reported
• Serving the health endpoint
  • Choosing an integration
  • Common options
  • Response format
  • Generic ASGI app
  • Native adapters
  • Kubernetes probes
  • Without an adapter
• API Reference
  • Core Classes
  • Secrets
  • Ready-made Probes
  • Serving the result

Indices and tables

• Index

• Module Index

• Search Page