Skip to content

refactor: semcov opentelemetry instrumentation aio pika #3667

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
+64 −35
Open

refactor: semcov opentelemetry instrumentation aio pika #3667

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f31d777
feat: refactor semcov opentelemetry-instrumentation
EzzioMoreira Jul 4, 2025
97a1e3d
fix: return shema senconv
EzzioMoreira Jul 11, 2025
3571a6f
Merge branch 'main' into refactor/opentelemetry-instrumentations-semcov
EzzioMoreira Jul 26, 2025
123e334
Merge branch 'main' into refactor/opentelemetry-instrumentations-semcov
EzzioMoreira Jul 31, 2025
cff86f4
refactor: opentelemetry-instrumentation-aio-pika
EzzioMoreira Jul 31, 2025
a754cff
fix: revert unintended changes to _semconv.py
EzzioMoreira Jul 31, 2025
a38dd2c
fix: change schema
EzzioMoreira Aug 5, 2025
59bc139
fix: change schema
EzzioMoreira Aug 5, 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
30 changes: 20 additions & 10 deletions ...metry-instrumentation-aio-pika/src/opentelemetry/instrumentation/aio_pika/span_builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,23 @@
from aio_pika.abc import AbstractChannel, AbstractMessage

from opentelemetry.instrumentation.utils import is_instrumentation_enabled
from opentelemetry.semconv._incubating.attributes.messaging_attributes import (
MESSAGING_MESSAGE_CONVERSATION_ID,
MESSAGING_MESSAGE_ID,
MESSAGING_OPERATION,
MESSAGING_SYSTEM,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
)
from opentelemetry.semconv.trace import (
MessagingOperationValues,
SpanAttributes,
)
from opentelemetry.trace import Span, SpanKind, Tracer

_DEFAULT_ATTRIBUTES = {SpanAttributes.MESSAGING_SYSTEM: "rabbitmq"}
_DEFAULT_ATTRIBUTES = {MESSAGING_SYSTEM: "rabbitmq"}


class SpanBuilder:
Expand All @@ -44,6 +54,8 @@ def set_operation(self, operation: MessagingOperationValues):

def set_destination(self, destination: str):
self._destination = destination
# TODO: Update this implementation once the semantic conventions for messaging stabilize
# See: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/messaging.md
self._attributes[SpanAttributes.MESSAGING_DESTINATION] = destination

def set_channel(self, channel: AbstractChannel):
Expand All @@ -61,30 +73,28 @@ def set_channel(self, channel: AbstractChannel):
url = connection.url
self._attributes.update(
{
SpanAttributes.NET_PEER_NAME: url.host,
SpanAttributes.NET_PEER_PORT: url.port or 5672,
NET_PEER_NAME: url.host,
NET_PEER_PORT: url.port or 5672,
}
)

