add health check path to OTL exclude (#84)

Author: lesnik512

microbootstrap/bootstrappers/fastapi.py

@@ -91,7 +91,7 @@ def bootstrap_after(self, application: ApplicationT) -> ApplicationT:
         FastAPIInstrumentor.instrument_app(
             application,
             tracer_provider=self.tracer_provider,
-            excluded_urls=",".join(self.instrument_config.opentelemetry_exclude_urls),
+            excluded_urls=",".join(self.define_exclude_urls()),
         )
         return application
 

microbootstrap/bootstrappers/litestar.py

@@ -109,7 +109,7 @@ def bootstrap_before(self) -> dict[str, typing.Any]:
             "middleware": [
                 LitestarOpentelemetryConfig(
                     tracer_provider=self.tracer_provider,
-                    exclude=self.instrument_config.opentelemetry_exclude_urls,
+                    exclude=self.define_exclude_urls(),
                 ).middleware,
             ],
         }

microbootstrap/instruments/opentelemetry_instrument.py

@@ -30,6 +30,7 @@ class OpenTelemetryInstrumentor:
 class OpentelemetryConfig(BaseInstrumentConfig):
     service_name: str = "micro-service"
     service_version: str = "1.0.0"
+    health_checks_path: str = "/health/"
 
     opentelemetry_service_name: str | None = None
     opentelemetry_container_name: str | None = None
@@ -104,6 +105,12 @@ def bootstrap(self) -> None:
 
 
 class OpentelemetryInstrument(BaseOpentelemetryInstrument[OpentelemetryConfig]):
+    def define_exclude_urls(self) -> list[str]:
+        exclude_urls = [*self.instrument_config.opentelemetry_exclude_urls]
+        if self.instrument_config.health_checks_path and self.instrument_config.health_checks_path not in exclude_urls:
+            exclude_urls.append(self.instrument_config.health_checks_path)
+        return exclude_urls
+
     @classmethod
     def get_config_type(cls) -> type[OpentelemetryConfig]:
         return OpentelemetryConfig