add ovpn_status_log to python README
Ilya committed
Jan 6, 2017 at 17:16 UTC
bcb755ab45e749c5ec1d5c1f2a24b47ec5a95b6e
1 file changed
+33
python.d/README.md
+33
@@ -588,6 +588,39 @@ When no configuration file is found, module tries to parse `/var/log/nginx/acces
588
589
---
590
591
+# ovpn_status_log
592
+
593
+Module monitor openvpn-status log file.
594
+
595
+**Requirements:**
596
+
597
+1. If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
598
+ so that multiple instances do not overwrite each other's output files.
599
+
600
+2. Make sure NETDATA USER CAN READ openvpn-status.log
601
+
602
+3. Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.
603
+
604
+It produces:
605
+
606
+**Users** OpenVPN active users
607
+ * users
608
+
609
+ **Traffic** OpenVPN overall bandwidth usage in kilobit/s
610
+ * in
611
+ * out
612
+
613
+### configuration
614
+
615
+Sample:
616
+
617
+```yaml
618
+default
619
+ log_path : '/var/log/openvpn-status.log'
620
+```
621
+
622
+---
623
+
624
# phpfpm
625
626
This module will monitor one or more php-fpm instances depending on configuration.