Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capcom6/service-monitor-tgbot
Telegram bot for monitoring network services
https://github.com/capcom6/service-monitor-tgbot
alert alerting http https monitoring monitoring-tool services tcp telegram telegram-bot
Last synced: 2 months ago
JSON representation
Telegram bot for monitoring network services
- Host: GitHub
- URL: https://github.com/capcom6/service-monitor-tgbot
- Owner: capcom6
- License: apache-2.0
- Created: 2023-01-13T17:18:02.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T16:10:44.000Z (about 1 year ago)
- Last Synced: 2024-06-21T20:02:54.536Z (7 months ago)
- Topics: alert, alerting, http, https, monitoring, monitoring-tool, services, tcp, telegram, telegram-bot
- Language: Go
- Homepage:
- Size: 95.7 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
Service Monitor Telegram Bot
Telegram bot for monitoring the availability of network services.
·
Report Bug
·
Request Feature
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [HTTP service monitoring example](#http-service-monitoring-example)
- [TCP service monitoring example](#tcp-service-monitoring-example)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## About The Project
Monitoring the availability of network services is an important task for any project. At the same time, it is not always necessary to deploy universal solutions like Prometheus, a fairly simple solution. It is for such cases that this bot was created.
The bot will allow you to monitor the availability of HTTP(S) and TCP services and notify Telegram about changes in their status.
The project is in the MVP stage.
### Built With
* [![Golang][Golang]][Golang-url]
## Getting Started
Follow the instructions below to run a bot using Docker.
### Prerequisites
To run a bot, it is enough to have Docker or another environment for running containers.
### Installation
1. Register a new bot and get a token for it: https://core.telegram.org/bots/features#creating-a-new-bot
2. Create a [channel](https://telegram.org/tour/channels) or [group](https://telegram.org/tour/groups) to which notifications will be sent
3. Add the bot to the channel/group as an administrator with the ability to send messages
4. Copy the configuration file [config.example.yml](configs/config.example.yml) to your working directory as `config.yml`
5. Make changes to the configuration file:
- specify the bot token;
- specify the channel/group ID, you can find out the ID, for example, by following the link like [https://api.telegram.org/bot/getUpdates?allowed_updates=[]](https://api.telegram.org/bot/getUpdates?allowed_updates=[]) after adding the bot to a channel/group and finding the value of `my_chat_member.chat.id`;
- list the services to monitor.
6. Run the docker container: `docker run -d -v "$(pwd)/config.yml:/app/config.yml:ro" --name tgbot capcom6/service-monitor-tgbot:latest`
## Usage
### HTTP service monitoring example
```yaml
services:
- name: Google
initialDelaySeconds: 5
periodSeconds: 10
timeoutSeconds: 1
successThreshold: 1
failureThreshold: 3
httpGet:
scheme: https
host: google.com
path: /
port: 443
httpHeaders:
- name: X-Header
value: value
```
![HTTP Alert][http-alert]
### TCP service monitoring example
```yaml
services:
- name: MySQL
initialDelaySeconds: 5
periodSeconds: 10
timeoutSeconds: 1
successThreshold: 1
failureThreshold: 3
tcpSocket:
host: localhost
port: 3306
```
![TCP Alert][tcp-alert]
## Roadmap
- [x] Add Changelog
- [x] Add the ability to change the text of messages
- [ ] Send notifications to multiple channels/groups
- [ ] Display event time in notifications
- [ ] Online/offline time count
- [ ] Active bot mode
- [ ] Request current state of services
- [ ] SLA report
- [ ] The event log
- [ ] Separation of bot and monitoring service
- [ ] Dynamic list of services
- [ ] Service discovery
- [ ] Resource groups
See the [open issues](https://github.com/capcom6/service-monitor-tgbot/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Apache-2.0 license. See `LICENSE.txt` for more information.
## Contact
Project Link: [https://github.com/capcom6/service-monitor-tgbot](https://github.com/capcom6/service-monitor-tgbot)
[contributors-shield]: https://img.shields.io/github/contributors/capcom6/service-monitor-tgbot.svg?style=for-the-badge
[contributors-url]: https://github.com/capcom6/service-monitor-tgbot/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/capcom6/service-monitor-tgbot.svg?style=for-the-badge
[forks-url]: https://github.com/capcom6/service-monitor-tgbot/network/members
[stars-shield]: https://img.shields.io/github/stars/capcom6/service-monitor-tgbot.svg?style=for-the-badge
[stars-url]: https://github.com/capcom6/service-monitor-tgbot/stargazers
[issues-shield]: https://img.shields.io/github/issues/capcom6/service-monitor-tgbot.svg?style=for-the-badge
[issues-url]: https://github.com/capcom6/service-monitor-tgbot/issues
[license-shield]: https://img.shields.io/github/license/capcom6/service-monitor-tgbot.svg?style=for-the-badge
[license-url]: https://github.com/capcom6/service-monitor-tgbot/blob/master/LICENSE.txt
[product-screenshot]: assets/screenshot.png
[http-alert]: assets/http-alert.png
[tcp-alert]: assets/tcp-alert.png
[Golang]: https://img.shields.io/badge/Golang-000000?style=for-the-badge&logo=go&logoColor=white
[Golang-url]: https://go.dev/