Add observability instrument for redis client (#972)

Author: wu-clan

backend/utils/otel.py

@@ -5,6 +5,7 @@
 from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
 from opentelemetry.instrumentation.fastapi import FastAPIInstrumentor
 from opentelemetry.instrumentation.logging import LoggingInstrumentor
+from opentelemetry.instrumentation.redis import RedisInstrumentor
 from opentelemetry.instrumentation.sqlalchemy import SQLAlchemyInstrumentor
 from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
 from opentelemetry.sdk._logs._internal.export import BatchLogRecordProcessor
@@ -15,6 +16,7 @@
 from backend.common.log import log, request_id_filter
 from backend.core.conf import settings
 from backend.database.db import async_engine
+from backend.database.redis import redis_client
 
 
 def init_otel(app: FastAPI) -> None:
@@ -56,4 +58,5 @@ def init_otel(app: FastAPI) -> None:
 
     LoggingInstrumentor().instrument(set_logging_format=True)
     SQLAlchemyInstrumentor().instrument(engine=async_engine.sync_engine)
+    RedisInstrumentor().instrument_client(redis_client)  # type: ignore
     FastAPIInstrumentor.instrument_app(app, tracer_provider=tracer_provider)

pyproject.toml

@@ -39,6 +39,7 @@ dependencies = [
     "opentelemetry-exporter-otlp-proto-grpc>=1.39.0",
     "opentelemetry-instrumentation-fastapi>=0.60b0",
     "opentelemetry-instrumentation-logging>=0.60b0",
+    "opentelemetry-instrumentation-redis>=0.60b0",
     "opentelemetry-instrumentation-sqlalchemy>=0.60b0",
     "opentelemetry-sdk>=1.39.0",
     "prometheus-client>=0.23.1",

requirements.txt

@@ -168,6 +168,7 @@ opentelemetry-api==1.39.0
     #   opentelemetry-instrumentation-asgi
     #   opentelemetry-instrumentation-fastapi
     #   opentelemetry-instrumentation-logging
+    #   opentelemetry-instrumentation-redis
     #   opentelemetry-instrumentation-sqlalchemy
     #   opentelemetry-sdk
     #   opentelemetry-semantic-conventions
@@ -180,13 +181,16 @@ opentelemetry-instrumentation==0.60b0
     #   opentelemetry-instrumentation-asgi
     #   opentelemetry-instrumentation-fastapi
     #   opentelemetry-instrumentation-logging
+    #   opentelemetry-instrumentation-redis
     #   opentelemetry-instrumentation-sqlalchemy
 opentelemetry-instrumentation-asgi==0.60b0
     # via opentelemetry-instrumentation-fastapi
 opentelemetry-instrumentation-fastapi==0.60b0
     # via fastapi-best-architecture
 opentelemetry-instrumentation-logging==0.60b0
     # via fastapi-best-architecture
+opentelemetry-instrumentation-redis==0.60b0
+    # via fastapi-best-architecture
 opentelemetry-instrumentation-sqlalchemy==0.60b0
     # via fastapi-best-architecture
 opentelemetry-proto==1.39.0
@@ -202,6 +206,7 @@ opentelemetry-semantic-conventions==0.60b0
     #   opentelemetry-instrumentation
     #   opentelemetry-instrumentation-asgi
     #   opentelemetry-instrumentation-fastapi
+    #   opentelemetry-instrumentation-redis
     #   opentelemetry-instrumentation-sqlalchemy
     #   opentelemetry-sdk
 opentelemetry-util-http==0.60b0
@@ -399,6 +404,7 @@ win32-setctime==1.2.0 ; sys_platform == 'win32'
 wrapt==1.17.3
     # via
     #   opentelemetry-instrumentation
+    #   opentelemetry-instrumentation-redis
     #   opentelemetry-instrumentation-sqlalchemy
 wsproto==1.3.2
     # via simple-websocket