Skip to content
Open
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .changelog/4725.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`opentelemetry-instrumentation-asyncpg`: migrate to stable database and server semantic conventions
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,15 @@ 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._incubating.attributes.db_attributes import (
DB_NAME,
DB_STATEMENT,
DB_SYSTEM,
DB_USER,
DbSystemValues,
from opentelemetry.semconv.attributes.db_attributes import (
DB_NAMESPACE,
DB_QUERY_TEXT,
DB_SYSTEM_NAME,
DbSystemNameValues,
)
from opentelemetry.semconv._incubating.attributes.net_attributes import (
NET_PEER_NAME,
NET_PEER_PORT,
NET_TRANSPORT,
NetTransportValues,
from opentelemetry.semconv.attributes.server_attributes import (
SERVER_ADDRESS,
SERVER_PORT,
)
from opentelemetry.trace import SpanKind
from opentelemetry.trace.status import Status, StatusCode
Expand All @@ -77,32 +74,27 @@ async def main():

def _hydrate_span_from_args(connection, query, parameters) -> dict:
"""Get network and database attributes from connection."""
span_attributes = {DB_SYSTEM: DbSystemValues.POSTGRESQL.value}
span_attributes = {DB_SYSTEM_NAME: DbSystemNameValues.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[DB_NAME] = dbname
user = getattr(params, "user", None)
if user:
span_attributes[DB_USER] = user
span_attributes[DB_NAMESPACE] = dbname

# 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[NET_PEER_NAME] = addr[0]
span_attributes[NET_PEER_PORT] = addr[1]
span_attributes[NET_TRANSPORT] = NetTransportValues.IP_TCP.value
span_attributes[SERVER_ADDRESS] = addr[0]
span_attributes[SERVER_PORT] = addr[1]
elif isinstance(addr, str):
span_attributes[NET_PEER_NAME] = addr
span_attributes[NET_TRANSPORT] = NetTransportValues.OTHER.value
span_attributes[SERVER_ADDRESS] = addr

if query is not None:
span_attributes[DB_STATEMENT] = query
span_attributes[DB_QUERY_TEXT] = query

if parameters is not None and len(parameters) > 0:
span_attributes["db.statement.parameters"] = str(parameters)
Expand All @@ -127,7 +119,7 @@ def _instrument(self, **kwargs):
__name__,
__version__,
tracer_provider,
schema_url="https://opentelemetry.io/schemas/1.11.0",
schema_url="https://opentelemetry.io/schemas/1.29.0",
)

for method in [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
_PREPARED_STMT_METHODS,
AsyncPGInstrumentor,
)
from opentelemetry.semconv.attributes.db_attributes import (
DB_QUERY_TEXT,
DB_SYSTEM_NAME,
DbSystemNameValues,
)
from opentelemetry.test.test_base import TestBase


Expand Down Expand Up @@ -243,10 +248,11 @@ def test_prepared_statement_span(self):
self.assertEqual(spans[0].name, expected_name)
self.assertTrue(spans[0].status.is_ok)
self.assertEqual(
spans[0].attributes.get("db.statement"), query
spans[0].attributes.get(DB_QUERY_TEXT), query
)
self.assertEqual(
spans[0].attributes.get("db.system"), "postgresql"
spans[0].attributes.get(DB_SYSTEM_NAME),
DbSystemNameValues.POSTGRESQL.value,
)

apg.uninstrument()
Expand Down