Skip to content

✨ Add lifespan handling to tracing instrumentation and instrument rabbitmq rpc clients #7642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 33 commits into from
May 23, 2025
Merged

✨ Add lifespan handling to tracing instrumentation and instrument rabbitmq rpc clients #7642

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
dbb2722
add aio pika instrumentation dependency
bisgaard-itis May 6, 2025
2458561
upgrade dependency accross entire repo
bisgaard-itis May 6, 2025
8cf4d44
instrument aipika rabbit client
bisgaard-itis May 6, 2025
d85dcb1
add opentelemetry instrumentation celery dependency
bisgaard-itis May 6, 2025
273896e
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 6, 2025
0f685de
autoinstrument aiopika in aihttp case
bisgaard-itis May 6, 2025
c7c8469
remove asyncpg and aiopg instrumentation
bisgaard-itis May 6, 2025
8763e94
remove asyncpg instrumentation
bisgaard-itis May 6, 2025
bd45887
Revert "autoinstrument aiopika in aihttp case"
bisgaard-itis May 7, 2025
3755521
autoinstrument aiopika in aihttp case
bisgaard-itis May 6, 2025
b37c053
Revert "remove asyncpg instrumentation"
bisgaard-itis May 7, 2025
02523a7
Revert "remove asyncpg and aiopg instrumentation"
bisgaard-itis May 7, 2025
2601b2a
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 7, 2025
08397b0
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 12, 2025
d4c643a
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 12, 2025
d762da5
attempt to solve issue by fixing otel fixture
bisgaard-itis May 12, 2025
72fa339
ensure to delete env
bisgaard-itis May 12, 2025
6036749
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 19, 2025
660d00c
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 23, 2025
91a0f99
upgrade aiopika instrumentation lib after merging master
bisgaard-itis May 23, 2025
efa751c
add lifespan to tracing in fastapi case
bisgaard-itis May 23, 2025
2c6afb9
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 23, 2025
3840e07
use lifespan manager approach
bisgaard-itis May 23, 2025
90c14ea
disable pylint bare expose
bisgaard-itis May 23, 2025
c5e4c1b
add getter for tracing instrumentation lifespan
bisgaard-itis May 23, 2025
dabc522
fix pylint
bisgaard-itis May 23, 2025
10689e9
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 23, 2025
e7ae167
remove call to private method
bisgaard-itis May 23, 2025
9b7bd1a
add lifespan management to tracing instrumentation in aiohttp
bisgaard-itis May 23, 2025
bd81753
make pylint happy
bisgaard-itis May 23, 2025
6466494
assert app
bisgaard-itis May 23, 2025
8458404
ensure lifespan manager works for fastapi
bisgaard-itis May 23, 2025
f545694
Merge branch 'master' into 7634-opentelemetry-instrument-rpc-clients
bisgaard-itis May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/aws-library/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ opentelemetry-api==1.30.0
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-botocore
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
Expand All @@ -164,10 +165,13 @@ opentelemetry-exporter-otlp-proto-http==1.30.0
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.51b0
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-botocore
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.51b0
# via -r requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-botocore==0.51b0
# via -r requirements/_base.in
opentelemetry-instrumentation-logging==0.51b0
Expand Down Expand Up @@ -431,6 +435,7 @@ wrapt==1.17.2
# aiobotocore
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-redis
yarl==1.18.3
# via
Expand Down
1 change: 1 addition & 0 deletions packages/service-library/requirements/_base.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ arrow # date/time
faststream
opentelemetry-api
opentelemetry-exporter-otlp
opentelemetry-instrumentation-aio-pika
opentelemetry-instrumentation-logging
opentelemetry-instrumentation-redis
opentelemetry-instrumentation-requests
Expand Down
5 changes: 5 additions & 0 deletions packages/service-library/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ opentelemetry-api==1.30.0
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
Expand All @@ -120,9 +121,12 @@ opentelemetry-exporter-otlp-proto-http==1.30.0
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.51b0
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.51b0
# via -r requirements/_base.in
opentelemetry-instrumentation-logging==0.51b0
# via -r requirements/_base.in
opentelemetry-instrumentation-redis==0.51b0
Expand Down Expand Up @@ -297,6 +301,7 @@ wrapt==1.17.2
# via
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-redis
yarl==1.18.3
# via
Expand Down
23 changes: 19 additions & 4 deletions packages/service-library/src/servicelib/aiohttp/tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
""" Adds aiohttp middleware for tracing using opentelemetry instrumentation.

"""
"""Adds aiohttp middleware for tracing using opentelemetry instrumentation."""

import logging

Expand Down Expand Up @@ -44,6 +42,13 @@
except ImportError:
HAS_REQUESTS = False

