summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2023-04-22 14:38:30 +0300
committerPaul Buetow <paul@buetow.org>2023-04-22 14:38:30 +0300
commit2bc4107f9c7def31ceafd89d8b6a44c02c796871 (patch)
tree519cfb29083f4b04c0796d8072ad8601f0815f0b
parent63386d3381b0fdf42bd350402424ac8389e30832 (diff)
example
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 01af458..7059b4f 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,28 @@ Gogios is a minimalistic and easy-to-use monitoring tool written in Go, compatib
Gogios is a lightweight and minimalistic monitoring tool that is not designed for large-scale monitoring. It is ideal for monitoring self-hosted servers in a very small scale, such as only a handful of servers and/or virtual machines. If you have a limited number of resources to monitor and require a simple yet effective solution, Gogios is a great choice. However, for larger environments with more complex monitoring requirements, it might be necessary to consider other monitoring solutions that are better suited for managing and scaling with increased monitoring demands.
+## Example alert
+
+This is an example alert report received via E-Mail:
+
+```
+Subject: GOGIOS Report [C:2 W:0 U:0 OK:51]
+
+This is the recent Gogios report!
+
+# Alerts with status changed:
+
+OK->CRITICAL: Check ICMP4 vulcan.buetow.org ==>> Check command timed out
+OK->CRITICAL: Check ICMP6 vulcan.buetow.org ==>> Check command timed out
+
+# Unhandled alerts:
+
+CRITICAL: Check ICMP4 vulcan.buetow.org ==>> Check command timed out
+CRITICAL: Check ICMP6 vulcan.buetow.org ==>> Check command timed out
+
+Have a nice day!
+```
+
## Installation
### Compiling and installing Gogios