Експортери

Обробка та експорт ваших телеметричних даних

Надсилайте телеметрію до OpenTelemetry Collector, щоб переконатися, що вона експортується правильно. Використання Collector у виробничих середовищах є найкращою практикою. Щоб візуалізувати вашу телеметрію, експортуйте її до бекенду, такого як Jaeger, Zipkin, Prometheus або бекенд, специфічний для постачальника.

Доступні експортери

Реєстр містить список експортерів для JavaScript.

Серед експортерів, експортери OpenTelemetry Protocol (OTLP) розроблені з урахуванням моделі даних OpenTelemetry, що передають дані OTel без втрати інформації. Крім того, багато інструментів, які працюють з телеметричними даними, підтримують OTLP (таких як Prometheus, Jaeger і більшість постачальників), надаючи вам високий ступінь гнучкості, коли це потрібно. Щоб дізнатися більше про OTLP, дивіться Специфікацію OTLP.

Ця сторінка охоплює основні експортери OpenTelemetry JavaScript та як їх налаштувати.

Примітка

Якщо ви використовуєте інструментування без коду, ви можете дізнатися як налаштувати експортери, дотримуючись Посібника з налаштування.

OTLP

Налаштування Collector

Примітка

Якщо у вас вже налаштований OTLP collector або бекенд, ви можете пропустити цей розділ і налаштувати залежності OTLP експортерів для вашого застосунку.

Щоб спробувати та перевірити ваші OTLP експортери, ви можете запустити collector у docker контейнері, який записує телеметрію безпосередньо в консоль.

У порожній теці створіть файл з назвою collector-config.yaml з наступним вмістом:

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
exporters:
  debug:
    verbosity: detailed
service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [debug]
    metrics:
      receivers: [otlp]
      exporters: [debug]
    logs:
      receivers: [otlp]
      exporters: [debug]

Тепер запустіть collector у docker контейнері:

docker run -p 4317:4317 -p 4318:4318 --rm -v $(pwd)/collector-config.yaml:/etc/otelcol/config.yaml otel/opentelemetry-collector

Цей collector тепер може приймати телеметрію через OTLP. Пізніше ви можете налаштувати collector, щоб надсилати вашу телеметрію до вашого бекенду для спостереження.

Залежності

Якщо ви хочете надсилати телеметричні дані на точку доступу OTLP (наприклад, OpenTelemetry Collector, Jaeger або Prometheus), ви можете вибрати один з трьох різних протоколів для транспортування ваших даних:

Почніть з встановлення відповідних пакунків експортерів як залежності для вашого проєкту:

npm install --save @opentelemetry/exporter-trace-otlp-proto \
  @opentelemetry/exporter-metrics-otlp-proto

npm install --save @opentelemetry/exporter-trace-otlp-http \
  @opentelemetry/exporter-metrics-otlp-http

npm install --save @opentelemetry/exporter-trace-otlp-grpc \
  @opentelemetry/exporter-metrics-otlp-grpc

Використання з Node.js

Далі, налаштуйте експортер для вказівки на точку доступу OTLP. Наприклад, ви можете оновити файл instrumentation.ts (або instrumentation.js, якщо ви використовуєте JavaScript) з Початка роботи наступним чином для експорту трас і метрик через OTLP (http/protobuf):

/*instrumentation.ts*/
import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-proto';
import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';

