Add docstrings for constants for OpenTelemetry span operations and environment variables#210
Open
JimDaly wants to merge 1 commit into
Open
Add docstrings for constants for OpenTelemetry span operations and environment variables#210JimDaly wants to merge 1 commit into
JimDaly wants to merge 1 commit into
Conversation
JimDaly
requested review from
JacksonWeber,
MSNev,
ajmfehr,
biswapm,
gwharris7,
hectorhdzg,
jeremydvoss,
juliomenendez,
lzchen,
nikhilNava,
rads-1996 and
sellakumaran
as code owners
Performance comparisonThreshold: regressions >15.0% on gating scenarios fail the build. Higher ops/s is better; positive Δ means the PR is slower.
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Agent365 constants module to explicitly document span operation names, semantic convention keys, feature switches, and environment variables so they can be surfaced in generated API reference documentation.
Changes:
- Expanded the module docstring in
microsoft.opentelemetry.a365.constantsto enumerate/export-document the available constants. - Grouped constants in the docstring by category (span operations, semantic conventions, feature switches, env vars, etc.).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
9
to
+13
| Superset of microsoft-agents-a365-observability-core constants plus | ||
| package-specific environment variable constants. | ||
|
|
||
| Span operation names: | ||
| :var INVOKE_AGENT_OPERATION_NAME: Span operation name for agent invocation. |
JimDaly
changed the title
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
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.
Copilot tells me that adding these changes will make the constants appear in the generated reference documentation on learn.microsoft.com