-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Update tracing docs and add note to the @distributed_trace
decorator that it's not intended for end users
#37478
base: main
Are you sure you want to change the base?
Conversation
API change check API changes are not detected in this pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep this section the same level as "Tracing with Azure Monitor OpenTelemetry Distro"?
### Tracing with generic OpenTelemetry | |
## Tracing with generic OpenTelemetry |
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