README
¶
OpenVPN monitoring with Netdata
OpenVPN is an open-source commercial software that implements virtual private network techniques to create secure point-to-point or site-to-site connections in routed or bridged configurations and remote access facilities.
This module will monitor one or more OpenVPN instances via Management Interface.
Requirements
OpenVPNwith enabledmanagement-interface.
Charts
It produces the following charts:
- Total Number Of Active Clients in
clients - Total Traffic in
kilobits/s
Per user charts (disabled by default, see per_user_stats in the module config file):
- User Traffic in
kilobits/s - User Connection Time in
seconds
Configuration
This collector is disabled by default. Should be explicitly enabled in go.d.conf.
Reason:
Currently,the OpenVPN daemon can at most support a single management client any one time.
We disabled it to not break other tools which uses Management Interface.
Edit the go.d/openvpn.conf configuration file using edit-config from the your agent's config
directory, which is typically at /etc/netdata.
cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/openvpn.conf
Needs only address of OpenVPN Management Interface. Here is an example for 2 OpenVPN instances:
jobs:
- name: local
address : /dev/openvpn
- name: remote
address : 203.0.113.10:7505
For all available options please see module configuration file.
Troubleshooting
Check the module debug output. Run the following command as netdata user:
./go.d.plugin -d -m openvpn
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Address string
ConnectTimeout web.Duration `yaml:"connect_timeout"`
ReadTimeout web.Duration `yaml:"read_timeout"`
WriteTimeout web.Duration `yaml:"write_timeout"`
PerUserStats matcher.SimpleExpr `yaml:"per_user_stats"`
}
Config is the OpenVPN module configuration.
Source Files
Directories