Concise class level instrumentation

Author: LucasAlvesSoares

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/aiohttp.py

@@ -7,6 +7,8 @@
 
 
 class AiohttpInstrumentor(LibraryInstrumentor):
+    """Instruments aiohttp client sessions with OTel spans and W3C header propagation."""
+
     library_name = "aiohttp"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/django.py

@@ -7,6 +7,8 @@
 
 
 class DjangoInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments Django with OTel spans for inbound HTTP requests and baggage extraction."""
+
     library_name = "django"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/fastapi.py

@@ -7,6 +7,12 @@
 
 
 class FastAPIInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments FastAPI with OTel spans for inbound HTTP requests and baggage extraction.
+
+    Must be called before the FastAPI app instance is constructed, or pass the app
+    instance via auto_instrument(app=app) from within a lifespan handler.
+    """
+
     library_name = "fastapi"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/flask.py

@@ -7,6 +7,8 @@
 
 
 class FlaskInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments Flask with OTel spans for inbound HTTP requests and baggage extraction."""
+
     library_name = "flask"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/grpc.py

@@ -11,6 +11,8 @@
 
 
 class GrpcInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments gRPC client and server interceptors with OTel spans."""
+
     library_name = "grpc"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/httpx.py

@@ -7,6 +7,8 @@
 
 
 class HttpxInstrumentor(LibraryInstrumentor):
+    """Instruments httpx sync and async clients with OTel spans and W3C header propagation."""
+
     library_name = "httpx"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/logging.py

@@ -7,6 +7,8 @@
 
 
 class LoggingInstrumentorWrapper(LibraryInstrumentor):
+    """Injects trace_id and span_id into every stdlib log record for log-trace correlation."""
+
     library_name = "logging"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/redis.py

@@ -7,6 +7,8 @@
 
 
 class RedisInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments the redis client with OTel spans for commands and pipeline operations."""
+
     library_name = "redis"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/requests.py

@@ -7,6 +7,8 @@
 
 
 class RequestsInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments the requests library with OTel spans and W3C header propagation."""
+
     library_name = "requests"
 
     def is_instrumented(self) -> bool:

src/sap_cloud_sdk/core/telemetry/instrumentation/instrumentors/sqlalchemy.py

@@ -7,6 +7,8 @@
 
 
 class SQLAlchemyInstrumentorWrapper(LibraryInstrumentor):
+    """Instruments SQLAlchemy with OTel spans for database queries."""
+
     library_name = "sqlalchemy"
 
     def is_instrumented(self) -> bool: