docs: add governed tool action metadata example - #417
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds a non-normative documentation example showing how to attach application-specific governance metadata to an execute_tool span for tool calls that are gated by approval/policy checks.
Changes:
- Added a “Governed tool action metadata” example with
app.governance.*attributes in the GenAI tool-call docs. - Added a changelog clarification fragment for the documentation update.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/gen-ai/non-normative/examples-llm-calls.md | Documents a new non-normative example for correlating tool execution telemetry with governance/approval evidence. |
| changelog.d/+.clarification.md | Adds a changelog fragment noting the new documentation example. |
| | `gen_ai.tool.name` | `"send_email"` | | ||
| | `gen_ai.operation.name` | `"execute_tool"` | | ||
| | `app.governance.action.ref` | `"action:4f87b1e2"` | | ||
| | `app.governance.action.hash` | `"sha256:4f87b1e24c6a8fb0e7e7d5a4f4e245a4b9a48f0f8e5d0f93c9f4b0a2"` | |
| @@ -0,0 +1 @@ | |||
| Add a non-normative GenAI example for attaching application-specific governance metadata to execute-tool spans. | |||
Pull request dashboard statusWaiting on reviewers · refreshed 2026-08-21 01:55 UTC Review the latest changes. Status above doesn't look right?
|
|
Updated after review: the example SHA-256 value is now a full 64-character digest, and the changelog fragment has been renamed to 417.clarification.md per changelog.d/README.md. The old +.clarification.md fragment was removed from the branch. |
|
One trust boundary may be worth stating explicitly: these Could the example add one sentence such as: “These attributes are correlation claims, not authorization or verification evidence; consumers must independently validate the referenced proof before treating the execution as approved.” That would preserve the example’s purpose without making an |
00b4209 to
2c53ee2
Compare
|
Thanks, that trust-boundary wording is right. Updated the example to state that the |
|
/dashboard route:reviewers |
|
@jw-ond routed this pull request to reviewers. |
lmolkova
left a comment
There was a problem hiding this comment.
None of the attributes added in the example are existing attributes defined in this repo. Applications are free to add them, but this is not something they should expect from OpenTelemetry GenAI instrumentations, hence it's controversial to have them in examples.
While the current language says that it's non-normative, the example is very specific and reads more prescriptive than 'attach whatever attributes you want'.
The example can be changed in a more generic way: do not mention specific attributes, use something like acme.custom.attribute, emphasize that applications can add them on any spans, tool calls or not.
|
Addressed the requested change in the latest commits. The example no longer defines or suggests Also fixed the generated TOC anchor after the section rename. All current PR checks are passing. /dashboard route:reviewers |
Summary
Adds a non-normative GenAI example showing how applications can attach governance metadata to an
execute_toolspan when a tool call is reviewed before execution.The example uses application-specific attributes (
app.governance.*) so it does not introduce new normative semantic convention attributes. It illustrates action references, approval verdicts, replay/proof URLs, and external verifier references as telemetry that can correlate tool execution with an approval or policy checkpoint.Validation
app.governance.*attributes