@azure/core-tracing
Advanced tools
Package description
The @azure/core-tracing package provides a common interface for adding tracing to Azure SDKs. It allows developers to collect detailed information about operations performed by Azure SDKs, making it easier to diagnose issues and optimize performance. The package is built on OpenTelemetry, a set of APIs, libraries, agents, and instrumentation that provide observability for applications.
Creating and managing spans
This feature allows developers to create and manage spans, which represent individual operations. Spans can be nested to represent complex operations composed of multiple steps. The code sample demonstrates how to create a tracing client, start a new span, and then end the span.
const { createTracingClient } = require('@azure/core-tracing');
const tracingClient = createTracingClient({
namespace: 'Microsoft.Azure',
packageName: 'AzureExample',
packageVersion: '1.0.0'
});
// Start a new span
cost span = tracingClient.startSpan('myOperation');
// End the span
span.end();Integrating with Azure SDKs
This feature demonstrates how to integrate the @azure/core-tracing package with other Azure SDKs, such as Azure Storage Blobs. By passing a tracing client to the SDK's client constructor, developers can automatically collect tracing information for operations performed by the SDK.
const { DefaultAzureCredential } = require('@azure/identity');
const { BlobServiceClient } = require('@azure/storage-blob');
const { createTracingClient } = require('@azure/core-tracing');
const tracingClient = createTracingClient({
namespace: 'Microsoft.Azure',
packageName: 'Azure.Storage.Blobs',
packageVersion: '12.0.0'
});
const blobServiceClient = new BlobServiceClient(
'https://<my-storage-account>.blob.core.windows.net/',
new DefaultAzureCredential(),
{
tracingOptions: { tracingClient }
}
);The OpenTelemetry API provides the foundational building blocks for creating observability tools for applications and services. It is similar to @azure/core-tracing in that it offers tracing capabilities, but it is more general-purpose and not specifically designed for Azure SDKs. OpenTelemetry supports a wider range of telemetry data (traces, metrics, logs) and provides more extensive customization options.
Jaeger client is a distributed tracing system that can be used to monitor and troubleshoot transactions in complex distributed systems. While it provides similar functionality to @azure/core-tracing in terms of tracing operations, Jaeger is a standalone system with its own backend and UI for visualizing traces, making it more suited for end-to-end tracing across multiple services and platforms.
Readme
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.
TracingClient is the primary interface providing tracing functionality to client libraries. Client libraries should only be aware of and interact with a TracingClient instance.
TracingClient implementation can be created using the createTracingClient 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-op Instrumenter is used. Customers who wish to enable OpenTelemetry based tracing will do so by installing and registering the @azure/opentelemetry-instrumentation-azure-sdk package.TracingContext is an immutable data container, used to pass operation-specific information around (such as span parenting information).TracingSpan is an abstraction of a Span which 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.
FAQs
Provides low-level interfaces and helper methods for tracing in Azure SDK
The npm package @azure/core-tracing receives a total of 5,113,851 weekly downloads. As such, @azure/core-tracing popularity was classified as popular.
We found that @azure/core-tracing demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.