llm_observability: document prompt_uuid for OTel Prompt Tracking - #39675
Draft
yahya-mouman wants to merge 2 commits into
Draft
llm_observability: document prompt_uuid for OTel Prompt Tracking#39675yahya-mouman wants to merge 2 commits into
yahya-mouman wants to merge 2 commits into
Conversation
Adds prompt_uuid and prompt_version_uuid to the OpenTelemetry Prompt Tracking field table. Without these, a span tagged via the _dd.ml_obs.prompt_tracking OTel attribute is tracked but does not link back to its Prompt Management registry entry in the Prompts view - this matters for any language without a native Agent Observability SDK (e.g. .NET) using the REST Prompt Management API alongside plain OTel instrumentation.
Contributor
Preview links (active after the
|
Adds prompt_uuid and prompt_version_uuid to the Agent Observability HTTP API's Prompt schema table, matching the OTel Prompt Tracking field table update in this PR. Without these, a prompt submitted through the raw Spans API is tracked but does not link back to its Prompt Management registry entry.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Adds
prompt_uuidandprompt_version_uuidto the field tables for:_dd.ml_obs.prompt_trackingspan attribute)PromptobjectBoth tables previously documented only
id/name/version(plus template, variables, and RAG fields). If a prompt is fetched from the Prompt Management registry (for example, through the Prompt Management REST API, in a language without a native Agent Observability SDK) and then tagged onto a span through OTel or the raw HTTP API,id/versionalone aren't enough for that span to link back to its Prompt Management registry entry in the Prompts view. This PR adds the two missing fields to both tables and a short note explaining when they're needed.Merge readiness
For Datadog employees:
<name>/<description>convention and include the forward slash (/). If you've already created your PR with an incorrect branch name, please rename your branch and open a fresh PR./reviewto run an automated check that catches common issues before a Documentation team member reviews your PR.AI assistance
Used to draft the field-table wording and confirm field usage before proposing this docs change.
Additional notes