Libreria client OpenTelemetry Exporter di Monitoraggio di Azure per JavaScript - versione 1.0.0-beta.23

Articolo
05/15/2024

Guida introduttiva

Questo pacchetto di esportazione presuppone che l'applicazione sia già instrumentata con OpenTelemetry SDK. Dopo aver eseguito l'esportazione dei dati OpenTelemetry, è possibile aggiungere l'utilità di esportazione all'applicazione.

Installare il pacchetto

npm install @azure/monitor-opentelemetry-exporter

Ambienti attualmente supportati

Versioni LTS di Node.js

Per altre informazioni, vedere i criteri di supporto.

Avviso: Questo SDK funziona solo per gli ambienti Node.js. Usare Application Insights JavaScript SDK per gli ambienti browser.

Prerequisiti

Traccia distribuita

Aggiungere l'utilità di esportazione al provider OpenTelemetry Tracer esistente (NodeTracerProvider / BasicTracerProvider)

const { AzureMonitorTraceExporter } = require("@azure/monitor-opentelemetry-exporter");
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources"); 
const { SemanticResourceAttributes } = require("@opentelemetry/semantic-conventions"); 

const tracerProvider = new NodeTracerProvider({
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "basic-service",
  }),
});
// Register Tracer Provider as global
tracerProvider.register();

// Create an exporter instance
const exporter = new AzureMonitorTraceExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>"
});

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

Metriche

Aggiungere l'utilità di esportazione al provider di contatori OpenTelemetry esistente (MeterProvider)

const { metrics } = require("@opentelemetry/api");
const { MeterProvider, PeriodicExportingMetricReader } = require("@opentelemetry/sdk-metrics");
const { AzureMonitorMetricExporter } = require("@azure/monitor-opentelemetry-exporter");

// Add the exporter into the MetricReader and register it with the MeterProvider
const exporter = new AzureMonitorMetricExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>",
});
const metricReaderOptions = {
  exporter: exporter,
};
const metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
const meterProvider = new MeterProvider();
meterProvider.addMetricReader(metricReader);

// Register Meter Provider as global
 metrics.setGlobalMeterProvider(meterProvider);

Log

Aggiungere l'utilità di esportazione log al provider Logger OpenTelemetry esistente (LoggerProvider)

const { logs } = require("@opentelemetry/api-logs");
const { LoggerProvider, BatchLogRecordProcessor } = require("@opentelemetry/sdk-logs");
const { AzureMonitorLogExporter } = require("@azure/monitor-opentelemetry-exporter");

// Add the Log exporter into the logRecordProcessor and register it with the LoggerProvider
const exporter = new AzureMonitorLogExporter({
  connectionString:
    process.env["APPLICATIONINSIGHTS_CONNECTION_STRING"] || "<your connection string>",
});
const logRecordProcessor = new BatchLogRecordProcessor(exporter);
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(logRecordProcessor);

// Register logger Provider as global
logs.setGlobalLoggerProvider(loggerProvider);

campionamento

È possibile abilitare il campionamento per limitare la quantità di record di telemetria ricevuti. Per abilitare il campionamento corretto in Application Insights, usare come ApplicationInsightsSampler illustrato di seguito.

const { ApplicationInsightsSampler } = require("@azure/monitor-opentelemetry-exporter");
const { BatchSpanProcessor } = require("@opentelemetry/sdk-trace-base");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");
const { Resource } = require("@opentelemetry/resources"); 
const { SemanticResourceAttributes } = require("@opentelemetry/semantic-conventions"); 

// Sampler expects a sample rate of between 0 and 1 inclusive
// A rate of 0.75 means approximately 75 % of your traces will be sent
const aiSampler = new ApplicationInsightsSampler(0.75);
const provider = new NodeTracerProvider({
  sampler: aiSampler,
  resource: new Resource({
    [SemanticResourceAttributes.SERVICE_NAME]: "basic-service",
  }),
});
provider.register();

Esempio

Per esempi completi di alcuni scenari campione, vedere la samples/ cartella .

Concetti chiave

Per altre informazioni sul progetto OpenTelemetry, vedere Le specifiche OpenTelemetry.

Risoluzione dei problemi

Abilitazione della registrazione di debug

È possibile abilitare la registrazione di debug modificando il livello di registrazione del provider.

const { DiagConsoleLogger, DiagLogLevel, diag } = require("@opentelemetry/api");
const { NodeTracerProvider } = require("@opentelemetry/sdk-trace-node");

const provider = new NodeTracerProvider();
diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ALL);
provider.register();

Passaggi successivi

Questo esportatore viene creato per essere usato con OpenTelemetry JS.

Registro dei plug-in

Per verificare se è già stato creato un plug-in per una libreria in uso, consultare il Registro di sistema OpenTelemetry.

Se non è possibile usare la libreria nel Registro di sistema, è possibile suggerire una nuova richiesta di plug-in all'indirizzo opentelemetry-js-contrib.

Contributo

Per contribuire a questa libreria, leggere la guida ai contributi per altre informazioni su come compilare e testare il codice.

Impression

Condividi tramite