Skip to content

refactor(boto): replace uses of SpanAttributes with opentelemetry.semconv.attributes #3538

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 4 commits into from
May 23, 2025
Merged

refactor(boto): replace uses of SpanAttributes with opentelemetry.semconv.attributes #3538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b64f519
refactor: migrate http_attributes from SpanAttributes to new semantic…
weslayer May 23, 2025
942fa6f
fix precommit linting
weslayer May 23, 2025
27a0bd9
Merge branch 'main' into weslayer/boto-span-replace
weslayer May 23, 2025
d20035c
Merge branch 'main' into weslayer/boto-span-replace
xrmx 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
13 changes: 6 additions & 7 deletions ...ion/opentelemetry-instrumentation-boto/src/opentelemetry/instrumentation/boto/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,10 @@
from opentelemetry.instrumentation.boto.version import __version__
from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
from opentelemetry.instrumentation.utils import unwrap
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.semconv._incubating.attributes.http_attributes import (
HTTP_METHOD,
HTTP_STATUS_CODE,
)
from opentelemetry.trace import SpanKind, get_tracer

logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -158,12 +161,8 @@ def _common_request( # pylint: disable=too-many-locals
for key, value in meta.items():
span.set_attribute(key, value)

span.set_attribute(
SpanAttributes.HTTP_STATUS_CODE, getattr(result, "status")
)
span.set_attribute(
SpanAttributes.HTTP_METHOD, getattr(result, "_method")
)
span.set_attribute(HTTP_STATUS_CODE, getattr(result, "status"))
span.set_attribute(HTTP_METHOD, getattr(result, "_method"))

return result

Expand Down
19 changes: 11 additions & 8 deletions instrumentation/opentelemetry-instrumentation-boto/tests/test_boto_instrumentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,16 @@
)

from opentelemetry.instrumentation.boto import BotoInstrumentor
from opentelemetry.semconv.trace import SpanAttributes
from opentelemetry.semconv._incubating.attributes.http_attributes import (
HTTP_METHOD,
HTTP_STATUS_CODE,
)
from opentelemetry.test.test_base import TestBase


def assert_span_http_status_code(span, code):
"""Assert on the span's 'http.status_code' tag"""
tag = span.attributes[SpanAttributes.HTTP_STATUS_CODE]
tag = span.attributes[HTTP_STATUS_CODE]
assert tag == code, f"{tag} != {code}"


Expand All @@ -60,7 +63,7 @@ def test_ec2_client(self):
span = spans[0]
self.assertEqual(span.attributes["aws.operation"], "DescribeInstances")
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "POST")
self.assertEqual(span.attributes[HTTP_METHOD], "POST")
self.assertEqual(span.attributes["aws.region"], "us-west-2")

# Create an instance
Expand All @@ -73,7 +76,7 @@ def test_ec2_client(self):
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes["endpoint"], "ec2")
self.assertEqual(span.attributes["http_method"], "runinstances")
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "POST")
self.assertEqual(span.attributes[HTTP_METHOD], "POST")
self.assertEqual(span.attributes["aws.region"], "us-west-2")
self.assertEqual(span.name, "ec2.command")

Expand Down Expand Up @@ -120,7 +123,7 @@ def test_s3_client(self):
self.assertEqual(len(spans), 1)
span = spans[0]
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "GET")
self.assertEqual(span.attributes[HTTP_METHOD], "GET")
self.assertEqual(span.attributes["aws.operation"], "get_all_buckets")

# Create a bucket command
Expand All @@ -130,7 +133,7 @@ def test_s3_client(self):
self.assertEqual(len(spans), 2)
span = spans[1]
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "PUT")
self.assertEqual(span.attributes[HTTP_METHOD], "PUT")
self.assertEqual(span.attributes["path"], "/")
self.assertEqual(span.attributes["aws.operation"], "create_bucket")

Expand All @@ -143,7 +146,7 @@ def test_s3_client(self):
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes["endpoint"], "s3")
self.assertEqual(span.attributes["http_method"], "head")
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "HEAD")
self.assertEqual(span.attributes[HTTP_METHOD], "HEAD")
self.assertEqual(span.attributes["aws.operation"], "head_bucket")
self.assertEqual(span.name, "s3.command")

Expand Down Expand Up @@ -240,7 +243,7 @@ def test_lambda_client(self):
assert_span_http_status_code(span, 200)
self.assertEqual(span.attributes["endpoint"], "lambda")
self.assertEqual(span.attributes["http_method"], "get")
self.assertEqual(span.attributes[SpanAttributes.HTTP_METHOD], "GET")
self.assertEqual(span.attributes[HTTP_METHOD], "GET")
self.assertEqual(span.attributes["aws.region"], "us-east-2")
self.assertEqual(span.attributes["aws.operation"], "list_functions")

Expand Down