Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.05k stars 1.19k forks source link

Document that `TracingClient` is for internal usage within Azure SDKs #31096

Open lmolkova opened 6 days ago

lmolkova commented 6 days ago

Following up on https://github.com/Azure/azure-sdk-for-js/pull/30800#issuecomment-2334602536, we should document that tracingClient and other core-tracing primitives are not intended for end-users.

They are helpers that azure core provides for Azure SDKs.

The end users are expected to use OTel (or their telemetry SDK) functionality to create spans - e.g. OTel provides some experimental convenience - https://github.com/open-telemetry/opentelemetry-js/blob/main/api/src/experimental/trace/SugaredTracer.ts on top of a bit less convenient stable APIs

github-actions[bot] commented 6 days ago

@deyaaeldeen @jeremymeng @joheredi @maorleger @mpodwysocki @timovv @xirzec

github-actions[bot] commented 6 days ago

Thank you for your feedback. Tagging and routing to the team member best able to assist.