microbootstrap 0.4.4__tar.gz → 0.5.2__tar.gz

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: microbootstrap
-Version: 0.4.4
+Version: 0.5.2
 Summary: Package for bootstrapping new micro-services
 Keywords: python,microservice,bootstrap,opentelemetry,logging,error-tracing,litestar,fastapi
 Author: community-of-python
@@ -25,6 +25,7 @@ Requires-Dist: eval-type-backport (>=0.2.0,<0.3.0)
 Requires-Dist: fastapi (>=0.111.0,<0.112.0) ; extra == "fastapi"
 Requires-Dist: fastapi-offline-docs (>=1.0.1,<2.0.0) ; extra == "fastapi"
 Requires-Dist: granian[reload] (>=1.4.4,<2.0.0)
+Requires-Dist: health-checks (>=1.0.0,<2.0.0)
 Requires-Dist: litestar (>=2.9.1,<3.0.0) ; extra == "litestar"
 Requires-Dist: litestar-offline-docs (>=1.0.1,<2.0.0) ; extra == "litestar"
 Requires-Dist: opentelemetry-api (>=1.25.0,<2.0.0)
@@ -90,6 +91,7 @@ With <b>microbootstrap</b>, you receive an application with lightweight built-in
 - `logging`
 - `cors`
 - `swagger` - with additional offline version support
+- `health-checks`
 
 Those instruments can be bootstrapped for:
 
