Skip to content

Latest commit

 

History

History
110 lines (68 loc) · 3.26 KB

README.md

File metadata and controls

110 lines (68 loc) · 3.26 KB
Raw

status-msg-teams

Utility for reporting SystemD errors to Microsoft Teams.

Setup

  1. Install dependencies:

    • jq
    • wget
    sudo dnf install jq

  2. Clone this repository on the server in question. We assume it is located at /srv/status-msg-teams in the following instructions.

  3. Make send-status-to-teams available to run:

    sudo ln -s /srv/status-msg-teams/send-status-to-teams /usr/local/bin/send-status-to-teams

  4. Copy in the SystemD service file:

    sudo cp [email protected] /etc/systemd/system

  5. Edit the file (e.g. sudo nano /etc/systemd/system/[email protected]) and replace <URL> with a webhook URL acquired from Microsoft Teams.

  6. Make SystemD aware of our changes:

    sudo systemctl daemon-reload

Usage

This section describes the ways this utility can be used.

As shell script

send-status-to-teams is available as a command you can run.

Usage:

send-status-to-teams unit [webhook-URL]

Parameters

unit: the name of the SystemD unit you would like to report the status of.

webhook-URL: the Microsoft Teams webhook the status message should be sent to. If this parameter is not given, the environment variable called WEBHOOK_URL will be used instead.

Behaviour

When run, a message will be posted to the provided webhook URL. The message is the same as the output provided by systemctl status UNIT, with an appropriate title.

As SystemD service

This is a so-called parameterized SystemD service. This means that it is a template, which you can create many new services out of.

The parameter is the name of the SystemD unit you would like to report the status of. You place it after the @, but before .service when referring to the service using systemctl and so on.

Say you have a unit named example.service. The following command immediately reports its status to Microsoft Teams:

sudo systemctl start [email protected]
#                                     ^^^^^^^^^^^^^^^ <- parameter

In the example above, example.service is the parameter. The second .service applies to the entire name (including status-msg-teams). You can think of it as (status-msg-teams@(example.service)).service.

As automatic report when SystemD service fails

Just like you can invoke the service manually with systemctl, SystemD can invoke the service automatically when certain conditions are met. To report the status when an error occurs, you can set the OnFailure directive to status-msg-teams@%n.service. %n is automatically replaced with the unit's name.

For example, for example.service:

[Unit]
Description=Example service
OnFailure=status-msg-teams@%n.service

[Service]
Type=oneshot
ExecStart=/usr/bin/echo Oh wow, what an example

Links