Перейти к основному содержанию
Перейти к основному содержанию

Next.js

ClickStack может выполнять приём трасс OpenTelemetry в нативном формате из ваших бессерверных функций Next.js в Next 13.2+.

В этом руководстве интегрируются:

  • Логи консоли
  • Трейсы
Примечание

Если вам нужна запись пользовательских сессий и мониторинг на стороне браузера, вместо этого установите интеграцию для браузера.

Установка​

Включите хук инструментирования (требуется для версий v15 и ниже)​

Для начала необходимо включить хук инструментирования Next.js, установив experimental.instrumentationHook = true; в вашем next.config.js.

Пример:

const nextConfig = {
  experimental: {
    instrumentationHook: true,
  },
  // Игнорировать предупреждения пакетов OTel 
  // https://github.com/open-telemetry/opentelemetry-js/issues/4173#issuecomment-1822938936
  webpack: (
    config,
    { buildId, dev, isServer, defaultLoaders, nextRuntime, webpack },
  ) => {
    if (isServer) {
      config.ignoreWarnings = [{ module: /opentelemetry/ }];
    }
    return config;
  },
};

module.exports = nextConfig;

Установите SDK OpenTelemetry для ClickHouse​

npm install @hyperdx/node-opentelemetry

Создайте файл инструментирования​

Создайте файл с именем instrumentation.ts (или .js) в корне вашего проекта Next.js со следующим содержимым:

export async function register() {
  if (process.env.NEXT_RUNTIME === 'nodejs') {
    const { init } = await import('@hyperdx/node-opentelemetry');
    init({
      apiKey: '<YOUR_INGESTION_API_KEY>', // опционально: настраивается через переменную окружения `HYPERDX_API_KEY`
      service: '<MY_SERVICE_NAME>', // опционально: настраивается через переменную окружения `OTEL_SERVICE_NAME`
      additionalInstrumentations: [], // опционально; по умолчанию: []
    });
  }
}

Это позволит Next.js импортировать инструментацию OpenTelemetry при любом вызове бессерверной функции.

Настройка переменных окружения​

Если вы отправляете трассировки напрямую в ClickStack, вам потребуется запустить сервер Next.js со следующими переменными окружения, чтобы направлять спаны на OTel collector:

HYPERDX_API_KEY=<YOUR_INGESTION_API_KEY> \
OTEL_SERVICE_NAME=<MY_SERVICE_NAME> \
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
npm run dev

Если вы разворачиваете приложение на Vercel, убедитесь, что все перечисленные выше переменные окружения настроены для этого развертывания.