GlitchTip

https://glitchtip.com/documentation
Admin
GlitchTip is an open-source error tracking and uptime monitoring platform that notifies you...
Tokens:16,875
Snippets:171
Trust Score:8.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install GlitchTip CLI via install script

Source: https://glitchtip.com/documentation/cli

Installs the GlitchTip CLI by detecting the OS and architecture, downloading the appropriate pre-built binary, and installing it to /usr/local/bin (or ~/.local/bin if /usr/local/bin is not writable).

```bash
curl -fsSL https://glitchtip.com/install.sh | sh
```

--------------------------------

### GlitchTip CLI configuration file example

Source: https://glitchtip.com/documentation/cli

Example INI configuration file for the GlitchTip CLI, showing the [auth] and [defaults] sections.

```ini
[auth]
token=your-api-token

[defaults]
url=https://your-glitchtip.example.com
org=my-org
project=my-project
```

--------------------------------

### Install GlitchTip CLI from source with Cargo

Source: https://glitchtip.com/documentation/cli

Installs the GlitchTip CLI from source using Cargo, requiring Rust to be installed.

```bash
cargo install glitchtip-cli
```

--------------------------------

### Install GlitchTip without Docker

Source: https://glitchtip.com/documentation/install

Commands for installing GlitchTip without Docker: download the frontend artifacts, extract and move them, install Python dependencies with uv, migrate the database, and collect static files. Replace <VERSION HERE> with the exact version tag from the backend release.

```bash
wget https://gitlab.com/api/v4/projects/15449363/jobs/artifacts/<VERSION HERE>/download?job=build-assets -O assets.zip
```

```bash
unzip assets.zip; mv dist/glitchtip-frontend/browser /opt/glitchtip/dist
```

```bash
uv sync
```

```bash
./manage.py migrate
```

```bash
./manage.py collectstatic
```

--------------------------------

### Send a test event

Source: https://glitchtip.com/documentation/cli

Sends a test event to verify the setup.

```bash
glitchtip-cli send-event -m "Test event from CLI"
```

--------------------------------

### Add and install GlitchTip Helm chart

Source: https://glitchtip.com/documentation/install

Add the GlitchTip Helm chart repository and install the chart with your own values file. You can also use --set to override values.

```bash
helm repo add glitchtip https://gitlab.com/api/v4/projects/16325141/packages/helm/stable
```

```bash
helm install glitchtip glitchtip/glitchtip -f your-values.yaml
```

--------------------------------

### nginx server block for GlitchTip proxy

Source: https://glitchtip.com/documentation/install

Example nginx server configuration to proxy requests to GlitchTip on port 8000. Sets client_max_body_size to 40M and forwards necessary headers. Use this in /etc/nginx/sites-enabled/default.

```nginx
server {
    server_name glitchtip.example.com;
    access_log  /var/log/nginx/access.log;
    client_max_body_size 40M;

    location / {
        proxy_pass http://127.0.0.1:8000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}
```

--------------------------------

### Manage deploys with GlitchTip CLI

Source: https://glitchtip.com/documentation/cli

Records deployments for a release and lists them.

```bash
glitchtip-cli deploys new 1.0.0 --env production --org my-org --project my-project
glitchtip-cli deploys list 1.0.0 --org my-org --project my-project
```

--------------------------------

### Manage releases with GlitchTip CLI

Source: https://glitchtip.com/documentation/cli

Commands to create, finalize, associate commits, list, and delete releases.

```bash
# Create a new release
glitchtip-cli releases new 1.0.0 --org my-org --project my-project

# Finalize a release
glitchtip-cli releases finalize 1.0.0 --org my-org --project my-project

# Associate commits with a release (auto-discovers from git)
glitchtip-cli releases set-commits 1.0.0 --auto --org my-org --project my-project

# List releases
glitchtip-cli releases list --org my-org --project my-project

# Delete a release
glitchtip-cli releases delete 1.0.0 --org my-org --project my-project
```

--------------------------------

### Enable MCP with environment variable

Source: https://glitchtip.com/documentation/mcp

Set GLITCHTIP_ENABLE_MCP=True on your GlitchTip server to enable the MCP server.

```bash
GLITCHTIP_ENABLE_MCP=True
```

--------------------------------

### CLI command to list logs

Source: https://glitchtip.com/documentation/logs

Query logs from the command line using the GlitchTip CLI. Replace 'your-org' with your organization slug.

```bash
glitchtip-cli logs list --org your-org
```

--------------------------------

### Enable DuckDB cold storage

Source: https://glitchtip.com/documentation/install

Set GLITCHTIP_ENABLE_DUCKDB=true to enable cold storage, which archives older data to Parquet files on S3 or local filesystem, queryable via DuckDB.

```bash
GLITCHTIP_ENABLE_DUCKDB=true
```

--------------------------------

### Manage uptime monitors with GlitchTip CLI

Source: https://glitchtip.com/documentation/cli

Commands to list, run, create, and delete uptime monitors, including sending heartbeats.

```bash
# List monitors
glitchtip-cli monitors list --org my-org

# Run a command and send a heartbeat on success
glitchtip-cli monitors run <ENDPOINT_UUID> -- python manage.py scheduled_task

# Create a monitor
glitchtip-cli monitors create "My Monitor" --url https://example.com --org my-org --project my-project

# Delete a monitor
glitchtip-cli monitors delete <MONITOR_ID> --org my-org
```

--------------------------------

### Manage issues with GlitchTip CLI

Source: https://glitchtip.com/documentation/cli

Commands to list, resolve, mute, and unresolve issues.

```bash
# List issues
glitchtip-cli issues list --org my-org --project my-project

# Resolve issues
glitchtip-cli issues resolve --id 123

# Mute issues
glitchtip-cli issues mute --id 456

# Unresolve issues
glitchtip-cli issues unresolve --id 789
```

--------------------------------

### Python Sentry SDK initialization for logs

Source: https://glitchtip.com/documentation/logs

Initialize the Sentry SDK in Python with enable_logs=True to send logs to GlitchTip. Logs from the standard logging module are forwarded automatically; you can also call sentry_sdk.logger.info(...) directly.

```python
import sentry_sdk

sentry_sdk.init(
    dsn="https://your-dsn@your-glitchtip.example.com/1",
    traces_sample_rate=0.01,  # 1% of transactions — adjust to your needs
    auto_session_tracking=False,  # GlitchTip does not support sessions
    enable_logs=True,
)
```

--------------------------------

### Inject and upload source maps with GlitchTip CLI

Source: https://glitchtip.com/documentation/error-tracking

Use the GlitchTip CLI (Beta) to inject debug IDs and upload source maps for JavaScript projects, enabling readable stack traces. Replace the placeholder organization and project names with your own.

```bash
glitchtip-cli sourcemaps inject ./dist
glitchtip-cli sourcemaps upload ./dist --org my-org --project my-project
```

--------------------------------

### Check GlitchTip CLI configuration and auth status

Source: https://glitchtip.com/documentation/cli

Checks current configuration and authentication status.

```bash
glitchtip-cli info
```

--------------------------------

### Log in to GlitchTip with API token

Source: https://glitchtip.com/documentation/cli

Logs in to a GlitchTip instance. By default, prompts to paste an API token.

```bash
glitchtip-cli --url https://your-glitchtip.example.com login
```

--------------------------------

### Create limited web role with read/write permissions

Source: https://glitchtip.com/documentation/install

Creates a limited PostgreSQL role for the GlitchTip web service with read/write access to existing and future tables, sequences, and functions. Replace the password and database name before running.

```sql
CREATE ROLE glitchtip_app WITH LOGIN PASSWORD 'replace_with_app_password';
GRANT CONNECT ON DATABASE your_database_name TO glitchtip_app;
GRANT USAGE ON SCHEMA public TO glitchtip_app;

-- Grant read/write permissions on all EXISTING tables, sequences, and functions.
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA public TO glitchtip_app;
GRANT USAGE, SELECT ON ALL SEQUENCES IN SCHEMA public TO glitchtip_app;
GRANT EXECUTE ON ALL FUNCTIONS IN SCHEMA public TO glitchtip_app;

-- Grant read/write permissions on all FUTURE tables, sequences, and functions.
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO glitchtip_app;
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT USAGE, SELECT ON SEQUENCES TO glitchtip_app;
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT EXECUTE ON FUNCTIONS TO glitchtip_app;
```

--------------------------------

### Claude Desktop MCP configuration

Source: https://glitchtip.com/documentation/mcp

Add GlitchTip as an MCP server in Claude Desktop's configuration. Claude Desktop handles the OAuth flow automatically on first connect.

```json
{
  "mcpServers": {
    "glitchtip": {
      "url": "https://your-glitchtip.example.com/mcp"
    }
  }
}
```

--------------------------------

### Log in to GlitchTip with OAuth

