This is the core tracing library that provides low-level interfaces and helper methods for tracing in Azure SDK JavaScript libraries which work in the browser and Node.js.
This package is primarily used in Azure client libraries and not meant to be used directly by consumers of Azure SDKs.
-
TracingClientis the primary interface providing tracing functionality to client libraries. Client libraries should only be aware of and interact with aTracingClientinstance.- A
TracingClientimplementation can be created using thecreateTracingClientfactory function.
- A
-
Instrumenterprovides an abstraction over an instrumentation and acts as the interop point for using third party libraries like OpenTelemetry. By default, a no-opInstrumenteris used. Customers who wish to enableOpenTelemetrybased tracing will do so by installing and registering the @azure/opentelemetry-instrumentation-azure-sdk package. -
TracingContextis an immutable data container, used to pass operation-specific information around (such as span parenting information). -
TracingSpanis an abstraction of aSpanwhich can be used to record events, attributes, and exceptions.
Examples can be found in the samples folder.
You can build and run the tests locally by executing rushx test. Explore the test folder to see advanced usage and behavior of the public classes.
If you run into issues while using this library, please feel free to file an issue.
If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.
