@azure/core-tracing
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-preview.13 • Public • Published

    Azure Core tracing library for JavaScript

    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

    Install this library using npm as follows

    npm install @azure/core-tracing
    

    Key Concepts

    The @azure/core-tracing package supports enabling tracing for Azure SDK packages, using an OpenTelemetry Tracer.

    By default, all libraries log with a NoOpTracer that takes no action. To change this, you have to use setTracer to set a new default Tracer.

    Examples

    Example 1 - Setting an OpenTelemetry Tracer

    const opentelemetry = require("@opentelemetry/api");
    const { BasicTracer, SimpleSpanProcessor } = require("@opentelemetry/tracing");
    const { ZipkinExporter } = require("@opentelemetry/exporter-zipkin");
    const { setTracer } = require("@azure/core-tracing");
    
    const exporter = new ZipkinExporter({
      serviceName: "azure-tracing-sample"
    });
    const tracer = new BasicTracer();
    tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
    
    setTracer(tracer);
    
    const rootSpan = tracer.startSpan("root");
    const context = opentelemetry.setSpan(opentelemetry.context.active(), rootSpan);
    
    // Call some client library methods and pass rootSpan via tracingOptions.
    
    rootSpan.end();
    exporter.shutdown();

    Example 2 - Passing current Context to library operations

    // Given a BlobClient from @azure/storage-blob
    const result = await blobClient.download(undefined, undefined, {
      tracingOptions: {
        tracingContext: context
      }
    });

    Next steps

    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.

    Troubleshooting

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

    Contributing

    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.

    Impressions

    Install

    npm i @azure/core-tracing

    DownloadsWeekly Downloads

    765,798

    Version

    1.0.0-preview.13

    License

    MIT

    Unpacked Size

    93.6 kB

    Total Files

    15

    Last publish

    Collaborators

    • avatar