Skip to content

Refactor asyncpg : replace uses of SpanAttributes with opentelemetry.semconv.attributes #3505

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.

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 5 commits into from
May 15, 2025
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -60,49 +60,51 @@ async def main():
from opentelemetry.instrumentation.asyncpg.version import __version__
from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
from opentelemetry.instrumentation.utils import unwrap
from opentelemetry.semconv.trace import (
from opentelemetry.semconv._incubating.attributes.db_attributes import (
DB_NAME,
DB_STATEMENT,
DB_SYSTEM,
DB_USER,
DbSystemValues,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
NET_TRANSPORT,
NetTransportValues,
SpanAttributes,
)
from opentelemetry.trace import SpanKind
from opentelemetry.trace.status import Status, StatusCode


def _hydrate_span_from_args(connection, query, parameters) -> dict:
"""Get network and database attributes from connection."""
span_attributes = {
SpanAttributes.DB_SYSTEM: DbSystemValues.POSTGRESQL.value
}
span_attributes = {DB_SYSTEM: DbSystemValues.POSTGRESQL.value}

# connection contains _params attribute which is a namedtuple ConnectionParameters.
# https://github.com/MagicStack/asyncpg/blob/master/asyncpg/connection.py#L68

params = getattr(connection, "_params", None)
dbname = getattr(params, "database", None)
if dbname:
span_attributes[SpanAttributes.DB_NAME] = dbname
span_attributes[DB_NAME] = dbname
user = getattr(params, "user", None)
if user:
span_attributes[SpanAttributes.DB_USER] = user
span_attributes[DB_USER] = user

# connection contains _addr attribute which is either a host/port tuple, or unix socket string
# https://magicstack.github.io/asyncpg/current/_modules/asyncpg/connection.html
addr = getattr(connection, "_addr", None)
if isinstance(addr, tuple):
span_attributes[SpanAttributes.NET_PEER_NAME] = addr[0]
span_attributes[SpanAttributes.NET_PEER_PORT] = addr[1]
span_attributes[SpanAttributes.NET_TRANSPORT] = (
NetTransportValues.IP_TCP.value
)
span_attributes[NET_PEER_NAME] = addr[0]
span_attributes[NET_PEER_PORT] = addr[1]
span_attributes[NET_TRANSPORT] = NetTransportValues.IP_TCP.value
elif isinstance(addr, str):
span_attributes[SpanAttributes.NET_PEER_NAME] = addr
span_attributes[SpanAttributes.NET_TRANSPORT] = (
NetTransportValues.OTHER.value
)
span_attributes[NET_PEER_NAME] = addr
span_attributes[NET_TRANSPORT] = NetTransportValues.OTHER.value

if query is not None:
span_attributes[SpanAttributes.DB_STATEMENT] = query
span_attributes[DB_STATEMENT] = query

if parameters is not None and len(parameters) > 0:
span_attributes["db.statement.parameters"] = str(parameters)
Expand Down