Serverless

Інструментуйте свої безсерверні функції за допомогою OpenTelemetry JavaScript

Цей посібник показує, як почати відстежувати безсерверні функції за допомогою бібліотек інструментування OpenTelemetry.

AWS Lambda

Нижче показано, як використовувати обгортки Lambda з OpenTelemetry для інструментування функцій AWS Lambda вручну та надсилання трейсів до налаштованого бекенду.

Якщо вас цікавить досвід користувача plug and play, дивіться шари OpenTelemetry Lambda.

Залежності

Спочатку створіть порожній package.json:

npm init -y

Потім встановіть необхідні залежності:

npm install \
  @opentelemetry/api \
  @opentelemetry/auto-instrumentations-node \
  @opentelemetry/exporter-trace-otlp-http \
  @opentelemetry/instrumentation \
  @opentelemetry/sdk-trace-base \
  @opentelemetry/sdk-trace-node

Код обгортки AWS Lambda

Цей файл містить всю логіку OpenTelemetry, яка дозволяє трейсинг. Збережіть наступний код як lambda-wrapper.js.

/* lambda-wrapper.js */

const api = require('@opentelemetry/api');
const { BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const {
  OTLPTraceExporter,
} = require('@opentelemetry/exporter-trace-otlp-http');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');

api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.ALL);

const spanProcessor = new BatchSpanProcessor(
  new OTLPTraceExporter({
    url: '<backend_url>',
  }),
);

const provider = new NodeTracerProvider({
  spanProcessors: [spanProcessor],
});

provider.register();

registerInstrumentations({
  instrumentations: [
    getNodeAutoInstrumentations({
      '@opentelemetry/instrumentation-aws-lambda': {
        disableAwsContextPropagation: true,
      },
    }),
  ],
});

Замініть <backend_url> на URL вашого улюбленого бекенду, щоб експортувати всі трасування до нього. Якщо у вас ще немає налаштованого бекенду, ви можете поглянути на Jaeger або Zipkin.

Зверніть увагу, що disableAwsContextPropagation встановлено у true. Причина цього в тому, що інструментування Lambda намагається стандартно використовувати заголовки контексту X-Ray, якщо активне трасування не ввімкнено для цієї функції, це призводить до не записаного контексту, що створює NonRecordingSpan.

