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.

Getting started

Installation

This package is primarily used in Azure client libraries and not meant to be used directly by consumers of Azure SDKs.

Key Concepts

• TracingClient is the primary interface providing tracing functionality to client libraries. Client libraries should only be aware of and interact with aTracingClient instance.
  • ATracingClient implementation can be created using thecreateTracingClient factory function.
• Instrumenter provides an abstraction over an instrumentation and acts as the interop point for using third party libraries like OpenTelemetry. By default, a no-opInstrumenter is used. Customers who wish to enableOpenTelemetry based tracing will do so by installing and registering the@azure/opentelemetry-instrumentation-azure-sdk package.
• TracingContext is animmutable data container, used to pass operation-specific information around (such as span parenting information).
• TracingSpan is an abstraction of aSpan which can be used to record events, attributes, and exceptions.

Examples

Examples can be found in thesamples folder.

Next steps

You can build and run the tests locally by executingrushx test. Explore thetest folder to see advanced usage and behavior of the public classes.

Troubleshooting

If you run into issues while using this library, please feel free tofile an issue.

Contributing

If you'd like to contribute to this library, please read thecontributing guide to learn more about how to build and test the code.