@xrayradar/node

XrayRadar SDK for Node.js – capture errors and messages and send them to your XrayRadar server.

Install

npm install @xrayradar/node

Quick start

import { init, captureException, captureMessage } from "@xrayradar/node";

init({
  dsn: "https://xrayradar.com/your_project_id",
  authToken: "your-token",
});

captureException(new Error("Something broke"));
captureMessage("Something happened");

Configuration

init(options) supports:

• dsn: https://xrayradar.com/your_project_id
• authToken: sent as X-Xrayradar-Token
• debug: log captured payloads to console.warn
• environment, release, serverName
• sampleRate: number in ([0, 1])
• maxBreadcrumbs
• beforeSend(event): return modified event, null to drop, or a Promise
• transport: custom transport implementing sendEvent(event) (disables built-in global handlers)

Environment variables (optional)

If you don’t pass these explicitly, you can set:

• XRAYRADAR_ENVIRONMENT
• XRAYRADAR_RELEASE
• XRAYRADAR_SERVER_NAME
• XRAYRADAR_AUTH_TOKEN (used by the built-in HTTP transport)

Middleware helpers (optional)

Express

import express from "express";
import { init, getClient, expressRequestHandler, expressErrorHandler } from "@xrayradar/node";

init({ dsn: process.env.XRAYRADAR_DSN!, authToken: process.env.XRAYRADAR_AUTH_TOKEN });
const client = getClient()!;

const app = express();
app.use(expressRequestHandler(client));

// ... routes ...

app.use(expressErrorHandler(client)); // must be after routes

Koa

import Koa from "koa";
import { init, getClient, koaMiddleware } from "@xrayradar/node";

init({ dsn: process.env.XRAYRADAR_DSN!, authToken: process.env.XRAYRADAR_AUTH_TOKEN });
const client = getClient()!;

const app = new Koa();
app.use(koaMiddleware(client));

Requires Node 20+. For global uncaught exception / rejection handling, see the full documentation.