Logister Documentation Overview
Documentation

Logister documentation

Use these docs as the operator and developer manual for Logister. Start by understanding what Logister is, install it, configure the pieces your instance needs, then connect applications and troubleshoot ingestion.

Install Logister Send your first event Troubleshooting

How to use the docs

Pick the section that matches the work in front of you.

Logister docs are organized around the lifecycle of a self-hosted install: understand the product, install the app, configure the instance, use the product, connect runtimes, and debug problems.

Why Logister?

Understand what Logister is before choosing an install path.

Logister is an open source, self-hosted error monitoring and bug triage app. It is built for teams that want grouped production errors, ownership, event context, and operational control without handing monitoring data to a third-party service by default.

What Logister does The user-focused tour of projects, dashboard, inbox, Insights, event details, monitors, notifications, sharing, and self-hosted operations. Self-hosted error monitoring Why teams run Logister on their own infrastructure and what the app needs around it. Use cases and comparisons Fit checks for Sentry, Bugsnag, Bugzilla, Docker registry deployment, team triage, and SES-backed alerting.

Installation

Get a Logister instance running first.

A production install starts with the Rails web app, PostgreSQL, Redis, and a Sidekiq worker. Docker images are published for operators who want to pin a released version and run web and worker containers separately.

Self-hosting Production quickstart, infrastructure plan, Docker option, local quickstart, deployment shapes, and verification steps. Local development Run the app from source with local services while developing Logister or testing a fork. Docker registries Use GHCR, Docker Hub, and optional Quay mirrors when you deploy released containers.

Configuration

Add the settings your instance actually needs.

Keep the first install boring: app, database, Redis, worker, HTTPS, backups, and admin access. Add email, ClickHouse, S3-compatible archive storage, Turnstile, and analytics only when those features matter for your operating model.

Deployment config Environment variables for Rails, PostgreSQL, Redis, Sidekiq, SMTP, SES, S3-compatible storage, Turnstile, analytics, and docs hosting. GitHub App Private repository source excerpts, CODEOWNERS hints, repository sync, deployment links, and optional issue creation. ClickHouse Optional analytics storage, schema checks, worker writes, and readiness verification. Metrics reference Telemetry families, Insights metric keys, span timing fields, custom metric naming, and useful context dimensions.

Usage

Set up projects, send events, and use the product surfaces.

Concept What it means in Logister Where to read
Project One monitored app or service with its own settings, API keys, events, monitors, and team access. Getting started
API key A project-scoped token shown once, used by SDKs or direct HTTP clients to send events. Generate an API key
Error group A grouped issue made from repeated error events so the inbox stays focused on problems, not every occurrence. Triage errors
Occurrence One event inside an error group, with request, release, environment, stacktrace, and related context when the integration sends it. Investigate faster
Insights A project dashboard for event mix, metrics, spans, recent events, environment filters, release filters, and custom dimensions. Project Insights
Check-in A heartbeat from scheduled work such as cron jobs, task runners, recurring workers, and maintenance tasks. Watch scheduled work

Integrations

Connect the runtime that sends your data.

RubyRails exceptions, manual events, logs, metrics, transactions, spans, check-ins, and DB timing. .NETASP.NET Core middleware, C# services, request exceptions, spans, metrics, logs, and check-ins. PythonFastAPI, Django, Flask, Celery, shared clients, logging, metrics, spans, and check-ins. JavaScriptNode, TypeScript, Express middleware, browser timing, console capture, metrics, spans, and check-ins. AndroidKotlin and Java Android app telemetry with release and safe device metadata. iOSSwift Package Manager setup and async app telemetry methods. CFMLLucee and Adobe ColdFusion direct HTTP payloads.

API reference

Use direct HTTP when no SDK is the right fit.

The ingestion API accepts project-token JSON payloads for errors, logs, metrics, transactions, spans, and check-ins. Use the written HTTP guide for semantics, Swagger for schema inspection, and Postman for request testing.

HTTP API Authentication, rate limits, envelopes, event fields, check-ins, responses, and validation errors. Swagger and API artifacts OpenAPI YAML, Swagger UI, and the Postman collection for direct client work.

Troubleshooting

When something is missing, start with the narrowest failing path.

Most setup issues fall into a few buckets: the app is not healthy, the token is wrong, the event envelope is invalid, the worker is not running, email is not configured, or an optional service such as ClickHouse has not been enabled completely.

Troubleshooting guide Practical checks for empty inboxes, rejected events, rate limits, Sidekiq, email, ClickHouse, archive exports, and support context. API response table Map 400, 401, 422, and 429 responses to likely fixes.

Credits

Interface icon attribution

Logister's product interface uses Streamline Freehand free icons by Streamline, licensed under CC BY 4.0.