microsoft/opentelemetry-azure-monitor-js

This repository is home to Azure Monitor Exporters and SDKs for the OpenTelemetry JavaScript Project (https://github.com/open-telemetry/opentelemetry-js)

This repository has been moved to the Azure SDK for JavaScript repository. In order to improve discoverability and share common dependencies/tests, the OpenTelemetry Azure Monitor for JS exporter has moved to a common location containing all Azure SDKs.

Azure Monitor JavaScript Exporter for OpenTelemetry

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:

npm install @azure/monitor-opentelemetry-exporter

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({
  logger: provider.logger,
  instrumentationKey: 'ikey',
});

// Add the exporter to the provider
provider.addSpanProcessor(new BatchSpanProcessor(exporter, {
  bufferTimeout: 15000,
  bufferSize: 1000,
}));

Metrics

Coming Soon

Logs

Coming Soon

Examples

Please take a look at the examples to see how to add the Azure Monitor Exporter to your existing OpenTelemetry instrumented project.

Compiling This Project

npm install
npm run build
npm run lint
npm run test

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

opentelemetry-azure-monitor-js's Issues

Failed to load Application Version

Hello. Thanks for your work on this. I am getting an error 'Failed to load Application version' after tracing is initialised. From a quick dig into this, it seems like the _appPrefix needs one further '../' to find the package.json file that it is looking for.

Happy to submit a PR if it is helpful and assuming correct diagnosis!

opentelemetry-azure-monitor-js/packages/azure-opentelemetry-exporter/src/platform/nodejs/context/context.ts

Line 29 in 6c10145

private _appPrefix = '../../../',

opentelemetry-azure-monitor-js/packages/azure-opentelemetry-exporter/src/platform/nodejs/context/context.ts

Line 43 in 6c10145

const packageJsonPath = path.resolve(__dirname, `${this._appPrefix}../../../../package.json`);

Failed to fetch persisted file

It appears that 'failing to fetch persisted file' is an expected and normal outcome, and so therefore should not be an error like this?

I checked the folder there and it does not exist. However, all envelopes seem to end up successfully in Application Insights.

Add Live Metrics Exporter

Add node.js telemetry processor / exporter

feat: implement flags support

Missing flags?

Originally posted by @lzchen in #1

[Sampling] Add sampling support

Set samplingRate envelope field based on expected sampling rate