summaryrefslogtreecommitdiffstats
path: root/remote/lib
diff options
context:
space:
mode:
authorSuren A. Chilingaryan <csa@suren.me>2019-08-25 07:09:30 +0200
committerSuren A. Chilingaryan <csa@suren.me>2019-08-25 07:09:30 +0200
commit78f3f37d3d8b213887fa6d47e32c5f9f05c0e299 (patch)
tree49c241b3741740769529f811a440f1a073b5a795 /remote/lib
parentaa29ce5a243320559f8f83d9434bc55f20ae9aec (diff)
downloadconky-78f3f37d3d8b213887fa6d47e32c5f9f05c0e299.tar.gz
conky-78f3f37d3d8b213887fa6d47e32c5f9f05c0e299.tar.bz2
conky-78f3f37d3d8b213887fa6d47e32c5f9f05c0e299.tar.xz
conky-78f3f37d3d8b213887fa6d47e32c5f9f05c0e299.zip
Documentation update
Diffstat (limited to 'remote/lib')
-rw-r--r--remote/lib/README.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/remote/lib/README.txt b/remote/lib/README.txt
index f023131..c5998f8 100644
--- a/remote/lib/README.txt
+++ b/remote/lib/README.txt
@@ -17,5 +17,18 @@ conky format
- Server traffic
in/out/forw. Yellow/Red if above specified threshold. No additional errors are reported here.
-
+
+ - Services (operated by local scripts in 'services' directory)
+ * Online
+ * Healthy
+ [headers] Information about service operation
+ [errors] Short information on critical errors are reported here (in conky, we push everything in the text section)
+
+ ... Larger textual information about the problems.
+
+
+ Service format is following (status is on the last line and mandatory):
+ * Critical Lines starting with '*' contain critical errors and highlighted (remote) / reported in the service table (conky)
+ Text This is normal problem description reported in the textual area
+ # # [header] Two statuses (0 - error, 1 - ok, 2 - warning) and optional header with information about service operation
\ No newline at end of file