https://github.com/antonioscardace/netwatch
Service to Check Local Utilities Health and Alert Their Owners.
https://github.com/antonioscardace/netwatch
api-gateway docker health-check hibernate-jpa microservices rabbitmq redis rest-api slack-api spring-boot telegram-api
Last synced: 3 months ago
JSON representation
Service to Check Local Utilities Health and Alert Their Owners.
- Host: GitHub
- URL: https://github.com/antonioscardace/netwatch
- Owner: antonioscardace
- License: gpl-3.0
- Created: 2025-03-02T21:24:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-02T21:55:29.000Z (3 months ago)
- Last Synced: 2025-03-02T22:18:20.698Z (3 months ago)
- Topics: api-gateway, docker, health-check, hibernate-jpa, microservices, rabbitmq, redis, rest-api, slack-api, spring-boot, telegram-api
- Language: Java
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NetWatch • Utilities Health Monitor
[](https://www.codefactor.io/repository/github/antonioscardace/netwatch)
[](https://github.com/antonioscardace/netwatch/blob/master/LICENSE)
[](https://github.com/antonioscardace/netwatch/issues)
[](https://github.com/antonioscardace/NetWatch/actions/workflows/ci-test.yml)
The project is a health checker. It aims to check in real-time the health of each observed local utility.
The utility can be a Docker Container, a Machine, or a Network Device in your local network.
The monitor notifies the utility referent if it changes its state (i.e. **goes offline** or **comes back online**).
The alert can be a Slack message, an Email, or a Telegram message like these:
An accurate report can be found in [/docs/report.pdf](/docs/report.pdf)
This project was created as an exam project to test a set of skills, including:
+ Knowledge of Microservices
+ Knowledge of Design Patterns
+ Knowledge of Java, Maven, and Spring Boot
+ Knowledge of Messaging Systems (RabbitMQ) and their Patterns
+ Knowledge of Git & GitHub
I also had the opportunity to practice the following skills:
+ Knowledge of ORMs (Hibernate)
+ Knowledge of Redis
+ Use of the Static Analysis Tools (CodeFactor, Snyk Code, and Sonar Qube)
## System Infrastructure
Each microservice is contained in a Docker Container.
The only reachable containers in the Docker Network are Frontend, API Gateway, and Grafana.
The UML of the internal structure of each microservice is stored in [/docs/uml/](/docs/uml/)
## Getting Started
* Get any set of valid credentials or tokens (e.g. for Telegram) to send notifications.
* Download and install [Docker](https://docs.docker.com/get-docker/).
```sh
$ git clone https://github.com/antonioscardace/NetWatch.git
$ cd YOUR_PATH/NetWatch/
$ bash run.sh
```
### Useful Links
Container | URL | Description
----- | ------- | -------
grafana-charts | [https://localhost:8800/](https://localhost:8800/d/2xZ6SccSz/netwatch-logs?orgId=1&refresh=5s&from=now-24h&to=now) | Grafana Logs
rabbitmq | http://localhost:15672/ | RabbitMQ UI