Docs/Getting Started/Sdk Installation

SDK Installation

Unseenr bietet native SDKs und ist auch kompatibel mit dem Sentry SDK Ökosystem.

Verfügbare SDKs

Paket Plattform Status
@unseenr/node Node.js Veröffentlicht
@unseenr/replay Browser (Session Replay) Veröffentlicht
Sentry SDKs (@sentry/browser, @sentry/node) Alle Sentry-unterstützten Plattformen Kompatibel

Node.js SDK

Installation

npm install @unseenr/node
# oder
pnpm add @unseenr/node
# oder
yarn add @unseenr/node

Konfiguration

import * as Unseenr from "@unseenr/node";

Unseenr.init({
  dsn: "https://<PUBLIC_KEY>@app.unseenr.io/<PROJECT_ID>",
});

Fehler erfassen

// Automatisch - nicht abgefangene Exceptions werden automatisch erfasst

// Manuelles Erfassen
try {
  riskyOperation();
} catch (error) {
  Unseenr.captureException(error);
}

// Nachricht erfassen
Unseenr.captureMessage("Etwas Bemerkenswertes ist passiert");

Session Replay SDK

Installation

npm install @unseenr/replay

Das Replay SDK basiert auf rrweb und zeichnet Browser-Sessions auf. Sensible Eingaben werden standardmäßig maskiert.

Sentry SDKs verwenden

Unseenr ist kompatibel mit Sentrys Envelope-Ingest-Format. Du kannst jedes Sentry SDK auf Unseenr umleiten, indem du die DSN änderst:

import * as Sentry from "@sentry/browser";

Sentry.init({
  dsn: "https://<PUBLIC_KEY>@app.unseenr.io/<PROJECT_ID>",
});

Der Authentication-Header kann entweder x-sentry-auth oder x-unseenr-auth sein.

DSN-Format

Die DSN (Data Source Name) identifiziert dein Projekt und authentifiziert Ingest-Anfragen. Das Format:

https://<PUBLIC_KEY>@app.unseenr.io/<PROJECT_ID>
  • PUBLIC_KEY: Ein einzigartiger Schlüssel für dein Projekt (unter Projekteinstellungen > Client Keys)
  • PROJECT_ID: Die numerische ID deines Projekts

Du findest deine DSN auf der Quickstart-Seite jedes Projekts oder unter Projekteinstellungen > Client Keys.

Mehrere Client Keys

Jedes Projekt kann mehrere Client Keys haben, jeder mit eigener DSN. Das ist nützlich, um Umgebungen zu trennen (Production, Staging, Development). Client Keys verwaltest du unter Projekteinstellungen > Client Keys.

Umgebungsspezifische DSNs

Wenn du zusätzliche Client Keys mit Umgebungsnamen erstellst, erhält jeder Key seine eigene DSN. Events, die mit dieser DSN gesendet werden, werden automatisch mit der entsprechenden Umgebung getaggt.

Auch verfügbar auf:English