Skip to content
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

Validate links at span creation #3991

Merged
merged 8 commits into from
Jun 24, 2024
Merged
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
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#3973](https://github.com/open-telemetry/opentelemetry-python/pull/3966))
- Update semantic conventions to version 1.26.0.
([#3964](https://github.com/open-telemetry/opentelemetry-python/pull/3964))
- Use semconv exception attributes for record exceptions in spans
- Use semconv exception attributes for record exceptions in spans
([#3979](https://github.com/open-telemetry/opentelemetry-python/pull/3979))
- Validate links at span creation
([#3991](https://github.com/open-telemetry/opentelemetry-python/pull/3991))

## Version 1.25.0/0.46b0 (2024-05-30)

Expand Down
29 changes: 17 additions & 12 deletions opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -816,25 +816,30 @@ def __init__(
)
self._events.append(event)

if links is None:
self._links = self._new_links()
else:
for link in links:
link._attributes = BoundedAttributes(
self._limits.max_link_attributes,
link.attributes,
max_value_len=self._limits.max_attribute_length,
)
self._links = BoundedList.from_seq(self._limits.max_links, links)
self._links = self._new_links(links)

def __repr__(self):
return f'{type(self).__name__}(name="{self._name}", context={self._context})'

def _new_events(self):
return BoundedList(self._limits.max_events)

def _new_links(self):
return BoundedList(self._limits.max_links)
def _new_links(self, links: Sequence[trace_api.Link]):
if not links:
return BoundedList(self._limits.max_links)

valid_links = []
for link in links:
if link and _is_valid_link(link.context, link.attributes):
lzchen marked this conversation as resolved.
Show resolved Hide resolved
# pylint: disable=protected-access
link._attributes = BoundedAttributes(
self._limits.max_link_attributes,
link.attributes,
max_value_len=self._limits.max_attribute_length,
)
valid_links.append(link)

return BoundedList.from_seq(self._limits.max_links, valid_links)

def get_span_context(self):
return self._context
Expand Down
25 changes: 25 additions & 0 deletions opentelemetry-sdk/tests/trace/test_trace.py
Original file line number Diff line number Diff line change
Expand Up @@ -954,14 +954,29 @@ def test_add_link_with_invalid_span_context(self):
root.add_link(None)
self.assertEqual(len(root.links), 0)

with self.tracer.start_as_current_span(
"root", links=[trace_api.Link(other_context), None]
) as root:
self.assertEqual(len(root.links), 0)

def test_add_link_with_invalid_span_context_with_attributes(self):
invalid_context = trace_api.INVALID_SPAN_CONTEXT

with self.tracer.start_as_current_span("root") as root:
root.add_link(invalid_context)
root.add_link(invalid_context, {"name": "neighbor"})
self.assertEqual(len(root.links), 1)
self.assertEqual(root.links[0].attributes, {"name": "neighbor"})

with self.tracer.start_as_current_span(
"root",
links=[
trace_api.Link(invalid_context, {"name": "neighbor"}),
trace_api.Link(invalid_context),
],
) as root:
self.assertEqual(len(root.links), 1)

def test_add_link_with_invalid_span_context_with_tracestate(self):
invalid_context = trace.SpanContext(
trace_api.INVALID_TRACE_ID,
Expand All @@ -972,9 +987,19 @@ def test_add_link_with_invalid_span_context_with_tracestate(self):

with self.tracer.start_as_current_span("root") as root:
root.add_link(invalid_context)
root.add_link(trace_api.INVALID_SPAN_CONTEXT)
self.assertEqual(len(root.links), 1)
self.assertEqual(root.links[0].context.trace_state, "foo=bar")

with self.tracer.start_as_current_span(
"root",
links=[
trace_api.Link(invalid_context),
trace_api.Link(trace_api.INVALID_SPAN_CONTEXT),
],
) as root:
self.assertEqual(len(root.links), 1)

def test_update_name(self):
with self.tracer.start_as_current_span("root") as root:
# name
Expand Down
Loading