1 # netdata python.d.plugin configuration for openvpn status log
3 # This file is in YaML format. Generally the format is:
7 # There are 2 sections:
11 # JOBS allow you to collect values from multiple sources.
12 # Each source will have its own set of charts.
14 # JOB parameters have to be indented (using spaces only, example below).
16 # ----------------------------------------------------------------------
18 # These variables set the defaults for all JOBs, however each JOB
19 # may define its own, overriding the defaults.
21 # update_every sets the default data collection frequency.
22 # If unset, the python.d.plugin default is used.
25 # priority controls the order of charts at the netdata dashboard.
26 # Lower numbers move the charts towards the top of the page.
27 # If unset, the default for python.d.plugin is used.
30 # retries sets the number of retries to be made in case of failures.
31 # If unset, the default for python.d.plugin is used.
32 # Attempts to restore the service are made once every update_every
33 # and only if the module has collected values in the past.
36 # ----------------------------------------------------------------------
37 # JOBS (data collection sources)
39 # The default JOBS share the same *name*. JOBS with the same name
40 # are mutually exclusive. Only one of them will be allowed running at
41 # any time. This allows autodetection to try several alternatives and
42 # pick the one that works.
44 # Any number of jobs is supported.
46 # All python.d.plugin JOBS (for all its modules) support a set of
47 # predefined parameters. These are:
50 # name: myname # the JOB's name as it will appear at the
51 # # dashboard (by default is the job_name)
52 # # JOBs sharing a name are mutually exclusive
53 # update_every: 1 # the JOB's data collection frequency
54 # priority: 60000 # the JOB's order on the dashboard
55 # retries: 5 # the JOB's number of restoration attempts
57 # Additionally to the above, openvpn status log also supports the following:
59 # log_path: 'PATH' # the path to openvpn status log file
61 # ----------------------------------------------------------------------
63 # only one of them will run (they have the same name)
65 # IMPORTANT information
67 # 1. If you are running multiple OpenVPN instances out of the same directory, MAKE SURE TO EDIT DIRECTIVES which create output files
68 # so that multiple instances do not overwrite each other's output files.
69 # 2. Make sure NETDATA USER CAN READ openvpn-status.log
71 # * cd into directory with openvpn-status.log and run the following commands as root
72 # * #chown :netdata openvpn-status.log && chmod 640 openvpn-status.log
73 # * To check permission and group membership run
74 # * #ls -l openvpn-status.log
75 # -rw-r----- 1 root netdata 359 dec 21 21:22 openvpn-status.log
77 # 3. Update_every interval MUST MATCH interval on which OpenVPN writes operational status to log file.
78 # If its not true traffic chart WILL DISPLAY WRONG values
80 # Default OpenVPN update interval is 10 second on Debian 8
81 # # ps -C openvpn -o command=
82 # /usr/sbin/openvpn --daemon ovpn-server --status /run/openvpn/server.status 10 --cd /etc/openvpn --config /etc/openvpn/server.conf
86 # log_path: '/var/log/openvpn-status.log'