Documentation

Open source error monitoring docs for Logister

Logister is an open source, self-hosted error monitoring and bug triage app for teams that want a forkable alternative to Bugsnag, Sentry, and Bugzilla-style workflows. Run it yourself to collect errors, logs, metrics, transactions, spans, and check-ins in infrastructure you control; the hosted app at logister.org is secondary for teams that want a managed convenience path.

Overview

Choose the guide that matches your project type.

Logister provides public documentation for running your own instance first, then connecting Ruby, .NET, Python, JavaScript, Android, iOS, CFML, and custom HTTP clients to it. Start with self-hosting when you are planning infrastructure, or with the integration guide that matches how your application sends data today.

Logister is self-hosted and self-hostable first. The public logister.org app is a secondary hosted option; the source, GHCR and Docker Hub images, optional Quay mirrors, release notes, and operations docs are here so teams can run it themselves.
Guide Best for Main setup path
Operations guides Teams self-hosting Logister Local development, deployment, S3-compatible archive storage, ClickHouse, and HTTP reference
Ruby integration Ruby apps and Rails services logister-ruby gem
.NET integration ASP.NET Core apps and C# services logister-dotnet SDK with ASP.NET Core middleware
Python integration FastAPI, Django, Flask, Celery, and general Python apps logister-python package with framework helpers and Python logging support
CFML integration Lucee and Adobe ColdFusion sites cfhttp plus structured event payloads
JavaScript integration JavaScript and TypeScript apps logister-js package with optional Express middleware and console capture
Android integration Kotlin and Java Android apps org.logister:logister-android from Maven Central
iOS integration Swift iOS apps Logister from Swift Package Manager at github.com/taimoorq/logister-ios
Manual / HTTP API Unsupported runtimes, scripts, workers, and custom clients cURL, OpenAPI, Postman, or any HTTP client that can send project-token JSON payloads

Public repos and packages

Use the open source repo that matches the part you are running or integrating.

The main Logister app and language clients are separate public repositories so SDKs can version and publish independently from the self-hosted Rails app.

Project Repository Package or registry
Main app github.com/taimoorq/logister GHCR, Docker Hub, and optional Quay mirrors when configured
Ruby gem github.com/taimoorq/logister-ruby RubyGems: logister-ruby
.NET SDK github.com/taimoorq/logister-dotnet NuGet: Logister and Logister.AspNetCore
Python package github.com/taimoorq/logister-python PyPI: logister-python
JavaScript package github.com/taimoorq/logister-js npm: logister-js
Android SDK github.com/taimoorq/logister-android Maven Central: org.logister:logister-android
iOS SDK github.com/taimoorq/logister-ios Swift Package Manager: Logister via Git tag v0.1.0
CFML Direct HTTP integration guide No separate add-on repo is required; CFML apps send structured JSON with cfhttp.

Use cases

Start from the problem or comparison your team is evaluating.

Self-hosting

Self-hosted error monitoring

Run Logister yourself with Rails, PostgreSQL, Redis, Sidekiq, SMTP/Amazon SES, optional S3 archive storage, optional ClickHouse, and registry images.

Read the use case

Comparison

Sentry alternative

Evaluate Logister when you want forkable source, owned infrastructure, grouped errors, assignment, and release context.

Compare the fit

Comparison

Bugsnag alternative

Evaluate Logister when first-occurrence alerts, digest emails, and team-owned triage should live in your own stack.

Compare the fit

Comparison

Bugzilla alternative

Use production error context as the start of bug ownership, not a separate manual ticket-writing step.

Compare the fit

Operations

Docker registry self-hosting

Run versioned Docker images with separate Rails web and Sidekiq worker containers in your own infrastructure.

Read the Docker use case

Workflow

Error assignment and team triage

Assign grouped production errors to teammates, filter by assignee, and keep ownership close to the event context.

Read the triage use case

Notifications

Amazon SES alert emails

Send first-occurrence alerts and daily or weekly digest emails through Rails SMTP settings backed by SES.

Read the SES use case

What Logister helps with

Use Logister to move from raw events to decisions.

Overview

See cross-app signals before drilling in

The dashboard surfaces event mix, needs-attention summaries, and active project signals across the apps you monitor.

Insights

Build live project views from collected signals

The project Insights tab combines Inbox, Activity, and Performance data with metric selection, time windows, environment and release filters, custom attribute filters, and span-backed request load charts.

Triage

See which errors still need attention

Grouped issues, status filters, search, and occurrence history help your team decide what to fix, ignore, archive, or reopen.

Investigate

Open one event and get the surrounding context

Runtime-aware details, request context, release metadata, and related logs keep the investigation close to the problem.

Operate

Watch performance, retention, and project lifecycle

Transaction metrics, release health, check-in monitors, archive exports, hot telemetry pruning, archived projects, and notification preferences help teams operate the instance cleanly.

Read the product guide for the user-focused tour of what teams can do in Logister.

Guides

Everything you need to get from zero to a working event feed.

Start here

Set up your first project

Create a project, choose the right integration type, generate an API key, and send your first event.

Read getting started

Product guide

See what your team can do in Logister

Use this guide to understand the dashboard, Insights, inbox, event details, performance views, monitors, notifications, project lifecycle, sharing, and self-hosted operations.

Read the product guide

Metrics reference

Choose what developers can collect

Use this guide for telemetry families, Insights series, add-on support, event fields, span fields, filter dimensions, and data collection boundaries.

Read the metrics reference

API reference

Import the contract or collection

Use the Swagger page, OpenAPI YAML, or Postman collection when you are building a custom client or testing every supported event family.

Open API reference

Operations

Self-host Logister

Use the operations docs for local boot, deployment configuration, S3-compatible archive storage, ClickHouse, and HTTP payload reference.

Read self-hosting docs

Ruby

Install the Ruby package

Use the Ruby integration guide for Rails exceptions, manual errors, logs, metrics, transactions, spans, check-ins, DB timing, and self-monitoring through logister-ruby.

Read Ruby docs or open RubyGems.

.NET

Install the .NET SDK

Use the .NET integration guide for ASP.NET Core request exceptions, transactions, spans, C# service metrics, logs, and check-ins.

Read .NET docs or open NuGet.

Python

Install the package

Use the Python integration guide for FastAPI, Django, Flask, Celery, shared-client Python apps, native logging capture, metrics, spans, and check-ins.

Read Python docs or open PyPI.

CFML

Send direct payloads

Use the CFML guide for Lucee or Adobe ColdFusion apps that send errors, logs, metrics, transactions, spans, and check-ins over HTTP.

Read CFML docs

JavaScript

Install the npm package

Use the JavaScript guide for JavaScript and TypeScript apps using logister-js, with optional Express middleware, browser timing, console capture, metrics, spans, and check-ins.

Read JavaScript docs or open npm.

Android

Install the Maven package

Use the Android guide for Kotlin-first Android app telemetry with errors, logs, metrics, transactions, spans, check-ins, release context, and safe device metadata.

Read Android docs or open Maven Central.

iOS

Add the Swift package

Use the iOS guide for Swift app telemetry through Swift Package Manager, including errors, logs, metrics, transactions, spans, check-ins, release context, and safe device metadata.

Read iOS docs or open the SwiftPM release.

Manual / HTTP API

Send direct API payloads

Use the HTTP API path for unsupported runtimes, one-off scripts, workers, and custom clients that report errors, logs, metrics, transactions, spans, or check-ins directly.

Read HTTP API docs or open Swagger.

Getting started next

Follow the shortest path to your first event.

  1. Create a project and choose the right integration type.
  2. Generate an API key and store it immediately.
  3. Pick the Ruby, .NET, Python, JavaScript, Android, iOS, CFML, or Manual / HTTP API guide based on your application stack.
  4. Use the HTTP API page, Swagger reference, or Postman collection when you need the exact request shape.
  5. Send one known-good event before broadening instrumentation.

Growing the docs

This is the base for a standalone documentation site.

This static export is designed so the docs can live separately from either a self-hosted Logister instance or the secondary hosted app. It keeps the same information architecture as the product docs while removing the app runtime dependency, and includes a machine-readable /llms.txt index for AI tools that need the public docs map. The fuller /llms-full.txt file gives agents a denser product, operations, release, and comparison context.

  • Integration guides stay public and easy to share.
  • Operations docs no longer need to live in the README.
  • Future product docs can be added as plain HTML in this directory.

Credits

Interface icon attribution

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