try:
from opentelemetry.instrumentation.aio_pika import AioPikaInstrumentor

HAS_AIO_PIKA = True
except ImportError:
HAS_AIO_PIKA = False


def setup_tracing(
app: web.Application,
Expand Down Expand Up @@ -74,7 +79,9 @@ def setup_tracing(
trace.set_tracer_provider(TracerProvider(resource=resource))
tracer_provider: trace.TracerProvider = trace.get_tracer_provider()

tracing_destination: str = f"{URL(opentelemetry_collector_endpoint).with_port(opentelemetry_collector_port).with_path('/v1/traces')}"
tracing_destination: str = (
f"{URL(opentelemetry_collector_endpoint).with_port(opentelemetry_collector_port).with_path('/v1/traces')}"
)

_logger.info(
"Trying to connect service %s to tracing collector at %s.",
Expand Down Expand Up @@ -128,3 +135,11 @@ def setup_tracing(
msg="Attempting to add requests opentelemetry autoinstrumentation...",
):
RequestsInstrumentor().instrument()

if HAS_AIO_PIKA:
with log_context(
_logger,
logging.INFO,
msg="Attempting to add aio_pika opentelemetry autoinstrumentation...",
):
AioPikaInstrumentor().instrument()
24 changes: 20 additions & 4 deletions packages/service-library/src/servicelib/fastapi/tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
""" Adds fastapi middleware for tracing using opentelemetry instrumentation.

"""
"""Adds fastapi middleware for tracing using opentelemetry instrumentation."""

import logging

Expand Down Expand Up @@ -60,6 +58,15 @@
except ImportError:
HAS_REQUESTS = False

try:
from opentelemetry.instrumentation.aio_pika.aio_pika_instrumentor import (
AioPikaInstrumentor,
)

HAS_AIOPIKA_INSTRUMENTOR = True
except ImportError:
HAS_AIOPIKA_INSTRUMENTOR = False


def initialize_tracing(
app: FastAPI, tracing_settings: TracingSettings, service_name: str
Expand All @@ -80,7 +87,9 @@ def initialize_tracing(
f"{tracing_settings.TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT}"
)

tracing_destination: str = f"{URL(opentelemetry_collector_endpoint).with_port(tracing_settings.TRACING_OPENTELEMETRY_COLLECTOR_PORT).with_path('/v1/traces')}"
tracing_destination: str = (
f"{URL(opentelemetry_collector_endpoint).with_port(tracing_settings.TRACING_OPENTELEMETRY_COLLECTOR_PORT).with_path('/v1/traces')}"
)

_logger.info(
"Trying to connect service %s to opentelemetry tracing collector at %s.",
Expand All @@ -101,6 +110,13 @@ def initialize_tracing(
msg="Attempting to add asyncpg opentelemetry autoinstrumentation...",
):
AiopgInstrumentor().instrument()
if HAS_AIOPIKA_INSTRUMENTOR:
with log_context(
_logger,
logging.INFO,
msg="Attempting to add aio_pika opentelemetry autoinstrumentation...",
):
AioPikaInstrumentor().instrument()
if HAS_ASYNCPG:
with log_context(
_logger,
Expand Down
3 changes: 1 addition & 2 deletions packages/service-library/src/servicelib/rabbitmq/_client_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,4 @@ async def ping(self) -> bool:
return False

@abstractmethod
async def close(self) -> None:
...
async def close(self) -> None: ...
9 changes: 9 additions & 0 deletions packages/service-library/tests/aiohttp/test_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,23 @@ def tracing_settings_in(request):
def set_and_clean_settings_env_vars(
monkeypatch: pytest.MonkeyPatch, tracing_settings_in
):
endpoint_mocked = False
if tracing_settings_in[0]:
endpoint_mocked = True
monkeypatch.setenv(
"TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT", f"{tracing_settings_in[0]}"
)
port_mocked = False
if tracing_settings_in[1]:
port_mocked = True
monkeypatch.setenv(
"TRACING_OPENTELEMETRY_COLLECTOR_PORT", f"{tracing_settings_in[1]}"
)
yield
if endpoint_mocked:
monkeypatch.delenv("TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT")
if port_mocked:
monkeypatch.delenv("TRACING_OPENTELEMETRY_COLLECTOR_PORT")


@pytest.mark.parametrize(
Expand Down
9 changes: 9 additions & 0 deletions packages/service-library/tests/fastapi/test_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,23 @@ def tracing_settings_in(request: pytest.FixtureRequest) -> dict[str, Any]:
def set_and_clean_settings_env_vars(
monkeypatch: pytest.MonkeyPatch, tracing_settings_in: Callable[[], dict[str, Any]]
) -> None:
endpoint_mocked = False
if tracing_settings_in[0]:
endpoint_mocked = True
monkeypatch.setenv(
"TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT", f"{tracing_settings_in[0]}"
)
port_mocked = False
if tracing_settings_in[1]:
port_mocked = True
monkeypatch.setenv(
"TRACING_OPENTELEMETRY_COLLECTOR_PORT", f"{tracing_settings_in[1]}"
)
yield
if endpoint_mocked:
monkeypatch.delenv("TRACING_OPENTELEMETRY_COLLECTOR_ENDPOINT")
if port_mocked:
monkeypatch.delenv("TRACING_OPENTELEMETRY_COLLECTOR_PORT")


@pytest.mark.parametrize(
Expand Down
5 changes: 5 additions & 0 deletions packages/simcore-sdk/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ opentelemetry-api==1.30.0
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
Expand All @@ -174,10 +175,13 @@ opentelemetry-exporter-otlp-proto-http==1.30.0
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.51b0
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.51b0
# via -r requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-asyncpg==0.51b0
# via -r requirements/../../../packages/postgres-database/requirements/_base.in
opentelemetry-instrumentation-logging==0.51b0
Expand Down Expand Up @@ -469,6 +473,7 @@ wrapt==1.17.2
# via
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-redis
yarl==1.18.3
# via
Expand Down
5 changes: 5 additions & 0 deletions services/agent/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ opentelemetry-api==1.30.0
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-fastapi
# opentelemetry-instrumentation-httpx
Expand All @@ -177,12 +178,15 @@ opentelemetry-exporter-otlp-proto-http==1.30.0
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.51b0
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-fastapi
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.51b0
# via -r requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-asgi==0.51b0
# via opentelemetry-instrumentation-fastapi
opentelemetry-instrumentation-fastapi==0.51b0
Expand Down Expand Up @@ -456,6 +460,7 @@ wrapt==1.17.2
# via
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-redis
yarl==1.18.3
Expand Down
7 changes: 7 additions & 0 deletions services/api-server/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@ opentelemetry-api==1.28.2
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-fastapi
Expand All @@ -371,13 +372,18 @@ opentelemetry-exporter-otlp-proto-http==1.28.2
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.49b2
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-fastapi
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.49b2
# via
# -r requirements/../../../packages/service-library/requirements/_base.in
# -r requirements/../../../packages/simcore-sdk/requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-asgi==0.49b2
# via opentelemetry-instrumentation-fastapi
opentelemetry-instrumentation-asyncpg==0.49b2
Expand Down Expand Up @@ -930,6 +936,7 @@ wrapt==1.17.0
# via
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-redis
yarl==1.18.3
Expand Down
7 changes: 7 additions & 0 deletions services/autoscaling/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ opentelemetry-api==1.28.2
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-botocore
# opentelemetry-instrumentation-fastapi
Expand All @@ -325,13 +326,18 @@ opentelemetry-exporter-otlp-proto-http==1.28.2
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.49b2
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-botocore
# opentelemetry-instrumentation-fastapi
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.49b2
# via
# -r requirements/../../../packages/aws-library/requirements/../../../packages/service-library/requirements/_base.in
# -r requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-asgi==0.49b2
# via opentelemetry-instrumentation-fastapi
opentelemetry-instrumentation-botocore==0.49b2
Expand Down Expand Up @@ -813,6 +819,7 @@ wrapt==1.17.0
# aiobotocore
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-redis
yarl==1.18.3
Expand Down
5 changes: 5 additions & 0 deletions services/catalog/requirements/_base.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ opentelemetry-api==1.31.0
# opentelemetry-exporter-otlp-proto-grpc
# opentelemetry-exporter-otlp-proto-http
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-fastapi
Expand All @@ -244,13 +245,16 @@ opentelemetry-exporter-otlp-proto-http==1.31.0
# via opentelemetry-exporter-otlp
opentelemetry-instrumentation==0.52b0
# via
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-asgi
# opentelemetry-instrumentation-asyncpg
# opentelemetry-instrumentation-fastapi
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-logging
# opentelemetry-instrumentation-redis
# opentelemetry-instrumentation-requests
opentelemetry-instrumentation-aio-pika==0.52b0
# via -r requirements/../../../packages/service-library/requirements/_base.in
opentelemetry-instrumentation-asgi==0.52b0
# via opentelemetry-instrumentation-fastapi
opentelemetry-instrumentation-asyncpg==0.52b0
Expand Down Expand Up @@ -610,6 +614,7 @@ wrapt==1.17.2
# via
# deprecated
# opentelemetry-instrumentation
# opentelemetry-instrumentation-aio-pika
# opentelemetry-instrumentation-httpx
# opentelemetry-instrumentation-redis
yarl==1.18.3
Expand Down
Loading
Loading