Skip to main content
This guide walks you through the fastest path to a working Superlog setup: create an account or spin up a local instance, send your first OpenTelemetry trace, and watch an AI agent investigate your first incident. The whole process takes under five minutes.
Superlog has a demo mode that lets you explore sample incidents, agent runs, and dashboards with pre-loaded data — no instrumentation required. If you want to get a feel for the product before touching your codebase, choose “Explore with sample data” during onboarding on superlog.sh.
1

Sign up or self-host

Choose the option that fits your setup.Superlog Cloud — sign up for a free account at superlog.sh. No credit card required. You get a hosted ingest endpoint and a free tier that covers most small projects.Self-hosted (local) — run the full stack on your machine using Docker. See the Self-Hosting guide for the complete walkthrough, or use the quick commands below:
Once running, the web app is available at http://localhost:5173.
2

Install via coding agent (recommended)

The fastest way to instrument an existing project is to hand the task to your coding agent. Copy the prompt below and paste it into Cursor, Claude Code, Codex, or any other agent. The agent runs the Superlog install skill end-to-end — it adds the SDK, instruments your code, and opens a PR.
When you sign up on superlog.sh, the onboarding wizard generates this prompt with your API key already filled in so the agent can configure everything in one shot.
You can rotate your API key at any time from Settings → API Keys in the dashboard. The key is write-only, so it is safe to include in the agent prompt without exposing read access to your telemetry data.
3

Get your ingest API key

Superlog authenticates ingest requests with an API key attached as a bearer token. If you are instrumenting manually rather than via the coding agent, create a key now.
  1. Open the dashboard (Cloud: superlog.sh — Local: http://localhost:5173)
  2. Navigate to Settings → API Keys
  3. Click Create key, give it a name like my-app, and copy the value
API keys are write-only — they can ingest events but cannot read data from the dashboard. It is safe to use them in server-side environment variables or pass them directly to your coding agent during setup.
4

Send telemetry manually

If you prefer to instrument your application yourself, point your OTLP exporter at Superlog and include your API key as a bearer token.Ingest endpoints:Install the OpenTelemetry HTTP exporter for Node.js:
Configure the exporter to send traces to Superlog:
You can also configure the exporter using environment variables:
5

Explore the dashboard

Once your application sends its first trace, the Superlog dashboard updates in real time.Open the dashboard at http://localhost:5173 (local) or superlog.sh (Cloud) and navigate to the Incidents tab. Your first incident should appear within a few seconds of the first error arriving.

Next steps

Incidents

Learn how Superlog fingerprints and groups errors into incidents.

GitHub Integration

Connect GitHub so the AI agent can inspect your code and open fix PRs.