Skip to content

Latest commit

 

History

History
32 lines (24 loc) · 2.52 KB

README.md

File metadata and controls

32 lines (24 loc) · 2.52 KB
Raw

Zeus Docker Image Version (latest semver)

Telegram bot for Prometheus alerts. Bot provides a flexible and convenient way to send alerts to Telegram.

Status

Work in progress. Not ready for production usage.

Development Code quality (SonarCloud) Code quality (LGTM)
Build Status Quality Gate Status Total alerts

Features

  1. Channels & Subscriptions. Publish alerts to different channels using signle app, manage channel subscriptions from Telegram using commands.
  2. Docker ready. Easy to start using application inside Docker.
  3. Localization (only russian now).
  4. Message template customization. Rich and simple template language, customized templates for different locales and channels.
  5. Transparent API. Debug and test alerts even without Alertmanager via Swagger.

Quickstart

See examples directory to get started with Zeus.

Commands

  1. /echo - displays information about incoming request. Use this command to get Telegram metadata like chat or user identifier.
  2. /subscribe {channel} - subscribe current chat to receive notifications sent to the appropriate channel.
  3. /unsubscribe {channel} - unsubscribe current chat from receiving notifications.

Third-party software

  1. Telegram.Bot - the Bot API is an HTTP-based interface created for developers keen on building bots for Telegram. License: MIT
  2. HttpToSocks5Proxy - the library that allows to connect over Socks5 proxies when using the .NET HttpClient. License: MIT.
  3. MediatR - simple mediator implementation in .NET. License: Apache 2.0
  4. Scriban - Scriban is a fast, powerful, safe and lightweight text templating language and engine for .NET, with a compatibility mode for parsing liquid templates. License: BSD 2.