const sdk = new opentelemetry.NodeSDK({
  traceExporter: new OTLPTraceExporter({
    // необовʼязково - стандартно url http://localhost:4318/v1/traces
    url: '<your-otlp-endpoint>/v1/traces',
    // необовʼязково - колекція користувацьких заголовків, які будуть відправлені з кожним запитом, стандартно порожня
    headers: {},
  }),
  metricReader: new PeriodicExportingMetricReader({
    exporter: new OTLPMetricExporter({
      url: '<your-otlp-endpoint>/v1/metrics', // url необовʼязковий і може бути пропущений - стандартно http://localhost:4318/v1/metrics
      headers: {}, // необовʼязковий обʼєкт, що містить користувацькі заголовки, які будуть відправлені з кожним запитом
    }),
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

/*instrumentation.js*/
const opentelemetry = require('@opentelemetry/sdk-node');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');
const {
  OTLPTraceExporter,
} = require('@opentelemetry/exporter-trace-otlp-proto');
const {
  OTLPMetricExporter,
} = require('@opentelemetry/exporter-metrics-otlp-proto');
const { PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');

const sdk = new opentelemetry.NodeSDK({
  traceExporter: new OTLPTraceExporter({
    // необовʼязково - стандартно url http://localhost:4318/v1/traces
    url: '<your-otlp-endpoint>/v1/traces',
    // необовʼязково - колекція користувацьких заголовків, які будуть відправлені з кожним запитом, стандартно порожня
    headers: {},
  }),
  metricReader: new PeriodicExportingMetricReader({
    exporter: new OTLPMetricExporter({
      url: '<your-otlp-endpoint>/v1/metrics', // url необовʼязковий і може бути пропущений - стандартно http://localhost:4318/v1/metrics
      headers: {}, // необовʼязковий обʼєкт, що містить користувацькі заголовки, які будуть відправлені з кожним запитом
      concurrencyLimit: 1, // необовʼязкове обмеження на кількість очікуючих запитів
    }),
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

Використання в оглядачі

Коли ви використовуєте OTLP експортер у застосунку оглядача, вам потрібно врахувати, що:

Використання gRPC для експорту не підтримується
Політики безпеки вмісту (CSPs) вашого вебсайту можуть блокувати ваші експорти
Заголовки Cross-Origin Resource Sharing (CORS) можуть не дозволяти вашим експортам бути надісланими
Вам може знадобитися експонувати ваш колектор для публічного інтернету

Нижче ви знайдете інструкції щодо використання правильного експортера, налаштування ваших CSPs і CORS заголовків та які запобіжні заходи потрібно вжити при відкритті вашого колектора.

Використання OTLP експортера з HTTP/JSON або HTTP/protobuf

OpenTelemetry Collector Exporter з gRPC працює тільки з Node.js, тому ви обмежені використанням OpenTelemetry Collector Exporter з HTTP/JSON або OpenTelemetry Collector Exporter з HTTP/protobuf.

Переконайтеся, що отримувач вашого експортера (колектор або бекенд спостереження) приймає http/json, якщо ви використовуєте OpenTelemetry Collector Exporter з HTTP/JSON, і що ви експортуєте ваші дані на правильну точку доступу з вашим портом, встановленим на 4318.

Налаштування CSPs

Якщо ваш вебсайт використовує політики безпеки вмісту (CSPs), переконайтеся, що домен вашої точки доступу OTLP включений. Якщо ваша точка доступу колектора — https://collector.example.com:4318/v1/traces, додайте наступну директиву:

connect-src collector.example.com:4318/v1/traces

Якщо ваш CSP не включає точку доступу OTLP, ви побачите повідомлення про помилку, що запит до вашої точки доступу порушує директиву CSP.

Налаштування CORS заголовків

Якщо ваш вебсайт і колектор розміщені на різних джерелах, ваш оглядач може блокувати запити, що виходять до вашого колектора. Вам потрібно налаштувати спеціальні заголовки для Cross-Origin Resource Sharing (CORS).

OpenTelemetry Collector надає функцію для http-приймачів, щоб додати необхідні заголовки для дозволу приймачу приймати трасування з вебоглядачів:

receivers:
  otlp:
    protocols:
      http:
        include_metadata: true
        cors:
          allowed_origins:
            - https://foo.bar.com
            - https://*.test.com
          allowed_headers:
            - Example-Header
          max_age: 7200

Безпечне експонування вашого колектора

Щоб отримувати телеметрію від вебзастосунку, вам потрібно дозволити оглядачам ваших користувачів надсилати дані до вашого колектора. Якщо ваш вебзастосунок доступний з публічного інтернету, вам також потрібно зробити ваш колектор доступним для всіх.

Рекомендується не відкривати ваш колектор безпосередньо, а поставити зворотний проксі (NGINX, Apache HTTP Server, …) перед ним. Зворотний проксі може займатися SSL-розвантаженням, встановленням правильних CORS заголовків та багатьма іншими функціями, специфічними для вебзастосунків.

Нижче ви знайдете конфігурацію для популярного вебсервера NGINX, щоб почати:

server {
    listen 80 default_server;
    server_name _;
    location / {
        # Take care of preflight requests
        if ($request_method = 'OPTIONS') {
             add_header 'Access-Control-Max-Age' 1728000;
             add_header 'Access-Control-Allow-Origin' 'name.of.your.website.example.com' always;
             add_header 'Access-Control-Allow-Headers' 'Accept,Accept-Language,Content-Language,Content-Type' always;
             add_header 'Access-Control-Allow-Credentials' 'true' always;
             add_header 'Content-Type' 'text/plain charset=UTF-8';
             add_header 'Content-Length' 0;
             return 204;
        }

        add_header 'Access-Control-Allow-Origin' 'name.of.your.website.example.com' always;
        add_header 'Access-Control-Allow-Credentials' 'true' always;
        add_header 'Access-Control-Allow-Headers' 'Accept,Accept-Language,Content-Language,Content-Type' always;
        proxy_http_version 1.1;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_pass http://collector:4318;
    }
}

Консоль

Щоб налагодити ваше інструментування або побачити значення локально під час розробки, ви можете використовувати експортери, що записують телеметричні дані в консоль (stdout).

Якщо ви слідували настановам з Початку роботи або Ручного інструментування, ви вже встановили консольний експортер.

ConsoleSpanExporter включений в пакунок @opentelemetry/sdk-trace-node, а ConsoleMetricExporter включений в пакунок @opentelemetry/sdk-metrics:

Jaeger

Налаштування бекенду

Jaeger нативно підтримує OTLP для отримання даних трасування. Ви можете запустити Jaeger у docker контейнері з доступом до UI на порту 16686 та увімкненим OTLP на портах 4317 та 4318:

docker run --rm \
  -e COLLECTOR_ZIPKIN_HOST_PORT=:9411 \
  -p 16686:16686 \
  -p 4317:4317 \
  -p 4318:4318 \
  -p 9411:9411 \
  jaegertracing/all-in-one:latest

Використання

Тепер дотримуйтесь інструкцій для налаштування OTLP експортерів.

Prometheus

Щоб надіслати ваші метрики до Prometheus, ви можете або увімкнути OTLP Receiver Prometheus і використовувати OTLP експортер, або ви можете використовувати експортер Prometheus, MetricReader, який запускає HTTP сервер, що збирає метрики та серіалізує їх у текстовий формат Prometheus за запитом.

Налаштування бекенду

Примітка

Якщо у вас вже налаштований Prometheus або сумісний з Prometheus бекенд, ви можете пропустити цей розділ і налаштувати залежності експортера Prometheus або OTLP для вашого застосунку.

Ви можете запустити Prometheus у docker контейнері, доступному на порту 9090, дотримуючись цих інструкцій:

Створіть файл під назвою prometheus.yml з наступним вмістом:

scrape_configs:
  - job_name: dice-service
    scrape_interval: 5s
    static_configs:
      - targets: [host.docker.internal:9464]

Запустіть Prometheus у docker контейнері з доступом до UI на порту 9090:

docker run --rm -v ${PWD}/prometheus.yml:/prometheus/prometheus.yml -p 9090:9090 prom/prometheus --web.enable-otlp-receiver

Примітка

Коли використовуєте OTLP Receiver Prometheus, переконайтеся, що ви встановили OTLP endpoint для метрик у вашому застосунку на http://localhost:9090/api/v1/otlp.

Не всі docker середовища підтримують host.docker.internal. У деяких випадках вам може знадобитися замінити host.docker.internal на localhost або IP адресу вашої машини.

Залежності

Встановіть пакунок експортера як залежність для вашого застосунку:

npm install --save @opentelemetry/exporter-prometheus

Оновіть вашу конфігурацію OpenTelemetry для використання експортера та надсилання даних до вашого Prometheus бекенду:

import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';

const sdk = new opentelemetry.NodeSDK({
  metricReader: new PrometheusExporter({
    port: 9464, // необовʼязково - стандартно 9464
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

const opentelemetry = require('@opentelemetry/sdk-node');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');
const { PrometheusExporter } = require('@opentelemetry/exporter-prometheus');
const { PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
const sdk = new opentelemetry.NodeSDK({
  metricReader: new PrometheusExporter({
    port: 9464, // необовʼязково - стандартно 9464
  }),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

З вищенаведеним ви можете отримати доступ до ваших метрик за адресою http://localhost:9464/metrics. Prometheus або OpenTelemetry Collector з приймачем Prometheus можуть зчитувати метрики з цієї точки доступу.

Zipkin

Налаштування бекенду

Примітка

Якщо у вас вже налаштований Zipkin або сумісний з Zipkin бекенд, ви можете пропустити цей розділ і налаштувати залежності експортера Zipkin для вашого застосунку.

Ви можете запустити Zipkin у Docker контейнері, виконавши наступну команду:

docker run --rm -d -p 9411:9411 --name zipkin openzipkin/zipkin

Залежності

Щоб надсилати ваші трасувальні дані до Zipkin, ви можете використовувати ZipkinExporter.

Встановіть пакунок експортера як залежність для вашого застосунку:

npm install --save @opentelemetry/exporter-zipkin

Оновіть вашу конфігурацію OpenTelemetry для використання експортера та надсилання даних до вашого Zipkin бекенду:

import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { ZipkinExporter } from '@opentelemetry/exporter-zipkin';

const sdk = new opentelemetry.NodeSDK({
  traceExporter: new ZipkinExporter({}),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

const opentelemetry = require('@opentelemetry/sdk-node');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');
const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');

const sdk = new opentelemetry.NodeSDK({
  traceExporter: new ZipkinExporter({}),
  instrumentations: [getNodeAutoInstrumentations()],
});

Власні експортери користувача

Нарешті, ви також можете написати свій власний експортер. Для отримання додаткової інформації дивіться Інтерфейс SpanExporter в документації API.

Пакетування відрізків та записів журналу

SDK OpenTelemetry надає набір стандартних процесорів відрізків та записів журналу, які дозволяють вам або генерувати відрізки по одному (“простий”), або пакетувати їх. Використання пакетування рекомендується, але якщо ви не хочете пакетувати свої відрізки або записи журналу, ви можете використовувати простий процесор наступним чином:

/*instrumentation.ts*/
import * as opentelemetry from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';

const sdk = new NodeSDK({
  spanProcessors: new SimpleSpanProcessor(exporter),
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

/*instrumentation.js*/
const opentelemetry = require('@opentelemetry/sdk-node');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');

const sdk = new opentelemetry.NodeSDK({
  spanProcessors: new SimpleSpanProcessor(exporter)
  instrumentations: [getNodeAutoInstrumentations()],
});
sdk.start();

Відгук

Чи це було корисним?

Дякуємо. Ми цінуємо ваші відгуки!

Будь ласка, дайте нам знати як ми можемо покращити цю сторінку. Ми цінуємо ваші відгуки!

Востаннє змінено December 26, 2024: [uk] Ukrainian documentation for OpenTelemetry (2a3c5648)