@@ -111,6 +113,7 @@ Interested? Let's dive right in ⚡
   - [Logging](#logging)
   - [CORS](#cors)
   - [Swagger](#swagger)
+  - [Health checks](#health-checks)
 - [Configuration](#configuration)
   - [Instruments configuration](#instruments-configuration)
   - [Application configuration](#application-configuration)
@@ -454,6 +457,27 @@ Parameter descriptions:
 - `swagger_offline_docs` - A boolean value that, when set to True, allows the Swagger JS bundles to be accessed offline. This is because the service starts to host via static.
 - `swagger_extra_params` - Additional parameters to pass into the OpenAPI configuration.
 
+### Health checks
+
+```python
+from microbootstrap.settings import BaseServiceSettings
+
+
+class YourSettings(BaseServiceSettings):
+    service_name: str = "micro-service"
+    service_version: str = "1.0.0"
+
+    health_checks_enabled: bool = True
+    health_checks_path: str = "/health/"
+```
+
+Parameter descriptions:
+
+- `service_name` - Will be displayed in health check response.
+- `service_version` - Will be displayed in health check response.
+- `health_checks_enabled` - Must be True to enable health checks.
+- `health_checks_path` - Path for health check handler.
+
 ## Configuration
 
 While settings provide a convenient mechanism, it's not always feasible to store everything within them.

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/README.md

@@ -41,6 +41,7 @@ With <b>microbootstrap</b>, you receive an application with lightweight built-in
 - `logging`
 - `cors`
 - `swagger` - with additional offline version support
+- `health-checks`
 
 Those instruments can be bootstrapped for:
 
@@ -62,6 +63,7 @@ Interested? Let's dive right in ⚡
   - [Logging](#logging)
   - [CORS](#cors)
   - [Swagger](#swagger)
+  - [Health checks](#health-checks)
 - [Configuration](#configuration)
   - [Instruments configuration](#instruments-configuration)
   - [Application configuration](#application-configuration)
@@ -405,6 +407,27 @@ Parameter descriptions:
 - `swagger_offline_docs` - A boolean value that, when set to True, allows the Swagger JS bundles to be accessed offline. This is because the service starts to host via static.
 - `swagger_extra_params` - Additional parameters to pass into the OpenAPI configuration.
 
+### Health checks
+
+```python
+from microbootstrap.settings import BaseServiceSettings
+
+
+class YourSettings(BaseServiceSettings):
+    service_name: str = "micro-service"
+    service_version: str = "1.0.0"
+
+    health_checks_enabled: bool = True
+    health_checks_path: str = "/health/"
+```
+
+Parameter descriptions:
+
+- `service_name` - Will be displayed in health check response.
+- `service_version` - Will be displayed in health check response.
+- `health_checks_enabled` - Must be True to enable health checks.
+- `health_checks_path` - Path for health check handler.
+
 ## Configuration
 
 While settings provide a convenient mechanism, it's not always feasible to store everything within them.

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/microbootstrap/__init__.py

@@ -1,4 +1,5 @@
 from microbootstrap.instruments.cors_instrument import CorsConfig
+from microbootstrap.instruments.health_checks_instrument import HealthChecksConfig
 from microbootstrap.instruments.logging_instrument import LoggingConfig
 from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryConfig
 from microbootstrap.instruments.prometheus_instrument import FastApiPrometheusConfig, LitestarPrometheusConfig
@@ -13,9 +14,9 @@ __all__ = (
     "FastApiPrometheusConfig",
     "LitestarPrometheusConfig",
     "LoggingConfig",
-    "LitestarBootstrapper",
     "LitestarSettings",
     "FastApiSettings",
     "CorsConfig",
     "SwaggerConfig",
+    "HealthChecksConfig",
 )

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/microbootstrap/bootstrappers/fastapi.py

@@ -4,6 +4,7 @@ import fastapi
 import typing_extensions
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi_offline_docs import enable_offline_docs
+from health_checks.fastapi_healthcheck import build_fastapi_health_check_router
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from prometheus_fastapi_instrumentator import Instrumentator
 from sentry_sdk.integrations.fastapi import FastApiIntegration
@@ -11,6 +12,7 @@ from sentry_sdk.integrations.fastapi import FastApiIntegration
 from microbootstrap.bootstrappers.base import ApplicationBootstrapper
 from microbootstrap.config.fastapi import FastApiConfig
 from microbootstrap.instruments.cors_instrument import CorsInstrument
+from microbootstrap.instruments.health_checks_instrument import HealthChecksInstrument
 from microbootstrap.instruments.logging_instrument import LoggingInstrument
 from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryInstrument
 from microbootstrap.instruments.prometheus_instrument import FastApiPrometheusConfig, PrometheusInstrument
@@ -114,3 +116,12 @@ class FastApiPrometheusInstrument(PrometheusInstrument[FastApiPrometheusConfig])
     @classmethod
     def get_config_type(cls) -> type[FastApiPrometheusConfig]:
         return FastApiPrometheusConfig
+
+
+@FastApiBootstrapper.use_instrument()
+class FastApiHealthChecksInstrument(HealthChecksInstrument):
+    def bootstrap_after(self, application: fastapi.FastAPI) -> fastapi.FastAPI:
+        application.include_router(
+            build_fastapi_health_check_router(self.health_check, self.instrument_config.health_checks_path),
+        )
+        return application

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/microbootstrap/bootstrappers/litestar.py

@@ -4,6 +4,7 @@ import typing
 import litestar
 import litestar.types
 import typing_extensions
+from health_checks.litestar_healthcheck import build_litestar_health_check_router
 from litestar import openapi
 from litestar.config.cors import CORSConfig as LitestarCorsConfig
 from litestar.contrib.opentelemetry.config import OpenTelemetryConfig as LitestarOpentelemetryConfig
@@ -15,6 +16,7 @@ from sentry_sdk.integrations.litestar import LitestarIntegration
 from microbootstrap.bootstrappers.base import ApplicationBootstrapper
 from microbootstrap.config.litestar import LitestarConfig
 from microbootstrap.instruments.cors_instrument import CorsInstrument
+from microbootstrap.instruments.health_checks_instrument import HealthChecksInstrument
 from microbootstrap.instruments.logging_instrument import LoggingInstrument
 from microbootstrap.instruments.opentelemetry_instrument import OpentelemetryInstrument
 from microbootstrap.instruments.prometheus_instrument import LitestarPrometheusConfig, PrometheusInstrument
@@ -75,7 +77,7 @@ class LitestarSwaggerInstrument(SwaggerInstrument):
         } | self.instrument_config.swagger_extra_params
 
         bootstrap_result: typing.Final[dict[str, typing.Any]] = {
-            "openapi_config": openapi.OpenAPIConfig(**all_swagger_params)
+            "openapi_config": openapi.OpenAPIConfig(**all_swagger_params),
         }
         if self.instrument_config.swagger_offline_docs:
             bootstrap_result["static_files_config"] = [
@@ -137,3 +139,16 @@ class LitestarPrometheusInstrument(PrometheusInstrument[LitestarPrometheusConfig
     @classmethod
     def get_config_type(cls) -> type[LitestarPrometheusConfig]:
         return LitestarPrometheusConfig
+
+
+@LitestarBootstrapper.use_instrument()
+class LitestarHealthChecksInstrument(HealthChecksInstrument):
+    def bootstrap_before(self) -> dict[str, typing.Any]:
+        return {
+            "route_handlers": [
+                build_litestar_health_check_router(
+                    self.health_check,
+                    self.instrument_config.health_checks_path,
+                ),
+            ],
+        }

microbootstrap-0.5.2/microbootstrap/instruments/health_checks_instrument.py

@@ -0,0 +1,31 @@
+from __future__ import annotations
+
+from health_checks.http_based import DefaultHTTPHealthCheck
+
+from microbootstrap.instruments.base import BaseInstrumentConfig, Instrument
+
+
+class HealthChecksConfig(BaseInstrumentConfig):
+    service_name: str = "micro-service"
+    service_version: str = "1.0.0"
+
+    health_checks_enabled: bool = True
+    health_checks_path: str = "/health/"
+
+
+class HealthChecksInstrument(Instrument[HealthChecksConfig]):
+    instrument_name = "Health checks"
+    ready_condition = "Set health_checks_enabled to True"
+
+    def bootstrap(self) -> None:
+        self.health_check = DefaultHTTPHealthCheck(
+            service_version=self.instrument_config.service_version,
+            service_name=self.instrument_config.service_name,
+        )
+
+    def is_ready(self) -> bool:
+        return self.instrument_config.health_checks_enabled
+
+    @classmethod
+    def get_config_type(cls) -> type[HealthChecksConfig]:
+        return HealthChecksConfig

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/microbootstrap/settings.py

@@ -8,6 +8,7 @@ import pydantic_settings
 from microbootstrap import (
     CorsConfig,
     FastApiPrometheusConfig,
+    HealthChecksConfig,
     LitestarPrometheusConfig,
     LoggingConfig,
     OpentelemetryConfig,
@@ -28,11 +29,13 @@ class BaseServiceSettings(
     service_debug: bool = False
     service_environment: str | None = None
     service_name: str = pydantic.Field(
-        "micro-service", validation_alias=pydantic.AliasChoices("SERVICE_NAME", f"{ENV_PREFIX}SERVICE_NAME")
+        "micro-service",
+        validation_alias=pydantic.AliasChoices("SERVICE_NAME", f"{ENV_PREFIX}SERVICE_NAME"),
     )
     service_description: str = "Micro service description"
     service_version: str = pydantic.Field(
-        "1.0.0", validation_alias=pydantic.AliasChoices("CI_COMMIT_TAG", f"{ENV_PREFIX}SERVICE_VERSION")
+        "1.0.0",
+        validation_alias=pydantic.AliasChoices("CI_COMMIT_TAG", f"{ENV_PREFIX}SERVICE_VERSION"),
     )
     service_static_path: str = "/static"
 
@@ -50,24 +53,26 @@ class BaseServiceSettings(
 
 
 class LitestarSettings(
-    BaseServiceSettings,
     LoggingConfig,
     OpentelemetryConfig,
     SentryConfig,
     LitestarPrometheusConfig,
     SwaggerConfig,
     CorsConfig,
+    HealthChecksConfig,
+    BaseServiceSettings,
 ):
     """Settings for a litestar botstrap."""
 
 
 class FastApiSettings(
-    BaseServiceSettings,
     LoggingConfig,
     OpentelemetryConfig,
     SentryConfig,
     FastApiPrometheusConfig,
     SwaggerConfig,
     CorsConfig,
+    HealthChecksConfig,
+    BaseServiceSettings,
 ):
     """Settings for a fastapi botstrap."""

{microbootstrap-0.4.4 → microbootstrap-0.5.2}/pyproject.toml

@@ -26,7 +26,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
 ]
-version = "0.4.4"
+version = "0.5.2"
 description = "Package for bootstrapping new micro-services"
 authors = ["community-of-python"]
 readme = "README.md"
@@ -66,6 +66,7 @@ fastapi = { version = "^0.111.0", optional = true }
 prometheus-fastapi-instrumentator = { version = "^6.1.0", optional = true }
 opentelemetry-instrumentation-fastapi = { version = "^0.46b0", optional = true }
 fastapi-offline-docs = { version = "^1.0.1", optional = true }
+health-checks = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.2.2"