def set_message(self, message: AbstractMessage):
properties = message.properties
if properties.message_id:
self._attributes[SpanAttributes.MESSAGING_MESSAGE_ID] = (
properties.message_id
)
self._attributes[MESSAGING_MESSAGE_ID] = properties.message_id
if properties.correlation_id:
self._attributes[SpanAttributes.MESSAGING_CONVERSATION_ID] = (
self._attributes[MESSAGING_MESSAGE_CONVERSATION_ID] = (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a different attribute

Copy link
Member

@emdneto emdneto Aug 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, that's true. missed that @EzzioMoreira can you fix that?

properties.correlation_id
)

def build(self) -> Optional[Span]:
if not is_instrumentation_enabled():
return None
if self._operation:
self._attributes[SpanAttributes.MESSAGING_OPERATION] = (
self._operation.value
)
self._attributes[MESSAGING_OPERATION] = self._operation.value
else:
# TODO: Update this implementation once the semantic conventions for messaging stabilize
# See: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/messaging.md
self._attributes[SpanAttributes.MESSAGING_TEMP_DESTINATION] = True
span = self._tracer.start_span(
self._generate_span_name(),
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/opentelemetry-instrumentation-aio-pika/tests/consts.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
AIOPIKA_VERSION_INFO = tuple(int(v) for v in aiopika_version.split("."))
MESSAGE_ID = "meesage_id"
CORRELATION_ID = "correlation_id"
MESSAGING_SYSTEM = "rabbitmq"
MESSAGING_SYSTEM_VALUE = "rabbitmq"
EXCHANGE_NAME = "exchange_name"
QUEUE_NAME = "queue_name"
ROUTING_KEY = "routing_key"
Expand Down
36 changes: 23 additions & 13 deletions instrumentation/opentelemetry-instrumentation-aio-pika/tests/test_callback_decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@
from opentelemetry.instrumentation.aio_pika.callback_decorator import (
CallbackDecorator,
)
from opentelemetry.semconv._incubating.attributes.messaging_attributes import (
MESSAGING_MESSAGE_CONVERSATION_ID,
MESSAGING_MESSAGE_ID,
MESSAGING_OPERATION,
MESSAGING_SYSTEM,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
)
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.trace import SpanKind, get_tracer

Expand All @@ -30,7 +40,7 @@
EXCHANGE_NAME,
MESSAGE,
MESSAGE_ID,
MESSAGING_SYSTEM,
MESSAGING_SYSTEM_VALUE,
QUEUE_NAME,
SERVER_HOST,
SERVER_PORT,
Expand All @@ -40,13 +50,13 @@
@skipIf(AIOPIKA_VERSION_INFO >= (8, 0), "Only for aio_pika 7")
class TestInstrumentedQueueAioRmq7(TestCase):
EXPECTED_ATTRIBUTES = {
SpanAttributes.MESSAGING_SYSTEM: MESSAGING_SYSTEM,
MESSAGING_SYSTEM: MESSAGING_SYSTEM_VALUE,
SpanAttributes.MESSAGING_DESTINATION: EXCHANGE_NAME,
SpanAttributes.NET_PEER_NAME: SERVER_HOST,
SpanAttributes.NET_PEER_PORT: SERVER_PORT,
SpanAttributes.MESSAGING_MESSAGE_ID: MESSAGE_ID,
SpanAttributes.MESSAGING_CONVERSATION_ID: CORRELATION_ID,
SpanAttributes.MESSAGING_OPERATION: "receive",
NET_PEER_NAME: SERVER_HOST,
NET_PEER_PORT: SERVER_PORT,
MESSAGING_MESSAGE_ID: MESSAGE_ID,
MESSAGING_MESSAGE_CONVERSATION_ID: CORRELATION_ID,
MESSAGING_OPERATION: "receive",
}

def setUp(self):
Expand Down Expand Up @@ -80,13 +90,13 @@ def test_decorate_callback(self):
@skipIf(AIOPIKA_VERSION_INFO <= (8, 0), "Only for aio_pika 8")
class TestInstrumentedQueueAioRmq8(TestCase):
EXPECTED_ATTRIBUTES = {
SpanAttributes.MESSAGING_SYSTEM: MESSAGING_SYSTEM,
MESSAGING_SYSTEM: MESSAGING_SYSTEM_VALUE,
SpanAttributes.MESSAGING_DESTINATION: EXCHANGE_NAME,
SpanAttributes.NET_PEER_NAME: SERVER_HOST,
SpanAttributes.NET_PEER_PORT: SERVER_PORT,
SpanAttributes.MESSAGING_MESSAGE_ID: MESSAGE_ID,
SpanAttributes.MESSAGING_CONVERSATION_ID: CORRELATION_ID,
SpanAttributes.MESSAGING_OPERATION: "receive",
NET_PEER_NAME: SERVER_HOST,
NET_PEER_PORT: SERVER_PORT,
MESSAGING_MESSAGE_ID: MESSAGE_ID,
MESSAGING_MESSAGE_CONVERSATION_ID: CORRELATION_ID,
MESSAGING_OPERATION: "receive",
}

def setUp(self):
Expand Down
31 changes: 20 additions & 11 deletions instrumentation/opentelemetry-instrumentation-aio-pika/tests/test_publish_decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@
from opentelemetry.instrumentation.aio_pika.publish_decorator import (
PublishDecorator,
)
from opentelemetry.semconv._incubating.attributes.messaging_attributes import (
MESSAGING_MESSAGE_CONVERSATION_ID,
MESSAGING_MESSAGE_ID,
MESSAGING_SYSTEM,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
)
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.trace import SpanKind, get_tracer

Expand All @@ -34,7 +43,7 @@
EXCHANGE_NAME,
MESSAGE,
MESSAGE_ID,
MESSAGING_SYSTEM,
MESSAGING_SYSTEM_VALUE,
ROUTING_KEY,
SERVER_HOST,
SERVER_PORT,
Expand All @@ -44,12 +53,12 @@
@skipIf(AIOPIKA_VERSION_INFO >= (8, 0), "Only for aio_pika 7")
class TestInstrumentedExchangeAioRmq7(TestCase):
EXPECTED_ATTRIBUTES = {
SpanAttributes.MESSAGING_SYSTEM: MESSAGING_SYSTEM,
MESSAGING_SYSTEM: MESSAGING_SYSTEM_VALUE,
SpanAttributes.MESSAGING_DESTINATION: f"{EXCHANGE_NAME},{ROUTING_KEY}",
SpanAttributes.NET_PEER_NAME: SERVER_HOST,
SpanAttributes.NET_PEER_PORT: SERVER_PORT,
SpanAttributes.MESSAGING_MESSAGE_ID: MESSAGE_ID,
SpanAttributes.MESSAGING_CONVERSATION_ID: CORRELATION_ID,
NET_PEER_NAME: SERVER_HOST,
NET_PEER_PORT: SERVER_PORT,
MESSAGING_MESSAGE_ID: MESSAGE_ID,
MESSAGING_MESSAGE_CONVERSATION_ID: CORRELATION_ID,
SpanAttributes.MESSAGING_TEMP_DESTINATION: True,
}

Expand Down Expand Up @@ -123,12 +132,12 @@ def test_publish_works_with_not_recording_span_robust(self):
@skipIf(AIOPIKA_VERSION_INFO <= (8, 0), "Only for aio_pika 8")
class TestInstrumentedExchangeAioRmq8(TestCase):
EXPECTED_ATTRIBUTES = {
SpanAttributes.MESSAGING_SYSTEM: MESSAGING_SYSTEM,
MESSAGING_SYSTEM: MESSAGING_SYSTEM_VALUE,
SpanAttributes.MESSAGING_DESTINATION: f"{EXCHANGE_NAME},{ROUTING_KEY}",
SpanAttributes.NET_PEER_NAME: SERVER_HOST,
SpanAttributes.NET_PEER_PORT: SERVER_PORT,
SpanAttributes.MESSAGING_MESSAGE_ID: MESSAGE_ID,
SpanAttributes.MESSAGING_CONVERSATION_ID: CORRELATION_ID,
NET_PEER_NAME: SERVER_HOST,
NET_PEER_PORT: SERVER_PORT,
MESSAGING_MESSAGE_ID: MESSAGE_ID,
MESSAGING_MESSAGE_CONVERSATION_ID: CORRELATION_ID,
SpanAttributes.MESSAGING_TEMP_DESTINATION: True,
}

Expand Down