@azure/monitor-opentelemetry-exporter
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-beta.4 • Public • Published

    Azure Monitor OpenTelemetry Exporter client library for JavaScript

    npm version

    Getting started

    This exporter package assumes your application is already instrumented with the OpenTelemetry SDK. Once you are ready to export OpenTelemetry data, you can add this exporter to your application.

    Install the package

    npm install @azure/monitor-opentelemetry-exporter

    Currently supported environments

    See our support policy for more details.

    Prerequisites

    Distributed Tracing

    Add the exporter to your existing OpenTelemetry tracer provider (NodeTracerProvider / BasicTracerProvider)

    const { AzureMonitorTraceExporter } = require("@azure/monitor-opentelemetry-exporter");
    const { NodeTracerProvider } = require("@opentelemetry/node");
    const { BatchSpanProcessor } = require("@opentelemetry/tracing");
    
    // Use your existing provider
    const provider = new NodeTracerProvider({
      plugins: {
        https: {
          // Ignore Application Insights Ingestion Server
          ignoreOutgoingUrls: [new RegExp(/dc.services.visualstudio.com/i)]
        }
      }
    });
    provider.register();
    
    // Create an exporter instance
    const exporter = new AzureMonitorTraceExporter({
      instrumentationKey: "ikey"
    });
    
    // Add the exporter to the provider
    provider.addSpanProcessor(
      new BatchSpanProcessor(exporter, {
        bufferTimeout: 15000,
        bufferSize: 1000
      })
    );

    Metrics

    Coming Soon

    Logs

    Coming Soon

    Examples

    For complete samples of a few champion scenarios, see the samples/ folder.

    Key concepts

    For more information on the OpenTelemetry project, please review the OpenTelemetry Specifications.

    Troubleshooting

    Enable debug logging

    You can enable debug logging by changing the logging level of your provider.

    const provider = new NodeTracerProvider({
      logLevel: LogLevel.DEBUG,
      plugins: {
        https: {
          // Ignore Application Insights Ingestion Server
          ignoreOutgoingUrls: [new RegExp(/dc.services.visualstudio.com/i)]
        }
      }
    });

    Next steps

    This exporter is made to be used with the OpenTelemetry JS.

    Plugin Registry

    To see if a plugin has already been made for a library you are using, please check out the OpenTelemetry Registry.

    If you cannot your library in the registry, feel free to suggest a new plugin request at opentelemetry-js-contrib.

    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/monitor-opentelemetry-exporter

    DownloadsWeekly Downloads

    7,369

    Version

    1.0.0-beta.4

    License

    MIT

    Unpacked Size

    305 kB

    Total Files

    67

    Last publish

    Collaborators

    • southpolesteve
    • christopheranderson
    • azure-sdk