Більше деталей можна знайти в документації з інструментування. [.

Обробник функцій AWS Lambda

Тепер, коли у вас є обгортка Lambda, створіть простий обробник, який служить функцією Lambda. Збережіть наступний код як handler.js.

/* handler.js */

'use strict';

const https = require('https');

function getRequest() {
  const url = 'https://opentelemetry.io/';

  return new Promise((resolve, reject) => {
    const req = https.get(url, (res) => {
      resolve(res.statusCode);
    });

    req.on('error', (err) => {
      reject(new Error(err));
    });
  });
}

exports.handler = async (event) => {
  try {
    const result = await getRequest();
    return {
      statusCode: result,
    };
  } catch (error) {
    return {
      statusCode: 400,
      body: error.message,
    };
  }
};

Розгортання

Існує кілька способів розгортання вашої функції Lambda:

Тут ми будемо використовувати Serverless Framework, більше деталей можна знайти в Посібнику з налаштування Serverless Framework.

Створіть файл з назвою serverless.yml:

service: lambda-otel-native
frameworkVersion: '3'
provider:
  name: aws
  runtime: nodejs14.x
  region: '<your-region>'
  environment:
    NODE_OPTIONS: --require lambda-wrapper
functions:
  lambda-otel-test:
    handler: handler.hello

Для правильного функціонування OpenTelemetry, lambda-wrapper.js повинен бути включений перед будь-яким іншим файлом: налаштування NODE_OPTIONS забезпечує це.

Зверніть увагу, якщо ви не використовуєте Serverless Framework для розгортання вашої функції Lambda, вам потрібно вручну додати цю змінну середовища за допомогою інтерфейсу користувача AWS Console.

Нарешті, виконайте наступну команду, щоб розгорнути проєкт на AWS:

serverless deploy

Тепер ви можете викликати новорозгорнуту функцію Lambda за допомогою інтерфейсу користувача AWS Console. Ви повинні побачити трасування, повʼязані з викликом функції Lambda.

Відвідування бекенду

Тепер ви повинні мати можливість переглядати трасування, створені OpenTelemetry з вашої функції Lambda у бекенді!

GCP function

Нижче показано, як інструментувати функцію, що спрацьовує на HTTP-запити, за допомогою інтерфейсу користувача Google Cloud Platform (GCP).

Створення функції

Увійдіть до GCP і створіть або виберіть проєкт, де повинна бути розміщена ваша функція. У бічному меню перейдіть до Serverless і виберіть Cloud Functions. Далі, натисніть Create Function, і виберіть 2nd generation для вашого середовища, вкажіть імʼя функції та виберіть ваш регіон.

Налаштування змінної середовища для otelwrapper

Якщо закрито, відкрийте меню Runtime, build, connections and security settings і прокрутіть вниз і додайте змінну середовища NODE_OPTIONS зі значенням:

--require ./otelwrapper.js

Вибір середовища виконання

На наступному екрані (Code), виберіть версію Node.js 16 для вашого середовища виконання.

Створення обгортки OTel

Створіть новий файл з назвою otelwrapper.js, який буде використовуватися для інструментування вашого сервісу. Будь ласка, переконайтеся, що ви вказали SERVICE_NAME і встановили <address for your backend>.

/* otelwrapper.js */

const { resourceFromAttributes } = require('@opentelemetry/resources');
const { ATTR_SERVICE_NAME } = require('@opentelemetry/semantic-conventions');
const api = require('@opentelemetry/api');
const { BatchSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const {
  OTLPTraceExporter,
} = require('@opentelemetry/exporter-trace-otlp-http');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const {
  getNodeAutoInstrumentations,
} = require('@opentelemetry/auto-instrumentations-node');

api.diag.setLogger(new api.DiagConsoleLogger(), api.DiagLogLevel.ALL);

const collectorOptions = {
  url: '<address for your backend>',
};

const provider = new NodeTracerProvider({
  resource: resourceFromAttributes({
    [ATTR_SERVICE_NAME]: '<your function name>',
  }),
  spanProcessors: [
    new BatchSpanProcessor(new OTLPTraceExporter(collectorOptions)),
  ],
});

provider.register();

registerInstrumentations({
  instrumentations: [getNodeAutoInstrumentations()],
});

Додавання залежностей пакунка

Додайте наступне до вашого package.json:

{
  "dependencies": {
    "@google-cloud/functions-framework": "^3.0.0",
    "@opentelemetry/api": "^1.9.0",
    "@opentelemetry/auto-instrumentations-node": "^0.56.1",
    "@opentelemetry/exporter-trace-otlp-http": "^0.200.0",
    "@opentelemetry/instrumentation": "^0.200.0",
    "@opentelemetry/sdk-trace-base": "^2.0.0",
    "@opentelemetry/sdk-trace-node": "^2.0.0",
    "@opentelemetry/resources": "^2.0.0",
    "@opentelemetry/semantic-conventions": "^2.0.0"
  }
}

Додавання HTTP виклику до функції

Наступний код здійснює виклик на вебсайт OpenTelemetry, щоб продемонструвати вихідний виклик.

/* index.js */
const functions = require('@google-cloud/functions-framework');
const https = require('https');

functions.http('helloHttp', (req, res) => {
  let url = 'https://opentelemetry.io/';
  https
    .get(url, (response) => {
      res.send(`Response ${response.body}!`);
    })
    .on('error', (e) => {
      res.send(`Error ${e}!`);
    });
});

Бекенд

Якщо ви запускаєте OTel collector у GCP VM, вам, ймовірно, потрібно створити VPC access connector, щоб мати можливість надсилати трасування.

Розгортання

Виберіть Розгорнути в інтерфейсі користувача та дочекайтеся готовності розгортання.

Тестування

Ви можете протестувати функцію за допомогою cloud shell з вкладки тестування.


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