README
¶
openvpn
This module will monitor one or more OpenVPN instances via Management Interface.
Requirements:
- OpenVPN with enabled
management-interface
It produces the following charts:
- Total Number Of Active Clients in clients
- clients
- Total Traffic in kilobits/s
- in
- out
Per user charts (disabled by default, see per_user_stats in the module config file):
- User Traffic in kilobits/s
- received
- sent
- User Connection Time in seconds
- time
configuration
openvpn 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.
So to not break other tools that uses Management Interface we decided to disable it by default.
For all available options please see module configuration file.
Needs only address of OpenVPN Management Interface.
Here is an example for 2 OpenVPN instances:
jobs:
- name: local
address : /dev/openvpn
- name: remote
address : 100.64.0.1:7505
Without configuration, module attempts to connect to 127.0.0.1:7505
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