Skip to content

A lightweight log collection service for sending system logs to the balena API

License

Notifications You must be signed in to change notification settings

balena-os/gazette

Repository files navigation

Gazette

A simple log collection agent that follows the logs for user defined services and agregates them in a single stream. This allows the supervisor to collect and send the logs to the API and provides users and support agents with an extra source of data to diagnose potential device issues. By default only log entries with priority error or higher are collected.

Features

  • Lightweight. Uses journalctl to monitor and filter logs.
  • Configurable. Only collect relevant logs to avoid unnecessary bandwidth usage.
  • Small image size

Supported devices

This block is compatible with all Balena supported device types.

Usage

To use this block as part of a larger application, add the following to your docker-compose.yml.

version: '2.1'

services:
  gazette:
    image: ghcr.io/balena-os/gazette
    labels:
      # Necessary to give the container access to the journal directories
      io.balena.features.journal-logs: '1'
    restart: on-failure

Environment variables

Name Description Default Value
JOURNAL_UNITS Space separated list of systemd services from where to collect logs openvpn
JOURNAL_IDS Space separated list of syslog identifiers from where to collect logs kernel
JOURNAL_PRIORITY Minimal priority of log entries to make them elegible for collection. One of debug, info, warn, error, none. If none is used, then the service will shutdown to save resources error

About

A lightweight log collection service for sending system logs to the balena API

Resources

License

Stars

Watchers

Forks

Packages