observability Phase 2: optional self-hosted GlitchTip as a committed one-command compose

2026-05-21 17:30:49 -07:00
parent c89e4d95e1
commit b72e628c14
6 changed files with 179 additions and 1 deletions
@@ -0,0 +1,29 @@
+# GlitchTip configuration. Copy to .env and fill in. The .env file is
+# gitignored. Generate the two secrets with: openssl rand -hex 32
+
+# Postgres password for GlitchTip's bundled database (any strong value).
+POSTGRES_PASSWORD=
+
+# Django secret key. MUST be set; keep it stable or existing sessions break.
+SECRET_KEY=
+
+# Public base URL GlitchTip uses to build DSNs and links. For the default
+# localhost + SSH-tunnel setup leave as-is; for a reverse-proxied subdomain
+# set e.g. https://glitchtip.example.com
+GLITCHTIP_DOMAIN=http://localhost:8000
+
+# Host port the dashboard binds to (127.0.0.1 only, see docker-compose.yml).
+GLITCHTIP_PORT=8000
+
+# Let the first visitor self-register the initial admin user, then turn this
+# off (set to False and `docker compose up -d`) to close registration.
+ENABLE_OPEN_USER_REGISTRATION=True
+
+# Email. `consolemail://` just logs emails (fine for a single-admin install).
+# For real invites use an SMTP URL, e.g. smtp://user:[email protected]:587
+EMAIL_URL=consolemail://
+DEFAULT_FROM_EMAIL=[email protected]
+
+# Resource tuning for small hosts.
+CELERY_WORKER_CONCURRENCY=1
+WEB_CONCURRENCY=2
@@ -0,0 +1,48 @@
+# Optional: self-hosted error monitoring (GlitchTip)
+
+The app reports server-side errors (the Stripe webhook, the cron dispatchers,
+and every server action via `onRequestError`) to any Sentry-compatible backend
+named by the `SENTRY_DSN` env var. With `SENTRY_DSN` unset the capture seam is a
+no-op, so error monitoring is entirely optional and the app runs fine without it.
+
+This directory is a self-contained, batteries-included way to run that backend
+yourself with [GlitchTip](https://glitchtip.com) (open-source, Sentry-API
+compatible). It brings its own Postgres + Redis and shares nothing with the app
+stack, so it works on any Docker host. You can equally point `SENTRY_DSN` at
+Sentry SaaS instead and skip this entirely.
+
+## Bring it up
+
+```sh
+cd deploy/glitchtip
+cp .env.example .env
+# set POSTGRES_PASSWORD and SECRET_KEY (openssl rand -hex 32)
+docker compose up -d
+```
+
+`migrate` runs once automatically, then `web` + `worker` start. The dashboard
+binds to `127.0.0.1:8000` only (no public surface). Reach it either by:
+
+- an SSH tunnel: `ssh -L 8000:127.0.0.1:8000 you@your-host` then open
+  `http://localhost:8000`, or
+- your own reverse proxy / TLS in front of `127.0.0.1:8000` (set
+  `GLITCHTIP_DOMAIN` to that URL).
+
+## Connect the app
+
+1. In GlitchTip: register the first user, create an Organization, then a
+   Project (platform: Node/JavaScript). Copy the Project's **DSN**.
+2. Set `SENTRY_DSN=<that DSN>` in the app's environment and restart the app.
+   (For the localhost setup the DSN host will be `localhost:8000`; the app
+   reaches GlitchTip over the loopback on the same host.)
+3. Turn off open registration: set `ENABLE_OPEN_USER_REGISTRATION=False` in
+   `.env` and `docker compose up -d`.
+
+## Notes
+
+- Resources: the capped stack needs roughly 1.5-2 GB RAM. On a small host add
+  swap first.
+- Reproducibility: pin the `glitchtip/glitchtip` image to a release tag in
+  `docker-compose.yml` for production (it ships as `latest` so a fresh clone
+  runs without edits).
+- Updates: `docker compose pull && docker compose up -d` (re-runs `migrate`).
@@ -0,0 +1,90 @@
+# Optional self-hosted error monitoring for hackerspace-management.
+#
+# Self-contained: its OWN Postgres + Redis, nothing shared with the app stack,
+# so it works on any host with Docker regardless of how the app's database is
+# run. Bound to 127.0.0.1 by default (no public surface); view the dashboard
+# over an SSH tunnel or put your own reverse proxy in front.
+#
+# Quickstart:
+#   cp .env.example .env       # then set POSTGRES_PASSWORD + SECRET_KEY
+#   docker compose up -d       # migrate runs once, then web + worker start
+# Then register the first user (open http://localhost:GLITCHTIP_PORT), create an
+# organization + project, copy its DSN into the app's SENTRY_DSN, restart the app.
+#
+# Reproducibility: pin `glitchtip/glitchtip` to a release tag for production
+# (see https://gitlab.com/glitchtip/glitchtip for versions); `latest` is used
+# here so a fresh clone runs without edits.
+name: glitchtip
+
+services:
+  postgres:
+    image: postgres:16-alpine
+    restart: unless-stopped
+    mem_limit: 256m
+    environment:
+      POSTGRES_DB: glitchtip
+      POSTGRES_USER: glitchtip
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:?set POSTGRES_PASSWORD in .env}
+    volumes:
+      - gt-postgres:/var/lib/postgresql/data
+    healthcheck:
+      test: ['CMD-SHELL', 'pg_isready -U glitchtip']
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  redis:
+    image: redis:7-alpine
+    restart: unless-stopped
+    mem_limit: 128m
+
+  migrate:
+    image: glitchtip/glitchtip:latest
+    command: ./manage.py migrate
+    restart: 'no'
+    env_file: [.env]
+    environment:
+      DATABASE_URL: postgres://glitchtip:${POSTGRES_PASSWORD}@postgres:5432/glitchtip
+      REDIS_URL: redis://redis:6379/0
+    depends_on:
+      postgres:
+        condition: service_healthy
+
+  web:
+    image: glitchtip/glitchtip:latest
+    restart: unless-stopped
+    mem_limit: 768m
+    env_file: [.env]
+    environment:
+      DATABASE_URL: postgres://glitchtip:${POSTGRES_PASSWORD}@postgres:5432/glitchtip
+      REDIS_URL: redis://redis:6379/0
+      PORT: 8080
+    ports:
+      - '127.0.0.1:${GLITCHTIP_PORT:-8000}:8080'
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_started
+      migrate:
+        condition: service_completed_successfully
+
+  worker:
+    image: glitchtip/glitchtip:latest
+    command: ./bin/run-celery-with-beat.sh
+    restart: unless-stopped
+    mem_limit: 640m
+    env_file: [.env]
+    environment:
+      DATABASE_URL: postgres://glitchtip:${POSTGRES_PASSWORD}@postgres:5432/glitchtip
+      REDIS_URL: redis://redis:6379/0
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_started
+      migrate:
+        condition: service_completed_successfully
+
+volumes:
+  gt-postgres: