https://github.com/balena-os/gazette

A lightweight log collection service for sending system logs to the balena API
https://github.com/balena-os/gazette

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/balena-os/gazette
• Owner: balena-os
• License: apache-2.0
• Created: 2022-12-05T20:11:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-22T17:54:15.000Z (11 months ago)
• Last Synced: 2024-01-22T22:12:21.728Z (11 months ago)
• Language: Shell
• Homepage:
• Size: 35.2 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://www.balena.io/) [supported device types](https://hub.balena.io/device-types).

## Usage

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

```yaml

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](https://wiki.archlinux.org/title/systemd#Using_units) 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         |