Sys-ctl-alm-telegram Role

Description: Systemd-triggered notifier for delivering service-failure alerts to a Telegram chat

Variables

  • author: Kevin Veen-Birkenbach

  • description: Systemd-triggered notifier for delivering service-failure alerts to a Telegram chat

  • license: Infinito.Nexus Community License (Non-Commercial)

  • company: Kevin Veen-Birkenbach https://www.veen.world

  • min_ansible_version: 2.9

  • platforms: [{‘name’: ‘ArchLinux’, ‘versions’: [‘all’]}, {‘name’: ‘Debian’, ‘versions’: [‘all’]}, {‘name’: ‘EL’, ‘versions’: [‘all’]}, {‘name’: ‘Fedora’, ‘versions’: [‘all’]}, {‘name’: ‘Ubuntu’, ‘versions’: [‘all’]}]

  • galaxy_tags: [‘telegram’, ‘systemd’, ‘notifications’, ‘automation’, ‘curl’]

  • issue_tracker_url: https://s.infinito.nexus/issues

README

Automated Telegram Alerts for Service Failures

Description

This role installs and configures the necessary components for sending notifications via systemd when a service fails. It sets up the sys-ctl-alm-telegram service and configures parameters and customizable templates for sending messages through Telegram.

Overview

Optimized for real-time alerts, this role is a key component of the overall `sys-ctl-alm-compose suite <../>`__. It ensures that, upon failure of a critical service, a Telegram message is automatically sent to notify administrators and enable prompt troubleshooting.

Cosmos

The diagram places Automated Telegram Alerts for Service Failures in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

flowchart LR
    subgraph role [sys-ctl-alm-telegram 💻]
        svc_telegram["telegram"]
    end

Solid 1:1 edges are fixed relationships; dashed 0..1 edges are conditional (enabled only in matching deployments); red 0..0 edges are turned off in this role. Node markers show the role’s deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in meta/main.yml.

Purpose

The primary purpose of this role is to provide a robust solution for automated Telegram notifications in a systemd environment. By integrating with Telegram’s Bot API and using customizable message templates, it delivers clear and timely alerts about service failures, thereby enhancing system observability and reliability.

Features

  • Service Installation & Configuration: Installs and configures necessary components (including the curl package).

  • Customizable Templates: Supports tailored Telegram message templates for service failure notifications.

  • Secure Notifications: Leverages systemd to trigger alerts automatically when services fail.

  • Suite Integration: Part of the `sys-ctl-alm-compose suite <../>`__ which includes related roles such as sys-ctl-alm-email and others.

Credits

Implemented by Kevin Veen-Birkenbach. Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).