Source: https://glitchtip.com/documentation/cli

Logs in using browser-based OAuth authentication. Credentials are saved to a local .sentryclirc file (or globally with --global to ~/.config/glitchtip-cli/config).

```bash
glitchtip-cli --url https://your-glitchtip.example.com login --method oauth
```

--------------------------------

### JavaScript Sentry SDK initialization for logs

Source: https://glitchtip.com/documentation/logs

Initialize the Sentry SDK in JavaScript with enableLogs: true to send logs to GlitchTip. This is the browser SDK; other SDKs that support structured logs will work similarly.

```javascript
import * as Sentry from "@sentry/browser";

Sentry.init({
  dsn: "https://your-dsn@your-glitchtip.example.com/1",
  tracesSampleRate: 0.01,
  autoSessionTracking: false,
  enableLogs: true,
});
```

--------------------------------

### Enable tracing with tracesSampleRate

Source: https://glitchtip.com/documentation/performance

Enable tracing in Sentry SDKs by setting tracesSampleRate to a value between 0.0 and 1.0. Use a lower rate in production to reduce overhead and data volume.

```python
import sentry_sdk

sentry_sdk.init(
    dsn="YOUR_DSN",
    traces_sample_rate=0.1,  # capture 10% of transactions
)
```

```javascript
Sentry.init({
  dsn: "YOUR_DSN",
  tracesSampleRate: 0.1,
});
```

--------------------------------

### Create Django superuser

Source: https://glitchtip.com/documentation/install

Creates a Django superuser to enable access to the Django Admin interface at /admin/. Required for managing users beyond the frontend capabilities.

```bash
./manage.py createsuperuser
```

--------------------------------

### Add GlitchTip via Claude Code CLI

Source: https://glitchtip.com/documentation/mcp

Use `claude mcp add` with the HTTP transport to add GlitchTip. On first connect, Claude Code walks you through authentication.

```bash
claude mcp add --transport http glitchtip https://your-glitchtip.example.com/mcp
```

--------------------------------

### Upload debug files with GlitchTip CLI

Source: https://glitchtip.com/documentation/cli

Uploads debug symbols for native applications (dSYM, PDB, ELF).

```bash
glitchtip-cli debug-files upload ./build --org my-org --project my-project
```

--------------------------------

### Create maintainer role for worker and migrate services

Source: https://glitchtip.com/documentation/install

Creates a PostgreSQL role for the GlitchTip worker and migrate services with full schema permissions, including CREATE, DROP, and ALTER. Both services must use the same role because they manage partitions.

```sql
CREATE ROLE glitchtip_maintainer WITH LOGIN PASSWORD 'replace_with_maintainer_password';
GRANT CONNECT ON DATABASE your_database_name TO glitchtip_maintainer;
GRANT CREATE, USAGE ON SCHEMA public TO glitchtip_maintainer;

-- Grant full permissions for all existing tables, sequences, and functions.
GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO glitchtip_maintainer;
GRANT ALL PRIVILEGES ON ALL SEQUENCES IN SCHEMA public TO glitchtip_maintainer;
GRANT ALL PRIVILEGES ON ALL FUNCTIONS IN SCHEMA public TO glitchtip_maintainer;

-- Grant full permissions for any new tables this role creates in the future.
ALTER DEFAULT PRIVILEGES FOR ROLE glitchtip_maintainer IN SCHEMA public
   GRANT ALL PRIVILEGES ON TABLES TO glitchtip_maintainer;
ALTER DEFAULT PRIVILEGES FOR ROLE glitchtip_maintainer IN SCHEMA public
   GRANT ALL PRIVILEGES ON SEQUENCES TO glitchtip_maintainer;
ALTER DEFAULT PRIVILEGES FOR ROLE glitchtip_maintainer IN SCHEMA public
   GRANT ALL PRIVILEGES ON FUNCTIONS TO glitchtip_maintainer;
```

--------------------------------

### Apache2 proxy configuration for GlitchTip

Source: https://glitchtip.com/documentation/install

Apache2 vhost proxy settings to forward requests to GlitchTip on port 8000. Requires mods header, proxy, and proxy_http. Sets X-Forwarded-Proto and X-Forwarded-SSL headers.

```apache
        ProxyPreserveHost On
        ProxyPass / http://localhost:8000/
        ProxyPassReverse / http://localhost:8000/
        RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
        RequestHeader set "X-Forwarded-SSL" expr=%{HTTPS}
```
Tokens:
Raw