Dela via


Azure Monitor OpenTelemetry Exporter-klientbibliotek för JavaScript – version 1.0.0-beta.35

npm-version

Komma igång

Det här exportpaketet förutsätter att ditt program redan instrumenteras med OpenTelemetry SDK. När du är redo att exportera OpenTelemetry-data kan du lägga till den här exportören i ditt program.

Installera paketet

npm install @azure/monitor-opentelemetry-exporter

Miljöer som stöds för närvarande

Mer information finns i vår supportprincip .

Varning: Detta SDK fungerar bara för Node.js miljöer. Använd Application Insights JavaScript SDK för webbläsarmiljöer.

Förutsättningar

Distribuerad spårning

Lägg till exportören i din befintliga OpenTelemetry Tracer-provider (NodeTracerProvider / BasicTracerProvider)

import { AzureMonitorTraceExporter } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider, BatchSpanProcessor } from "@opentelemetry/sdk-trace-node";
import { resourceFromAttributes } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";

// Create an exporter instance
const exporter = new AzureMonitorTraceExporter({
  connectionString: "<connection string>",
});

// Create and configure the Node Tracer provider
const tracerProvider = new NodeTracerProvider({
  resource: resourceFromAttributes({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
  spanProcessors: [
    new BatchSpanProcessor(exporter, {
      exportTimeoutMillis: 15000,
      maxQueueSize: 1000,
    }),
  ],
});

// Register Tracer Provider as global
tracerProvider.register();

Mätvärden

Lägg till exportören i din befintliga OpenTelemetry Meter-provider (MeterProvider)

import { AzureMonitorMetricExporter } from "@azure/monitor-opentelemetry-exporter";
import { PeriodicExportingMetricReader, MeterProvider } from "@opentelemetry/sdk-metrics";
import { metrics } from "@opentelemetry/api";

// Add the exporter into the MetricReader and register it with the MeterProvider
const exporter = new AzureMonitorMetricExporter({
  connectionString: "<connection string>",
});

const metricReaderOptions = {
  exporter: exporter,
};
const metricReader = new PeriodicExportingMetricReader(metricReaderOptions);
const meterProvider = new MeterProvider({
  readers: [metricReader],
});

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

Loggfiler

Lägg till loggexportören i din befintliga OpenTelemetry Logger-provider (LoggerProvider)

import { AzureMonitorLogExporter } from "@azure/monitor-opentelemetry-exporter";
import { BatchLogRecordProcessor, LoggerProvider } from "@opentelemetry/sdk-logs";
import { logs } from "@opentelemetry/api-logs";

// Add the Log exporter into the logRecordProcessor and register it with the LoggerProvider
const exporter = new AzureMonitorLogExporter({
  connectionString: "<connection string>",
});

const logRecordProcessor = new BatchLogRecordProcessor(exporter);
const loggerProvider = new LoggerProvider();
loggerProvider.addLogRecordProcessor(logRecordProcessor);

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

Provtagning

Du kan aktivera sampling för att begränsa mängden telemetriposter som du tar emot. Om du vill aktivera korrekt sampling i Application Insights använder du enligt ApplicationInsightsSampler nedan.

import { ApplicationInsightsSampler } from "@azure/monitor-opentelemetry-exporter";
import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { resourceFromAttributes } from "@opentelemetry/resources";
import { ATTR_SERVICE_NAME } from "@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: resourceFromAttributes({
    [ATTR_SERVICE_NAME]: "basic-service",
  }),
});

provider.register();

Exempel

Fullständiga exempel på några mästarscenarier finns i mappen samples/ .

Viktiga begrepp

Mer information om OpenTelemetry-projektet finns i OpenTelemetry-specifikationerna.

Felsökning

Aktivera loggning för felsökning

Du kan aktivera felsökningsloggning genom att ändra loggningsnivån för din leverantör.

import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";

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

Loggning / Skogsavverkning

Aktivering av Azure-loggning kan också hjälpa till att avslöja användbar information om fel. Om du vill se en logg med HTTP-begäranden och svar anger du AZURE_LOG_LEVEL miljövariabeln till info. Du kan också aktivera loggning vid körning genom att anropa setLogLevel i @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Mer detaljerade anvisningar om hur du aktiverar loggar finns i dokument för @azure/logger-paket.

Nästa steg

Den här exportören är gjord för att användas med OpenTelemetry JS.

Plugin Registry

För att se om ett plugin-program redan har skapats för ett bibliotek som du använder, kolla in OpenTelemetry Registry.

Om du inte kan ditt bibliotek i registret kan du föreslå en ny plugin-begäran på opentelemetry-js-contrib.

Bidrag

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden för att lära dig mer om hur du skapar och testar koden.