From 8f184a38637af34abeb4517eeab6dd37d08f0f09 Mon Sep 17 00:00:00 2001 From: Antonio Scardace <33966051+antonioscardace@users.noreply.github.com> Date: Thu, 13 Jun 2024 19:00:05 +0200 Subject: [PATCH] update: README file --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4547ffd..f511380 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,13 @@ _[Antonio Scardace](https://linktr.ee/antonioscardace)_ @ _Dept of Math and Comp [![CodeFactor](https://www.codefactor.io/repository/github/antonioscardace/netwatch/badge)](https://www.codefactor.io/repository/github/antonioscardace/netwatch) [![License](https://img.shields.io/github/license/antonioscardace/netwatch.svg)](https://github.com/antonioscardace/netwatch/blob/master/LICENSE) [![Open Issues](https://img.shields.io/github/issues/antonioscardace/netwatch.svg)](https://github.com/antonioscardace/netwatch/issues) +[![CI for Testing](https://github.com/antonioscardace/NetWatch/actions/workflows/ci-test.yml/badge.svg)](https://github.com/antonioscardace/NetWatch/actions/workflows/ci-test.yml) ## Introduction 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.
-If a utility changes its state (i.e. **goes offline** or **comes back online**), the monitor notifies the utility referent.
+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: Telegram @@ -47,7 +48,7 @@ Main Notes: - The HTTP connection between **Monitor** and **Data Manager** is a Keep-Alive (persistent) connection. - **Monitor** implements the Factory-Method Design Pattern for the _request_ module. - **Notification** implements the Factory-Method Design Pattern for the _sender_ module. -- Both **Identity Manager** and **Monitor** microservices use a Redis cache to store, respectively, active tokens and offline utilities. Storing data in a Redis cache rather than a local data structure (e.g. Hash Maps) offers several advantages like scalability, distribution, and persistence. +- Both **Identity Manager** and **Monitor** microservices use a Redis cache to store active tokens and offline utilities, respectively. Storing data in a Redis cache rather than a local data structure (e.g. Hash Maps) offers several advantages like scalability, distribution, and persistence. Here are some useful links for communication: