diff options
Diffstat (limited to 'collectors/python.d.plugin/ovpn_status_log/README.md')
| -rw-r--r-- | collectors/python.d.plugin/ovpn_status_log/README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/collectors/python.d.plugin/ovpn_status_log/README.md b/collectors/python.d.plugin/ovpn_status_log/README.md new file mode 100644 index 0000000..8fa8cb8 --- /dev/null +++ b/collectors/python.d.plugin/ovpn_status_log/README.md @@ -0,0 +1,50 @@ +<!-- +title: "OpenVPN monitoring with Netdata" +custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/ovpn_status_log/README.md +sidebar_label: "OpenVPN" +--> + +# OpenVPN monitoring with Netdata + +Parses server log files and provides summary (client, traffic) metrics. + +## Requirements + +- If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files + so that multiple instances do not overwrite each other's output files. + +- Make sure NETDATA USER CAN READ openvpn-status.log + +- Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file. + +It produces: + +1. **Users** OpenVPN active users + + - users + +2. **Traffic** OpenVPN overall bandwidth usage in kilobit/s + + - in + - out + +## Configuration + +Edit the `python.d/ovpn_status_log.conf` configuration file using `edit-config` from the Netdata [config +directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`. + +```bash +cd /etc/netdata # Replace this path with your Netdata config directory, if different +sudo ./edit-config python.d/ovpn_status_log.conf +``` + +Sample: + +```yaml +default + log_path : '/var/log/openvpn-status.log' +``` + +--- + +[](<>) |