Integrate also nagios-based monitoring here

1 files changed, 34 insertions, 0 deletions

diff --git a/lib/remote/README.txt b/lib/remote/README.txt
new file mode 100644
index 0000000..c5998f8
--- /dev/null
+++ b/lib/remote/README.txt
@@ -0,0 +1,34 @@
+conky format
+============
+ - Server status
+    *                   ping works
+    *                   no output from 'check_server_status.sh' and additional listed checks 
+    [*]                 Checks for additional listed services 'check_<service>_status.sh'. 
+                        - The optional status is in the beginning of first line (0 - red, 1 - green, 2 - yellow). Otherwise, 'red' if any output (also if first word is non-number on the first string).
+                        - If first line starts from the status, the rest of the line is considered a header and reported on the status line. Everything else goes to textual section bellow.
+    [headers]             
+                        
+    ...                 Textual information reported by 'check_server_status.sh' and check_*_status.sh scripts. The format
+                        server:port[:service] text....
+    
+ - Extra info for DarkSoft servers
+   *                    VPN to the server is working (checked with the ping). This not included in the scripted version, instead server traffic reported directly here.
+        # #             Traffic on VPN interface from/to
+
+ - 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