index.md 1.94 KB
Newer Older
Dmytro Bogatov's avatar
Dmytro Bogatov committed
1
2
3
4
5
# Status site

!!! quote
	Status site is the application for monitoring the health of the servers and web services.

Dmytro Bogatov's avatar
Dmytro Bogatov committed
6
[![build status](https://git.dbogatov.org/dbogatov/status-site/badges/master/build.svg)](https://git.dbogatov.org/dbogatov/status-site/commits/master)
Dmytro Bogatov's avatar
Dmytro Bogatov committed
7
[![system health](https://status.dbogatov.org/health)](https://status.dbogatov.org/)
Dmytro Bogatov's avatar
Dmytro Bogatov committed
8

Dmytro Bogatov's avatar
Dmytro Bogatov committed
9
10
11
12
13
14
15
16
17
18
19
20
21
## Features

* Agent reporting system stats
	- CPU load
	- RAM usage[^1]
	- SWAP usage[^1]
	- Disk space usage[^1]
	- Number (and names) of processes[^1]
* Collecting logs
	- Capturing message, source, category and auxillary data
	- Rich filtering tools
	- Guard against log DoS
* Web service monitor
Dmytro Bogatov's avatar
Dmytro Bogatov committed
22
23
	- Periodically access websites or ports
	- Record responses
Dmytro Bogatov's avatar
Dmytro Bogatov committed
24
25
26
27
28
* Notifications
	- Slack, email, telegram[^1], mattermost[^1] and other providers[^1]
	- Different severities - with different frequencies
* Discrepancies
	- Detect discrepancies in data points (gaps, high values, ping failures)
Dmytro Bogatov's avatar
Dmytro Bogatov committed
29
30
31
32
	- Detect the start and the end of discrepancy - not reported twice
* Badges
	- System health
	- Individual metrics
Dmytro Bogatov's avatar
Fix.    
Dmytro Bogatov committed
33
* Debian package tool to control the app
Dmytro Bogatov's avatar
Dmytro Bogatov committed
34
35
36
37
38
39
40
41
42
43
* Rich API
* Served as a docker composition - easy to install, configure and update
* Different databases for old and recent data
* Extensive documentation

[^1]: To be implemented

## How to deploy

!!! tip
Dmytro Bogatov's avatar
Fixes.    
Dmytro Bogatov committed
44
	Detailed instruction can be found [here](deployment/).
Dmytro Bogatov's avatar
Dmytro Bogatov committed
45
46
47
48

## How to develop

!!! tip
Dmytro Bogatov's avatar
Fixes.    
Dmytro Bogatov committed
49
	Detailed instruction can be found [here](development/).
Dmytro Bogatov's avatar
Dmytro Bogatov committed
50
51
52
53

## How to configure

!!! tip
Dmytro Bogatov's avatar
Fixes.    
Dmytro Bogatov committed
54
	Detailed instruction can be found [here](configuration/).
Dmytro Bogatov's avatar
Dmytro Bogatov committed
55

Dmytro Bogatov's avatar
Dmytro Bogatov committed
56
57
58
59
60
## How to use badges

!!! tip
	Detailed instruction can be found [here](badges/).

Dmytro Bogatov's avatar
Dmytro Bogatov committed
61
62
63
64
65
## A little story

This project has started as a side project for the [RedwoodEDA](http://www.redwoodeda.com) - a helper tool to monitor [makerchip](http://makerchip.com) servers.
It turned out to be much more sophisticated piece of software than was initially designed.
It was decided to open source the project to give community a chance to develop it further.