Service: GlitchTip - EyevinnOSC/community GitHub Wiki

GlitchTip

GlitchTip (serviceId burke-software-glitchtip) is an open source error tracking platform compatible with the Sentry SDK. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 20 GiB of storage per instance. License: MIT.

What it can do

  • Collect, group and alert on application errors, performance issues and uptime events from any language or framework that supports the Sentry error reporting protocol.
  • Act as a self-hosted replacement for a Sentry DSN endpoint.

Creating an instance

GlitchTip stores all error and event data in PostgreSQL. Create a PostgreSQL instance first (serviceId birme-osc-postgresql) and confirm it is running. A paid plan (Personal or above) is needed for the database instance.

  1. Create PostgreSQL with create-service-instance (serviceId: "birme-osc-postgresql") and a PostgresPassword (see the PostgreSQL options below).
  2. Read its address and port with describe-service-instance. The connection URL has the form postgres://postgres:<password>@<IP>:<PORT>/postgres.
  3. Store the URL with create-service-secret (serviceId: "burke-software-glitchtip", name dburl). Optionally store the Django secret key as a secret too.
  4. Create GlitchTip with create-service-instance using serviceId: "burke-software-glitchtip". The instance name must be alphanumeric (no spaces or hyphens) and at most 20 characters.
{
  "name": "myglitchtip",
  "secretKey": "<long-random-string>",
  "databaseUrl": "{{secrets.dburl}}"
}

A suitable secret key can be generated with openssl rand -hex 32. Wait for the instance with wait-for-service-ready and get the URL with describe-service-instance.

With the OSC CLI:

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

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
secretKey Yes string, sensitive Django secret key (SECRET_KEY), used to sign sessions and tokens. Use a long random string and keep it stable across restarts.
databaseUrl Yes string, sensitive PostgreSQL connection URL for GlitchTip's database (DATABASE_URL), for example postgres://user:password@host:5432/dbname. Store it as a secret and pass {{secrets.NAME}}.

secretKey and databaseUrl are secrets. A {{secrets.NAME}} reference must be the whole field value. Changing a secret later does not restart a running instance.

PostgreSQL options

The database service the instance depends on (birme-osc-postgresql, MIT, long-running instance):

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
PostgresPassword Yes string, sensitive Password for the PostgreSQL superuser. Store it as a secret, for example {{secrets.postgrespwd}}.
PostgresUser No string Superuser name. Defaults to postgres.
PostgresDb No string Name of the default database created at start. Defaults to the value of the user name.
PostgresInitDbArgs No string Extra arguments passed to initdb when the database cluster is initialized, for example encoding or locale.
PostgresInitDbSql No string SQL executed during database initialization, for example to create additional users or tables.

Using the instance

  1. Open the instance URL to reach the GlitchTip web UI. There is no default admin account; register the first user via the sign-up form at /register. The first registered user receives superuser privileges.
  2. After creating your admin account, change the registration setting to invite only to prevent unauthorised sign-ups (Settings, Organisation, Team).
  3. Create a project (Projects, New Project), select the platform and copy the DSN from the project page.
  4. Point the Sentry SDK of your application at the DSN:
import sentry_sdk
sentry_sdk.init(dsn="https://<key>@<your-instance>.burke-software-glitchtip.auto.prod-se.osaas.io/1")
import * as Sentry from "@sentry/browser";
Sentry.init({ dsn: "https://<key>@<your-instance>.burke-software-glitchtip.auto.prod-se.osaas.io/1" });

Uncaught exceptions and manually captured events then appear in the GlitchTip issues list.

Limitations

  • Storage is limited to 20 GiB per instance.
  • A PostgreSQL database is required.

Resources

⚠️ **GitHub.com Fallback** ⚠️