mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-10-31 10:19:09 +00:00
Kevin Veen-Birkenbach
3a839cfe37
This commit restructures systemctl service definitions and category mappings. Motivation: Alarm-related bugs revealed inconsistencies in service and role handling. Preparation step: lays the groundwork for fixing the alarm issues by aligning categories, roles, and service templates.
25 lines
1.6 KiB
Markdown
25 lines
1.6 KiB
Markdown
# 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](https://telegram.org).
|
||
|
||
## 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.
|
||
|
||
## 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](../sys-ctl-alm-email/README.md) and others.
|
||
|
||
## Other Resources
|
||
|
||
This role was developed as part of a conversation with OpenAI's ChatGPT and can be found [here](https://chat.openai.com/share/96e4ca12-0888-41c0-9cfc-29c0180f0dba).
|