Next.js

Monitoring aplikacji Next.js po stronie serwera

Dostępna bezpłatnie

Zacznij za darmo Dokumentacja

Skąd wziąć

Zobacz na npm

npm

Wymagania Next.js 13.4+ z App Routerem, środowisko Node.js

Nazwa paczki @dockcodes/dock-ray-next

Cennik Za darmo

Do czego to służy

Oficjalna integracja DockRay dla Next.js pozwala monitorować błędy i wydajność aplikacji Next.js. Automatycznie raportuje błędy po stronie serwera, Edge Runtime i middleware oraz umożliwia opcjonalne zbieranie błędów JavaScript z przeglądarki.

Integracja obsługuje Next.js 14 i 15 oraz aplikacje korzystające z App Router i Pages Router.

Monitoring błędów Next.js

DockRay integruje się z mechanizmem raportowania błędów Next.js i pozwala zbierać problemy występujące w różnych częściach aplikacji.

Monitorowane mogą być między innymi błędy występujące w:

Server Components,
Route Handlers,
Server Actions,
renderowaniu strumieniowym,
Pages Router i API Routes,
middleware i Edge Runtime.

Zdarzenia mogą zawierać informacje o routerze, wzorcu trasy, typie trasy i źródle renderowania, co ułatwia znalezienie miejsca wystąpienia problemu.

Monitoring wydajności

DockRay umożliwia monitorowanie czasu obsługi żądań i transakcji aplikacji Next.js. Częstotliwość zbierania danych można kontrolować za pomocą współczynnika próbkowania.

Monitoring błędów JavaScript

Opcjonalnie można włączyć raportowanie błędów JavaScript występujących w przeglądarce użytkownika. Zdarzenia są najpierw przesyłane do własnego endpointu aplikacji Next.js, a następnie przekazywane do DockRay.

Dzięki temu klucz prywatny projektu pozostaje wyłącznie po stronie serwera i nie jest umieszczany w publicznym kodzie aplikacji.

Edge Runtime i Middleware

Integracja posiada osobny punkt wejścia przeznaczony dla środowiska Edge Runtime. Pozwala to raportować błędy występujące w middleware i innych częściach aplikacji działających na Edge.

Prywatność i bezpieczeństwo

Wrażliwe nagłówki, takie jak Authorization, Cookie, Set-Cookie i X-Api-Key, są usuwane z raportowanych danych.

Przesyłanie adresu IP i user agenta jest opcjonalne i wymaga osobnego włączenia w konfiguracji.

Integracja z Vercel

W aplikacjach wdrażanych na Vercel DockRay może automatycznie wykorzystać informacje o środowisku wdrożenia i wersji aplikacji, ułatwiając rozróżnienie produkcji oraz deploymentów preview.

Instalacja

Instalacja paczki

Zainstaluj DockRay za pomocą npm:

bash

npm install @dockcodes/dock-ray-next

Konfiguracja

Dodaj dane projektu DockRay do zmiennych środowiskowych:

RAY_TOKEN=project-token
RAY_PRIVATE_KEY=project-private-key
RAY_TRACES_SAMPLE_RATE=0.2

Token projektu oraz klucz prywatny znajdziesz w panelu DockRay.

RAY_PRIVATE_KEY musi pozostać zmienną dostępną wyłącznie po stronie serwera. Nie używaj dla niej prefiksu NEXT_PUBLIC_, ponieważ spowodowałoby to umieszczenie klucza w publicznym kodzie aplikacji.

Bez skonfigurowanego tokenu i klucza prywatnego integracja pozostaje nieaktywna i nie wysyła żadnych danych.

Włączenie raportowania błędów

W pliku instrumentation.ts w katalogu głównym projektu zainicjalizuj DockRay i skonfiguruj obsługę błędów:

import {
    initRay,
    rayRequestError
} from '@dockcodes/dock-ray-next';

export function register() {
    initRay();
}

export const>

Po konfiguracji DockRay może raportować błędy przechwytywane przez Next.js, między innymi z Server Components, Route Handlers, Server Actions i renderowania strumieniowego.

Jak tego użyć

Wyjątki integracja raportuje sama. To jest do zgłoszeń, które chcesz wysłać świadomie.

import { withRay } from '@dockcodes/dock-ray-next';

export default withRay(async function handler(req, res) {
    const order = await processOrder(req.body);

    res.status(200).json({
        success: true,
        order
    });
});