Skip to content

chore: updated semantic conventions on Generative AI spans #319

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

poshinchen
Copy link
Contributor

Description

Update semantic conventions for Gen-AI spans

refs:

  1. https://opentelemetry.io/docs/specs/semconv/registry/attributes/gen-ai/
  2. https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-agent-spans/#invoke-agent-span
  3. https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-spans/#execute-tool-span
  4. https://opentelemetry.io/docs/specs/semconv/gen-ai/gen-ai-events/#event-gen_aitoolmessage

Related Issues

https://github.com/strands-agents/private-sdk-python-staging/issues/77

Documentation PR

Will update the doc

Type of Change

Other (please describe):
chore: semantic conventions

Testing

How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli

  • I ran hatch run prepare
  • I ran manual tests and view the spans

Checklist

  • I have read the CONTRIBUTING document
  • I have added any necessary tests that prove my fix is effective or my feature works
  • [] I have updated the documentation accordingly
  • [] I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
  • My changes generate no new warnings
  • Any dependent changes have been merged and published

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@poshinchen poshinchen requested a review from a team July 1, 2025 03:32
@poshinchen poshinchen self-assigned this Jul 1, 2025
@poshinchen poshinchen marked this pull request as ready for review July 1, 2025 03:33
self._add_event(
span,
"gen_ai.choice",
event_attributes={"finish_reason": "stop", "message": serialize(message["content"])},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just curious: shouldn't the finish_reason be provided by the model? https://docs.anthropic.com/en/api/handling-stop-reasons

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will pass them!

parent_span: Optional[Span] = None,
messages: Optional[Messages] = None,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just confirming that it's safe to remove the Optional here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, the source was not None

self._end_span(span, attributes, error)
event_attributes["tool.result"] = serialize(tool_result_message["content"])
self._add_event(span, "gen_ai.choice", event_attributes=event_attributes)
self._end_span(span, {}, error)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i noticed above that the event did not have attributes added and instead the attributes where added to the span. why is it the opposite here - attributes are added to the event but not the span?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

they are actually the same span, and start_event_loop_cycle_span has the attributes that we want to add, but for end_event_loop_cycle_span, ""gen_ai.completion"" and "tool.result" should not be in the attributes.

In the future we might have additional attributes to add, I can create an empty attributes (attributes = {}) first.

@poshinchen poshinchen force-pushed the chore/semantic-conventions branch from 7a23cb0 to a4fae57 Compare July 1, 2025 15:37
@poshinchen poshinchen requested review from jer96 and a team July 1, 2025 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants