Getting Started

GlitchTip is an open source error tracking platform compatible with the Sentry SDK. It collects, groups, and alerts on application errors, performance issues, and uptime events from any language or framework that supports the Sentry error reporting protocol. Available as an open web service in Eyevinn Open Source Cloud.

Prerequisites

  • An Eyevinn OSC account
  • A paid plan (Personal or above) — GlitchTip requires a PostgreSQL database instance

Step 1: Create a PostgreSQL database

GlitchTip stores all error and event data in PostgreSQL. Navigate to the PostgreSQL service in the OSC web console and create an instance with a name and password.

Once running, the connection URL has the form:

postgres://postgres:<password>@<IP>:<PORT>/postgres

Step 2: Store the database URL as a secret

Navigate to the GlitchTip service page, open the Service Secrets tab, and click New Secret. Store your database connection URL under a name such as dburl.

Step 3: Create a GlitchTip instance

Go to the My glitchtips tab and click Create glitchtip. Fill in:

Field Description
name Alphanumeric identifier for this instance (no spaces or hyphens)
secretKey A long random string used to sign sessions and tokens (generate with openssl rand -hex 32)
databaseUrl Reference your secret: {{secrets.dburl}}

Click Create and wait for the instance status to turn green.

Step 4: Create your admin account

Click the running instance URL to open the GlitchTip web UI. GlitchTip does not ship with a default admin account — you register the first user via the sign-up form at /register. The first registered user automatically receives superuser privileges.

Change the registration setting to invite only after creating your admin account to prevent unauthorised sign-ups: go to Settings → Organisation → Team and adjust the registration policy.

Step 5: Add a project and install the SDK

  1. In the GlitchTip dashboard, click Projects → New Project and select your platform (Python, JavaScript, etc.).
  2. Copy the DSN shown on the project page.
  3. Install the Sentry SDK in your application and point it at the GlitchTip DSN:
import sentry_sdk
sentry_sdk.init(dsn="https://<key>@<your-instance>.burke-software-glitchtip.auto.prod.osaas.io/1")

import * as Sentry from "@sentry/browser";
Sentry.init({ dsn: "https://<key>@<your-instance>.burke-software-glitchtip.auto.prod.osaas.io/1" });

Any uncaught exception or manually captured event will appear in the GlitchTip issues list within seconds.

CLI usage

osc create burke-software-glitchtip myglitchtip \
  -o secretKey="$(openssl rand -hex 32)" \
  -o databaseUrl="postgres://postgres:<password>@<IP>:<PORT>/postgres"

Resources