systemd-fail-notifications

This software aims to provide a daemon that can be used to listen on a system bus to systemd changes and react to failed units with notifications.

It is somewhat similar to systemd_mon, but instead of listening on the dbus for changes, polling is used to determine the current state of all systemd units. The configuration is done via environment variables or command line arguments and can not be set via a configuration file.

It requires a Linux host with systemd installed.

Deployment

There are two ways available to run this application: either by using the static binary (e.g. as systemd-service) or as a container.

Container

The easiest way to obtain a current version of this software and run it is to create a container image. Clone this repository and build the container image by executing docker build -t systemd-fail-notifications:latest . or download a pre-built image via the GitHub Container Registry.

To run the container (e.g. with docker):

docker run \
    -v /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket \
    -e SYSTEMD_FAIL_NOTIFICATIONS_DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/<id>/<token>" \
    systemd-fail-notifications:latest

Static Binary

Download the static binary from the releases page.

Create a service file (e.g. systemd-fail-notifications.service):

[Unit]
Description=Monitoring of failed systemd services

[Service]
Restart=always
Environment="SYSTEMD_FAIL_NOTIFICATIONS_DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/<id>/<token>"
ExecStart=/path/to/systemd-fail-notifications

[Install]
WantedBy=multi-user.target

Or specify the environment variables in a separate file.

Enable the service file by running systemctl enable /path/to/systemd-fail-notifications.service.

Configuration Options

Use the option -h to print all available configuration values and their corresponding environment variable names. The following table only shows the names of environment variables.

Name	Format	Description
`SYSTEMD_FAIL_NOTIFICATIONS_DISCORD_WEBHOOK_URL`	`https://discord.com/api/webhooks/<id>/<token>`	Discord webhook URL

Development

To build the third-party license information, the cargo-about cargo plugin is required.

This project provides a flake.nix and a shell.nix file, which can be used with a flake-enabled nix tool to build binaries, images, enter a development shell, and run checks (REUSE compliance and formatting). Use the flake command nix flake show to see what is available and run nix flake check before committing.

License

This repository aims to be compliant with the REUSE specification 3.0.

A list of third-party licenses can be obtained by executing the binary with the --about flag.

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

localthomas/systemd-fail-notifications