Installation - Nuxt

Erstelle zuerst ein Projekt im DockRay-Panel. In seinen Einstellungen findest du den Projekt-Token - die öffentliche Kennung, die in die Ingest-URL eingeht - und im Tab API-Schlüssel erzeugst du einen privaten Schlüssel. Der Schlüssel wird nur einmal angezeigt, beim Erzeugen: DockRay speichert lediglich seinen Hash. Wenn noch kein Projekt existiert, beginne mit Erste Schritte.

Voraussetzungen

• Nuxt 3 oder 4,
• Node.js 18 oder neuer,
• npm.

Modul installieren

npm install @dockcodes/dock-ray-nuxt

Registrierung und Zugangsdaten

In nuxt.config.ts:

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

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

In den Umgebungsvariablen:

NUXT_RAY_TOKEN=projekt-token
NUXT_RAY_PRIVATE_KEY=privater-projektschluessel

Nuxt bildet NUXT_RAY_*-Variablen von sich aus auf runtimeConfig.ray ab - das ist seine eigene, eingebaute Konvention, die Zugangsdaten aus nuxt.config.ts und aus git heraushält. Das Modul hält sie ausschließlich im privaten Teil der Runtime-Konfiguration: alles unter runtimeConfig.public wird in das Client-Bundle serialisiert, ein Projektschlüssel dort wäre ein veröffentlichter Schlüssel. Ohne Token und Schlüssel lädt das Modul und sendet nichts.

Was das Modul von sich aus registriert

Das Hinzufügen des Moduls zu modules reicht für das Melden von Serverfehlern und Transaktionen - es bindet beim Anwendungsstart selbstständig ein Nitro-Plugin ein, ohne eine zusätzliche Datei auf deiner Seite. Das Sammeln von Vue- und Browser-JavaScript-Fehlern ist ein eigenes, bewusstes Opt-in (browser.enabled), das im Artikel zur Konfiguration beschrieben ist - standardmäßig kümmert sich das Modul nur um das, was auf dem Server passiert.

Der erste Test

Füge eine temporäre Server-Route hinzu, etwa server/api/ray-test.ts:

export default defineEventHandler(() => {
    throw createError({ statusCode: 500, statusMessage: 'DockRay-Kontrollfehler' });
});

Rufe sie einmal auf und entferne sie gleich nach dem erfolgreichen Test - es ist ein echter 500er, weitere Aufrufe verbrauchen also das Monatskontingent. Der Eintrag sollte im Panel unter Fehler des Projekts erscheinen, auf das der Token zeigt.