Update tracing docs and add note to the @distributed_trace decorator that it's not intended for end users
#37478
+81
−47
Conversation
This file contains 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
lmolkova
requested review from
pvaneck,
lmazuel,
annatisch,
johanste,
xiangyan99,
iscai-msft and
kashifkhan
as code owners
|
API change check API changes are not detected in this pull request. |
lzchen
approved these changes
Sep 19, 2024
pvaneck
reviewed
Sep 19, 2024
There was a problem hiding this comment.
Thanks for this! Seems our "Verify Readmes" check isn't happy with the lack of "Key concepts", "Examples", and "Next steps" sections in the README file. I think we can either squeeze the section headings in, or perhaps just add the README path here. Other core libraries don't necessarily conform to these headings anyway.
|
|
||
| * Alternatively, if you have the latest version of `azure-core` installed, you can also set the following environment variable to enable tracing with OpenTelemetry: | ||
| Now you can use Azure Core OpenTelemetry Tracing plugin for Python as usual with any SDKs that are compatible | ||
| with azure-core tracing. This includes (not exhaustive list), `azure-storage-blob`, `azure-keyvault-secrets`, `azure-eventhub`,` etc. |
There was a problem hiding this comment.
Suggested change
| with azure-core tracing. This includes (not exhaustive list), `azure-storage-blob`, `azure-keyvault-secrets`, `azure-eventhub`,` etc. | |
| with azure-core tracing. This includes (not exhaustive list), `azure-storage-blob`, `azure-keyvault-secrets`, `azure-eventhub`, etc. |
| @@ -4,46 +4,80 @@ | |||
|
|
|||
| ## Getting started | |||
|
|
|||
| ### Install the package | |||
| You can enable distributes tracing in Azure client libraries by installing configuring the OpenTelemetry SDK. | |||
There was a problem hiding this comment.
Suggested change
| You can enable distributes tracing in Azure client libraries by installing configuring the OpenTelemetry SDK. | |
| You can enable distributed tracing in Azure client libraries by configuring the OpenTelemetry SDK. |
|
|
||
| ## Key concepts | ||
| ### Tracing with generic OpenTelemetry |
There was a problem hiding this comment.
Keep this section the same level as "Tracing with Azure Monitor OpenTelemetry Distro"?
Suggested change
| ### Tracing with generic OpenTelemetry | |
| ## Tracing with generic OpenTelemetry |
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.
Fixes #37342
Updates tracing plugin docs to use AzMon OTel distro instead of exported.
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines