Configuration

There is currently very little configuration required to use Central Logging. Most configuration is done through the web interface. However, there are a few things that can be configured via environment variables and CLI flags.

CLI Flags

  • -v — Display the application version and build date
  • -install — Install Central Logging as a systemd service (requires sudo)
  • -update — Download and install the latest version of the binary

Environment Variables

  • PORT — HTTP listen address and port. Defaults to :80. Set this when running locally or behind a reverse proxy (e.g. PORT=:8080).

S3 Backups

To enable S3 compatible backups, set the following environment variables:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY
  • BACKUP_AWS_REGION
  • BACKUP_S3_BUCKET

Web UI Settings

After initial setup, the following settings are available in the Settings page:

  • Host — The domain name used for links back to your Central Logging instance. Must be a valid domain.
  • Admin Email — Used for Let’s Encrypt TLS certificates and login.
  • License Key — Unlock additional features with a license key.

Log Source Configuration

Each log source can be configured individually:

  • Retention Days — How many days to keep logs before automatic cleanup. Defaults to 15 days.
  • Transform Script — An optional JavaScript transformation applied to incoming logs during batch processing. See Sending Logs for details.

Data Directory

Central Logging stores all data in a cl-data/ directory relative to the binary:

cl-data/
├── db.db                    # Main application database
├── sessions.db              # Session store
├── {source-token}/
│   └── logs.db              # Per-source log database
└── metrics/
    └── {metric-token}/
        └── metrics.db       # Per-metric time-series data

Backups of the main database are created automatically on a daily schedule.

💌 Get notified on new features and updates

Only sent when a new version is released. Nothing else.