[core-tracing] - Update README #21023
Merged
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
ghost
added
the
joheredi
reviewed
Mar 25, 2022
| The `@azure/core-tracing` package supports enabling tracing for Azure SDK packages, using an [OpenTelemetry](https://opentelemetry.io/) `Tracer`. | ||
|
|
||
| By default, all libraries log with a `NoOpTracer` that takes no action. To enable tracing, you will need to set a global tracer provider following the instructions in the [OpenTelemetry getting started guide](https://opentelemetry.io/docs/js/getting_started/nodejs) or the [Enabling Tracing using OpenTelemetry example](#enabling-tracing-using-opentelemetry) below. | ||
| - `TracingClient` is the primary interface providing tracing functionality to client libraries. Client libraries should only be aware of and interact with a `TracingClient` instance. |
There was a problem hiding this comment.
Is TracingClient an interface or is it a class?
There was a problem hiding this comment.
I was a bit confused about first reading that this is an interface and then the paragraph mentions that it provides functionality and can get instanced. Should we mention that createTracingClient() gives you an instance that implements the interface?
There was a problem hiding this comment.
Ah, ok. I see what you mean. I updated the README - does it seem clearer now or do you have any thoughts on what would make sense to add?
joheredi
reviewed
Mar 25, 2022
joheredi
approved these changes
Mar 25, 2022
maorleger
force-pushed
the
update-core-tracing-readme
branch
from
219b57c
to
7d06f7c
Compare
maorleger
commented
Mar 25, 2022
| @@ -97,21 +28,10 @@ You can build and run the tests locally by executing `rushx test`. Explore the ` | |||
|
|
|||
| If you run into issues while using this library, please feel free to [file an issue](https://github.com/Azure/azure-sdk-for-js/issues/new). | |||
|
|
|||
| ### OpenTelemetry Compatibility Errors | |||
There was a problem hiding this comment.
This doesn't seem pertinent anymore, at least not for 1.0.0
|
|
||
| For customers who require manual propagation, or to provide context propagation in the browser, all client library operations accept an optional options collection where a tracingContext can be passed in and used as the currently active context. Please see the [Manual Span Propagation example](#manual-span-propagation-using-opentelemetry) below for more details. | ||
|
|
||
| ### OpenTelemetry Compatibility |
There was a problem hiding this comment.
This didn't seem pertinent anymore, at least with 1.0.0
maorleger
force-pushed
the
update-core-tracing-readme
branch
from
9793852
to
773000e
Compare
maorleger
force-pushed
the
update-core-tracing-readme
branch
from
773000e
to
744b24c
Compare
azure-sdk
pushed a commit
to azure-sdk/azure-sdk-for-js
that referenced
this pull request
Oct 14, 2022
[2022-04-01-preview] Add New Api-version for Microsoft.ApiManagement (Azure#20399) * Adds base for updating Microsoft.ApiManagement from version preview/2021-12-01-preview to version 2022-04-01-preview * Updates readme * Updates API version in new specs and examples * APIM Auth Servers (Azure#19234) * APIM Auth Servers * adding x-ms-identifiers * removing some weird, invisible special char * formatting * oAuth2AuthenticationSettings moved to AuthSettings * Formatting Co-authored-by: Milan Zolota <[email protected]> * API Management Authorization Endpoints (Azure#19615) * Add blockchain to latest profile * Add additional types * add authorizations definitions * authorizations operations * add examples * update readme * fix examples * fix linter delete errors * address CI validation errors * prettier fix * update to 2022-04 * fix readme * Update specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimauthorizationproviders.json Co-authored-by: Sean Kim <[email protected]> * update versions * Apply suggestions from code review Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: Annaji Sharma Ganti <[email protected]> Co-authored-by: Annaji Sharma Ganti <[email protected]> * Move Long running Create Operation from Location based to Azure-AsyncOperation Header (Azure#19733) * azure-asyncOperation * prettier * fix(apim): Add missing 'metrics' property to diagnostics contract in 2022-04-01-preview (Azure#20317) * apim /PUT apis import add translateRequiredQueryParameters (Azure#20333) * [2022-04-01-preview] Replace resource with proxyresource and TrackedResource (Azure#20461) * replace resource with proxyresource * revert to proxyresource * Add type object to authorization definitions (Azure#20631) Authorization definitions were missing "type": "object", and this change adds that key/value pair * Add type object to policy fragment definition (Azure#20585) * APIM Open ID Connect providers (Azure#20622) * APIM Open ID Connect providers * added new proeprties for update * prettier * [APIM] Add Nat Gateway (Azure#19990) * Update apimdeployment.json * Create ApiManagementCreateServiceWithNatGatewayEnabled.json * fix typo in file * Change Nat Gateway property to enum * modify type of natgateway state * update property name * add example reference * small fix in example * rename to outboundPublicIPAddresses Co-authored-by: Samir Solanki <[email protected]> * [2022-04-01-preview] MIgrate2Stv2 API (Azure#20504) * migrate2stv2 * updated to post * 202 and location * add body to 202 * remove body from 202 Co-authored-by: Vatsa Patel <[email protected]> Co-authored-by: Samir Solanki <[email protected]> Co-authored-by: [email protected] <[email protected]> * Address Authorizations MissingTypeObject errors (Azure#20919) * Add forgotten If-Match header (Azure#20920) * Add forgotten If-Match header `If-Match` header for the `DeleteAuthorizationAccessPolicy.json file` was forgotten. This change adds the wildcard character for the `If-Match` header for that file. * Update ApiManagementDeleteAuthorization.json * Use common types for specs and count as readonly (Azure#21023) * common types * count readonly * Sasolank/more review comments (Azure#21025) * XML * proxy to gateway * Update Authorizations Spec (Azure#21027) * Update definitions.json Update wording for PostGetLoginLink endpoint description * Update apimauthorizationproviders.json Add 201 response to all Authorization PUT requests * Updated examples and fixed formatting There was a formatting issue within apimauthorizationproviders.json, and the Authorization examples needed to be updated with the new 201 responses for creating/updating Authorization entities. * Add long-running-operation key/value Added x-ms-long-running-operation: true to Authorization PUT requests * Remove long-running-operations * readonly revert (Azure#21050) * Set SchemaContract.Document as required. (Azure#20110) * Updated documentation of the SchemaContract. Server use to return code 500 in case SchemaContract.Document is null. That issue was fixed in the APIM and server will return proper response code. * Fix AzureApiValidation * update field with properties * revert remaining readonly on collection (Azure#21051) * Change to camel casing for "accesspolicies" (Azure#21070) * Change to camel casing for "accesspolicies" * More camel casing updates for access policies * list example fixed (Azure#21089) * fix definition (Azure#21110) * upgrade to v3 for common types (Azure#21109) * upgrade to v3 * Space * revert to v2 proxyResource Co-authored-by: Milan Zolota <[email protected]> Co-authored-by: Milan Zolota <[email protected]> Co-authored-by: Sean D Kim <[email protected]> Co-authored-by: Mark Cowlishaw <[email protected]> Co-authored-by: Annaji Sharma Ganti <[email protected]> Co-authored-by: Annaji Sharma Ganti <[email protected]> Co-authored-by: Tom Kerkhove <[email protected]> Co-authored-by: Korolev Dmitry <[email protected]> Co-authored-by: Logan Zipkes <[email protected]> Co-authored-by: Rafał Mielowski <[email protected]> Co-authored-by: malincrist <[email protected]> Co-authored-by: GuanchenIntern <[email protected]> Co-authored-by: VatsaPatel <[email protected]> Co-authored-by: Vatsa Patel <[email protected]> Co-authored-by: [email protected] <[email protected]> Co-authored-by: Maxim Agapov <[email protected]>
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.
Packages impacted by this PR
@azure/core-tracing
Issues associated with this PR
#18649
Describe the problem that is addressed by this PR
Since we no longer use OpenTelemetry in @azure/core-tracing, this PR just
updates the README to reflect the recent changes. I also made a note about this
library not meant for end-user consumption.
What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?
Are there test cases added in this PR? (If not, why?)
No, it's just a readme update
Provide a list of related PRs (if any)
Command used to generate this PR: (Applicable only to SDK release request PRs)
Checklists