Skip to content

fix(otel): leave pending invocation spans unset #599

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

Closed
zhongkechen wants to merge 1 commit into from
Closed

fix(otel): leave pending invocation spans unset #599

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 4 additions & 8 deletions ...e-execution-sdk-python-otel/src/aws_durable_execution_sdk_python_otel/execution_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,19 +285,15 @@ def on_invocation_end(self, info: InvocationEndInfo) -> None:

# End the invocation span regardless of terminal status. Record the
# invocation status and map it to a span status:
# SUCCEEDED/PENDING -> OK (this invocation did its work, whether it
# completed the execution or cleanly suspended)
# FAILED -> ERROR
# RETRY -> UNSET
# RETRY is left UNSET because the plugin interface cannot tell whether the
# execution/workflow was STOPPED or TIMED_OUT: a RETRY invocation is not a
# definitive failure of the execution, so we avoid marking the span ERROR.
# SUCCEEDED -> OK
# FAILED -> ERROR
# PENDING/RETRY -> UNSET
Comment thread
zhongkechen marked this conversation as resolved.
if self._invocation_span is not None:
self._invocation_span.set_attribute(
"durable.invocation.status",
info.status.value if info.status else "",
)
if info.status in (InvocationStatus.SUCCEEDED, InvocationStatus.PENDING):
if info.status is InvocationStatus.SUCCEEDED:
self._invocation_span.set_status(StatusCode.OK)
elif info.status is InvocationStatus.FAILED:
self._invocation_span.set_status(
Expand Down
9 changes: 3 additions & 6 deletions ...-execution-sdk-python-otel/src/aws_durable_execution_sdk_python_otel/invocation_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,12 +350,9 @@ def on_invocation_end(self, info: InvocationEndInfo) -> None:
invocation_span.set_attribute(
"durable.invocation.status", info.status.value
)
# Span status mapping: SUCCEEDED/PENDING -> OK, FAILED -> ERROR,
# RETRY -> UNSET. RETRY is left UNSET because the plugin interface
# cannot tell whether the execution/workflow was STOPPED or
# TIMED_OUT, so a RETRY invocation is not treated as a definitive
# failure of the execution.
if info.status in (InvocationStatus.SUCCEEDED, InvocationStatus.PENDING):
# Span status mapping: SUCCEEDED -> OK, FAILED -> ERROR, and
# non-terminal PENDING/RETRY -> UNSET.
if info.status is InvocationStatus.SUCCEEDED:
invocation_span.set_status(StatusCode.OK)
elif info.status is InvocationStatus.FAILED:
invocation_span.set_status(
Expand Down
5 changes: 2 additions & 3 deletions packages/aws-durable-execution-sdk-python-otel/tests/test_execution_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,15 +322,14 @@ def test_open_operation_span_not_exported_at_invocation_end():
@pytest.mark.parametrize(
("status", "expected_code"),
[
(InvocationStatus.PENDING, trace.StatusCode.OK),
(InvocationStatus.PENDING, trace.StatusCode.UNSET),
(InvocationStatus.SUCCEEDED, trace.StatusCode.OK),
(InvocationStatus.RETRY, trace.StatusCode.UNSET),
(InvocationStatus.FAILED, trace.StatusCode.ERROR),
],
)
def test_invocation_span_status_kind_and_attributes(status, expected_code):
"""Invocation span is INTERNAL, carries status/first; SUCCEEDED/PENDING are
OK, FAILED is ERROR, and RETRY is UNSET (STOPPED/TIMED_OUT indistinguishable)."""
"""Invocation span is INTERNAL and only terminal outcomes set span status."""
plugin, exporter = _create_plugin()
plugin.on_invocation_start(_invocation_start_info())
plugin.on_invocation_end(_invocation_end_info(status=status))
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-durable-execution-sdk-python-otel/tests/test_invocation_plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ def test_invocation_span_records_subsequent_invocation():
@pytest.mark.parametrize(
("invocation_status", "expected_span_status"),
[
(InvocationStatus.PENDING, StatusCode.OK),
(InvocationStatus.PENDING, StatusCode.UNSET),
(InvocationStatus.RETRY, StatusCode.UNSET),
(InvocationStatus.SUCCEEDED, StatusCode.OK),
(InvocationStatus.FAILED, StatusCode.ERROR),
Expand Down