Nuxt

Oficjalny moduł DockRay dla Nuxt integruje aplikacje Nuxt 3 i 4 z platformą monitoringu DockRay. Automatycznie raportuje błędy po stronie serwera, monitoruje czas obsługi żądań oraz może opcjonalnie zbierać błędy Vue i JavaScript z przeglądarki.

Monitoring błędów po stronie serwera

DockRay integruje się z mechanizmem Nitro i raportuje nieobsłużone błędy serwera wraz z informacjami o dopasowanej trasie.

Zgłoszone zdarzenia mogą zawierać między innymi:

• typ i treść błędu,
• miejsce wystąpienia i stos wywołań,
• informacje o środowisku i wersji aplikacji,
• kontekst obsługiwanego żądania.

Domyślnie jako błędy aplikacji raportowane są odpowiedzi 5xx. Oczekiwane błędy 4xx, takie jak 404, nie są traktowane jako awarie aplikacji.

Monitoring wydajności

Moduł mierzy czas obsługi żądań i raportuje transakcje po wysłaniu odpowiedzi do użytkownika. Transakcje są grupowane według wzorca trasy, dzięki czemu różne identyfikatory nie tworzą osobnych wpisów w panelu.

Częstotliwość zbierania danych można kontrolować za pomocą współczynnika próbkowania.

Monitoring błędów Vue i JavaScript

Opcjonalnie można włączyć zbieranie błędów występujących po stronie przeglądarki. Integracja obsługuje zarówno standardowe błędy JavaScript, jak i błędy komponentów Vue przechwytywane przez hooki Nuxt.

Zdarzenia z przeglądarki są najpierw wysyłane do własnej aplikacji Nuxt, a następnie przekazywane do DockRay, dzięki czemu klucz prywatny projektu pozostaje wyłącznie po stronie serwera.

Nitro, Node i Edge

Integracja działa przez Nitro i obsługuje zarówno środowiska Node.js, jak i wdrożenia oparte na workerach, w tym rozwiązania zgodne z Fetch API.

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 można je kontrolować w konfiguracji modułu.

Instalacja modułu

Zainstaluj DockRay za pomocą npm:

npm install @dockcodes/dock-ray-nuxt

Konfiguracja

Dodaj moduł do pliku nuxt.config.ts:

export default defineNuxtConfig({
    modules: ['@dockcodes/dock-ray-nuxt'],

    ray: {
        tracesSampleRate: 0.2,
        browser: {
            enabled: false
        }
    }
});

Następnie dodaj dane projektu DockRay do zmiennych środowiskowych:

NUXT_RAY_TOKEN=project-token
NUXT_RAY_PRIVATE_KEY=project-private-key

Token projektu oraz klucz prywatny znajdziesz w panelu DockRay.

Dane dostępowe są przechowywane w prywatnej konfiguracji runtime Nuxt i nie powinny być umieszczane w runtimeConfig.public, ponieważ zawartość tej sekcji trafia do kodu klienta.

Bez skonfigurowanego tokenu i klucza prywatnego moduł pozostaje nieaktywny i nie wysyła żadnych danych.

Opcjonalne błędy JavaScript

Aby włączyć monitoring błędów Vue i JavaScript w przeglądarce, ustaw:

ray: {
    browser: {
        enabled: true
    }
}