README.md 2.01 KB
Newer Older
Dmytro Bogatov's avatar
Dmytro Bogatov committed
1
# Status site
Dmytro Bogatov's avatar
Dmytro Bogatov committed
2

Dmytro Bogatov's avatar
Dmytro Bogatov committed
3
> Status site is the application for monitoring the health of the servers and web services.
Dmytro Bogatov's avatar
Dmytro Bogatov committed
4

Dmytro Bogatov's avatar
Dmytro Bogatov committed
5
[![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
Hotfix.    
Dmytro Bogatov committed
6
[![system health](https://status.dbogatov.org/health)](https://status.dbogatov.org/)
Dmytro Bogatov's avatar
Dmytro Bogatov committed
7

Dmytro Bogatov's avatar
Dmytro Bogatov committed
8
## Features
Dmytro Bogatov's avatar
Dmytro Bogatov committed
9

Dmytro Bogatov's avatar
Dmytro Bogatov committed
10
11
12
13
14
15
16
17
18
19
20
* Agent reporting system stats
	- CPU load
	- RAM usage*
	- SWAP usage*
	- Disk space usage*
	- Number (and names) of processes*
* 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
21
22
	- Periodically access websites or ports
	- Record responses
Dmytro Bogatov's avatar
Dmytro Bogatov committed
23
24
25
26
27
* Notifications
	- Slack, email, telegram*, mattermost* and other providers*
	- Different severities - with different frequencies
* Discrepancies
	- Detect discrepancies in data points (gaps, high values, ping failures)
Dmytro Bogatov's avatar
Dmytro Bogatov committed
28
	- Detect the start and end of discrepancy - not reported twice
Dmytro Bogatov's avatar
Hotfix.    
Dmytro Bogatov committed
29
30
31
* Badges
	- System health
	- Individual metrics
Dmytro Bogatov's avatar
Fix.    
Dmytro Bogatov committed
32
* Debian package tool to control the app
Dmytro Bogatov's avatar
Dmytro Bogatov committed
33
34
35
36
* Rich API
* Served as a docker composition - easy to install, configure and update
* Different databases for old and recent data
* Extensive documentation
Dmytro Bogatov's avatar
Dmytro Bogatov committed
37

Dmytro Bogatov's avatar
Dmytro Bogatov committed
38
\* to be implemented
Dmytro Bogatov's avatar
Dmytro Bogatov committed
39

Dmytro Bogatov's avatar
Dmytro Bogatov committed
40
## How to deploy
Dmytro Bogatov's avatar
Dmytro Bogatov committed
41

Dmytro Bogatov's avatar
Dmytro Bogatov committed
42
> Detailed instruction can be found [here](https://status.dbogatov.org/docs/deployment/).
Dmytro Bogatov's avatar
Dmytro Bogatov committed
43

Dmytro Bogatov's avatar
Dmytro Bogatov committed
44
## How to develop
Dmytro Bogatov's avatar
Dmytro Bogatov committed
45

Dmytro Bogatov's avatar
Dmytro Bogatov committed
46
> Detailed instruction can be found [here](https://status.dbogatov.org/docs/development/).
Dmytro Bogatov's avatar
Dmytro Bogatov committed
47

Dmytro Bogatov's avatar
Dmytro Bogatov committed
48
49
50
51
## How to configure

> Detailed instruction can be found [here](https://status.dbogatov.org/docs/configuration/).

Dmytro Bogatov's avatar
Hotfix.    
Dmytro Bogatov committed
52
53
54
55
## How to use badges

> Detailed instruction can be found [here](https://status.dbogatov.org/docs/badges/).

Dmytro Bogatov's avatar
Dmytro Bogatov committed
56
57
58
59
60
## 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.