Node.js

Pakiet dla Express i Fastify

Dostępna bezpłatnie

Zacznij za darmo Dokumentacja

Skąd wziąć

Zobacz na npm

npm

Wymagania Node.js 18+

Nazwa paczki @dockcodes/dock-ray

Cennik Za darmo

Do czego to służy

Oficjalna paczka DockRay dla Node.js pozwala zintegrować aplikacje serwerowe Node.js z platformą monitoringu DockRay. Umożliwia raportowanie wyjątków i komunikatów oraz monitorowanie czasu obsługi żądań HTTP.

Monitoring błędów i wyjątków

DockRay pozwala raportować przechwycone wyjątki i własne komunikaty bezpośrednio do panelu monitoringu.

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.

Paczka może również przechwytywać nieobsłużone błędy procesu Node.js. Funkcja ta jest opcjonalna, ponieważ wpływa na sposób obsługi błędów krytycznych przez aplikację.

Express i Fastify

DockRay udostępnia gotowe integracje z Express i Fastify. Pozwalają one automatycznie monitorować transakcje HTTP oraz raportować błędy występujące podczas obsługi żądań.

Transakcje są grupowane według wzorca trasy, dzięki czemu żądania do tej samej trasy są analizowane razem niezależnie od przekazanych identyfikatorów.

Monitoring wydajności

Paczka może mierzyć czas obsługi żądań HTTP i przesyłać informacje o transakcjach do DockRay. Częstotliwość zbierania danych można kontrolować za pomocą współczynnika próbkowania.

Gotowe integracje domyślnie pomijają ścieżki takie jak /health i /metrics.

Monitoring błędów JavaScript w przeglądarce

DockRay umożliwia również przekazywanie błędów JavaScript z przeglądarki przez własną aplikację Node.js. Klucz prywatny projektu pozostaje po stronie serwera i nie jest udostępniany w kodzie strony.

Bezpieczne raportowanie

Problemy z usługą monitoringu nie powodują dodatkowych wyjątków w monitorowanej aplikacji. Błędy sieciowe i odrzucone zdarzenia są obsługiwane przez klienta DockRay.

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

Stworzone dla aplikacji serwerowych

DockRay jest przeznaczony dla aplikacji działających po stronie serwera i wymaga Node.js 18 lub nowszego. Paczka nie posiada dodatkowych zależności i wykorzystuje wbudowane API fetch.

Instalacja

Instalacja paczki

Zainstaluj DockRay za pomocą npm:

bash

npm install @dockcodes/dock-ray

Paczka wymaga Node.js 18 lub nowszego.

Konfiguracja

Utwórz klienta DockRay, podając token projektu i klucz prywatny:

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

const ray = new DockRayClient({
    token: process.env.RAY_TOKEN,
    privateKey: process.env.RAY_PRIVATE_KEY,
    environment: process.env.NODE_ENV,
    release: process.env.APP_VERSION,
});

Token projektu oraz klucz prywatny znajdziesz w panelu DockRay.

Jeśli klient zostanie utworzony bez danych dostępowych, pozostanie nieaktywny i nie będzie wykonywał żadnych połączeń z platformą monitoringu.

Przy zamykaniu aplikacji wywołaj await ray.close(), aby zakończyć oczekujące operacje i wysłać zakolejkowane zdarzenia.

Jak tego użyć

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

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

const ray = new DockRayClient({
    token: process.env.RAY_TOKEN,
    privateKey: process.env.RAY_PRIVATE_KEY,
    environment: process.env.NODE_ENV,
});

try {
    await settle(order);
} catch (error) {
    await ray.captureException(error);

    throw error;
}