resymo-agent 0.1.0

A remote system monitoring tool for a small set of servers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# ReSyMo – Remote System Monitoring

[![crates.io](https://img.shields.io/crates/v/resymo-agent.svg)](https://crates.io/crates/resymo-agent)
[![docs.rs](https://docs.rs/resymo-agent/badge.svg)](https://docs.rs/resymo-agent)
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/tag/ctron/resymo?sort=semver)](https://github.com/ctron/resymo/releases)
[![CI](https://github.com/ctron/resymo/actions/workflows/ci.yaml/badge.svg)](https://github.com/ctron/resymo/actions/workflows/ci.yaml)

An itch to a scratch of having a few servers, but no dashboard to monitor their status.

![Screenshot of an Example](docs/screenshot-1.png)

## Getting started

* Install Home Assistant on one machine
* Set up an MQTT broker (see [Architecture](#current-architecture) below)
* Deploy the ReSyMo agent on machines you want to monitor

## Goals and non-goals

The goal is to have a small tool, allowing to get an overview of a handful of servers. Re-using components where
possible, and implementing things when necessary. The overall setup should be straightforward and follow existing
patterns.

## Current architecture

The idea is to use [Home Assistant](https://www.home-assistant.io/) as a central hub for bringing data together and
visualizing it. To connect servers (which may or may not run in public networks) with Home Assistant (which most likely
is not running on a public network), and MQTT broker is being used to bridge connectivity. Home Assistant also has an
HTTP API for publishing data to it. However, that would mean opening up external access to Home Assistant for servers
which are running on a public network. Home Assistant also has an MQTT integration including auto-discovery of devices.

```mermaid
graph TD
;
    subgraph Network A
        B[MQTT Broker]
    end
    subgraph Network B
        A[Server]
    end
    subgraph Network C
        C[Home Assistant]
    end
    A --> B;
    C --> B;
```

## FAQ

### Why Home Assistant

While Home Assistant might not be a network monitoring tool, it is a great smart home tool. And for a smaller set of
servers, it fits quite well. Including visualization, automation, timeseries data, mobile phone app, notifications, …

### Why not XYZ?

I've been looking around for quite a while. Yes, there are some solutions. Most of them are just way too complex for
monitoring some basic information of a handful of machines. Some of them are quite invasive.

If you find something better, please let me know.