Node.js

Paket für Express und Fastify

Kostenlos in jedem Plan, auch im kostenlosen

Kostenlos starten Dokumentation

Woher nehmen

Auf npm ansehen

npm

Voraussetzungen Node.js 18+

Paketname @dockcodes/dock-ray

Preise Kostenlos

Wozu es dient

Das offizielle DockRay-Paket für Node.js ermöglicht die Integration serverseitiger Node.js-Anwendungen mit der DockRay-Monitoring-Plattform. Es ermöglicht die Meldung von Ausnahmen und eigenen Nachrichten sowie das Monitoring der Verarbeitungszeit von HTTP-Anfragen.

Monitoring von Fehlern und Ausnahmen

Mit DockRay können Sie abgefangene Ausnahmen und eigene Nachrichten direkt an das Monitoring-Dashboard übermitteln.

Gemeldete Ereignisse können unter anderem folgende Informationen enthalten:

Typ und Beschreibung des Fehlers,
Ort des Auftretens und Stack Trace,
Informationen über die Umgebung und Anwendungsversion,
Kontext der verarbeiteten Anfrage.

Das Paket kann außerdem unbehandelte Fehler des Node.js-Prozesses erfassen. Diese Funktion ist optional, da sie die Verarbeitung kritischer Fehler durch die Anwendung beeinflusst.

Express und Fastify

DockRay bietet fertige Integrationen für Express und Fastify. Damit können HTTP-Transaktionen automatisch überwacht und Fehler, die während der Verarbeitung von Anfragen auftreten, gemeldet werden.

Transaktionen werden anhand des Routenmusters gruppiert, sodass Anfragen an dieselbe Route unabhängig von den übergebenen IDs gemeinsam analysiert werden können.

Performance-Monitoring

Das Paket kann die Verarbeitungszeit von HTTP-Anfragen messen und Transaktionsdaten an DockRay übermitteln. Die Häufigkeit der Datenerfassung kann über eine Sampling-Rate gesteuert werden.

Die fertigen Integrationen ignorieren standardmäßig Pfade wie /health und /metrics.

Monitoring von JavaScript-Fehlern im Browser

DockRay ermöglicht außerdem die Weiterleitung von JavaScript-Fehlern aus dem Browser über Ihre eigene Node.js-Anwendung. Der private Schlüssel des Projekts verbleibt auf dem Server und wird nicht im Quellcode der Website offengelegt.

Sichere Fehlerübermittlung

Probleme mit dem Monitoring-Dienst verursachen keine zusätzlichen Ausnahmen in der überwachten Anwendung. Netzwerkfehler und abgelehnte Ereignisse werden vom DockRay-Client verarbeitet.

Sensible Header wie Authorization, Cookie und X-Api-Key werden aus den Daten entfernt, die von den fertigen HTTP-Integrationen übermittelt werden.

Für serverseitige Anwendungen entwickelt

DockRay ist für serverseitige Anwendungen vorgesehen und erfordert Node.js 18 oder neuer. Das Paket besitzt keine zusätzlichen Abhängigkeiten und verwendet die integrierte fetch-API.

Installation

Installation des Pakets

Installieren Sie DockRay mit npm:

bash

npm install @dockcodes/dock-ray

Das Paket erfordert Node.js 18 oder neuer.

Konfiguration

Erstellen Sie einen DockRay-Client und geben Sie den Projekt-Token und den privaten Schlüssel an:

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,
});

Den Projekt-Token und den privaten Schlüssel finden Sie im DockRay-Dashboard.

Wenn der Client ohne Zugangsdaten erstellt wird, bleibt er inaktiv und stellt keine Verbindungen zur Monitoring-Plattform her.

Rufen Sie beim Beenden der Anwendung await ray.close() auf, um ausstehende Vorgänge abzuschließen und in der Warteschlange befindliche Ereignisse zu senden.

So wird es verwendet

Ausnahmen meldet die Integration von selbst. Das hier ist für Meldungen, die Sie bewusst senden.

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;
}