@cryptotaxi247 / netdata-1 / commits / 158db325b

openvpn plugin configuration file added

lgz committed Dec 21, 2016 at 22:07 UTC 158db325bba95a9e64d4c04735cce3bd28789c6e
1 file changed +86
conf.d/python.d/ovpn_status_log.conf new
+86
@@ -0,0 +1,86 @@
1 +# netdata python.d.plugin configuration for openvpn status log
2 +#
3 +# This file is in YaML format. Generally the format is:
4 +#
5 +# name: value
6 +#
7 +# There are 2 sections:
8 +# - global variables
9 +# - one or more JOBS
10 +#
11 +# JOBS allow you to collect values from multiple sources.
12 +# Each source will have its own set of charts.
13 +#
14 +# JOB parameters have to be indented (using spaces only, example below).
15 +
16 +# ----------------------------------------------------------------------
17 +# Global Variables
18 +# These variables set the defaults for all JOBs, however each JOB
19 +# may define its own, overriding the defaults.
20 +
21 +# update_every sets the default data collection frequency.
22 +# If unset, the python.d.plugin default is used.
23 +# update_every: 1
24 +
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.
28 +# priority: 60000
29 +
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.
34 +# retries: 5
35 +
36 +# ----------------------------------------------------------------------
37 +# JOBS (data collection sources)
38 +#
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.
43 +#
44 +# Any number of jobs is supported.
45 +#
46 +# All python.d.plugin JOBS (for all its modules) support a set of
47 +# predefined parameters. These are:
48 +#
49 +# job_name:
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
56 +#
57 +# Additionally to the above, openvpn status log also supports the following:
58 +#
59 +# log_path: 'PATH' # the path to openvpn status log file
60 +#
61 +# ----------------------------------------------------------------------
62 +# AUTO-DETECTION JOBS
63 +# only one of them will run (they have the same name)
64 +#
65 +# IMPORTANT information
66 +#
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
70 +#
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
76 +#
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
79 +#
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
83 +#
84 +#
85 +#default:
86 +# log_path: '/var/log/openvpn-status.log'