apifrom.health

Health check module for APIFromAnything.

This module provides health check endpoints and utilities to monitor the health of the application and its dependencies.

Overview

Functions

• check_database_connection()

• check_redis_connection()

• get_application_health()

• get_complete_health_check()

• get_simple_health_check()

• get_system_health()

Functions

apifrom.health.check_database_connection(db_url=None)

Parameters:

db_url (Optional[str])

Return type:

Dict[str, Any]

Check the database connection health.

param db_url:

Optional database URL to check

returns:

Dict with database health status

apifrom.health.check_redis_connection(redis_url=None)

Parameters:

redis_url (Optional[str])

Return type:

Dict[str, Any]

Check the Redis connection health.

param redis_url:

Optional Redis URL to check

returns:

Dict with Redis health status

apifrom.health.get_application_health()

Return type:

Dict[str, Any]

Get application health metrics.

returns:

Dict with application health metrics

apifrom.health.get_complete_health_check()

Return type:

Dict[str, Any]

Get a complete health check of the application and its dependencies.

returns:

Dict with complete health check information

apifrom.health.get_simple_health_check()

Return type:

Dict[str, str]

Get a simple health check response.

returns:

Dict with simple health status

apifrom.health.get_system_health()

Return type:

Dict[str, Any]

Get system health metrics.

returns:

Dict with system health metrics