Share via

Azure Monitor OpenTelemetry client library samples for JavaScript

Browse code

These sample programs show how to use the JavaScript client libraries for Azure Monitor OpenTelemetry in some common scenarios.

File Name Description
basicConnection.js Demonstrates how to configure Azure Monitor OpenTelemetry using a connection string.
cloudRole.js Demonstrates how to set Cloud Role Name and Cloud Role Instance using OpenTelemetry Resource attributes.
customMetric.js Demonstrates how to generate custom metrics that will be sent to Azure Monitor.
customTrace.js Demonstrates how to generate custom traces that will be sent to Azure Monitor.
liveMetrics.js Demonstrates how to enable or disable Live Metrics for real-time monitoring.
offlineStorage.js Demonstrates how to configure offline storage and automatic retries for telemetry.
otlpExporter.js Demonstrates how to enable the OTLP exporter alongside Azure Monitor to send telemetry to two locations.
redactQueryStrings.js Demonstrates how to redact URL query strings from telemetry to protect sensitive information.
sampling.js Demonstrates how to enable sampling to reduce data ingestion volume and control costs.

Prerequisites

The sample programs are compatible with LTS versions of Node.js.

You need an Azure subscription and the following Azure resources to run these sample programs:

Samples retrieve credentials to access the service endpoint from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.

Adapting the samples to run in the browser may require some additional consideration. For details, please see the package README.

Setup

To run the samples using the published version of the package:

  1. Install the dependencies using npm:
npm install

  1. Edit the file sample.env, adding the correct credentials to access the Azure service and run the samples. Then rename the file from sample.env to just .env. The sample programs will read this file automatically.

  2. Run whichever samples you like (note that some samples may require additional setup, see the table above):

node basicConnection.js

Alternatively, run a single sample with the required environment variables set (setting up the .env file is not required if you do this), for example (cross-platform):

npx cross-env APPLICATIONINSIGHTS_CONNECTION_STRING="<applicationinsights connection string>" node basicConnection.js

Next Steps

Take a look at our API Documentation for more information about the APIs that are available in the clients.