Skip to content
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

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

lmolkova
Copy link
Member

Fixes #37342

Updates tracing plugin docs to use AzMon OTel distro instead of exported.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@azure-sdk
Copy link
Collaborator

API change check

API changes are not detected in this pull request.

Copy link
Member

@pvaneck pvaneck left a 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.

sdk/core/azure-core-tracing-opentelemetry/README.md Outdated Show resolved Hide resolved
sdk/core/azure-core-tracing-opentelemetry/README.md Outdated Show resolved Hide resolved
sdk/core/azure-core-tracing-opentelemetry/README.md Outdated Show resolved Hide resolved
Copy link
Member

@pvaneck pvaneck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Identity CI failures were addressed in main and can be overridden.

@lmolkova
Copy link
Member Author

thank you @pvaneck !

@lmolkova lmolkova force-pushed the update-azure-core-tracing-docs branch from 25334c8 to 823483c Compare September 21, 2024 00:02
@lmolkova lmolkova force-pushed the update-azure-core-tracing-docs branch from 823483c to d47a4b0 Compare September 21, 2024 00:49
@lmolkova lmolkova enabled auto-merge (squash) September 21, 2024 01:25
@lmolkova lmolkova merged commit f832976 into Azure:main Sep 23, 2024
272 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document that @distributed_trace is for internal usage within Azure SDKs
4 participants