README

README
============

This plugin for munin parses OpenVPN status output. It graphs:

 * Count of connected users
 * Sent and received bytes for each user

This plugin is written in bash. It has no specific requirements. It auto-detects
OpenVPN status-version configuration option value.

Installation
============

Install the plugin with:

  command wget 'https://raw.github.com/biapy/munin-openvpn/master/openvpn_usercount' \
      --no-check-certificate --output-document='/usr/share/munin/plugins/openvpn_usercount'
  command chmod +x '/usr/share/munin/plugins/openvpn_usercount'
  command wget 'https://raw.github.com/biapy/munin-openvpn/master/openvpn_usertransfer' \
      --no-check-certificate --output-document='/usr/share/munin/plugins/openvpn_usertransfer'
  command chmod +x '/usr/share/munin/plugins/openvpn_usertransfer'

Enable it with:

  command ln -s '/usr/share/munin/plugins/openvpn_usertransfer' '/etc/munin/plugins/openvpn_usertransfer'
  command ln -s '/usr/share/munin/plugins/openvpn_usercount' '/etc/munin/plugins/openvpn_usercount'

You can graph multiple OpenVPN networks by appending the network name to plugin alias (here for 'network.vpn'):

  command ln -s '/usr/share/munin/plugins/openvpn_usertransfer' '/etc/munin/plugins/openvpn_usertransfer_network.vpn'
  command ln -s '/usr/share/munin/plugins/openvpn_usercount' '/etc/munin/plugins/openvpn_usercount_network.vpn'

Add these lines (adapted to your need) to munin-node configuration:

  [openvpn_usertransfer]
  user root
  env.statusfile /var/log/openvpn-status.log

  [openvpn_usercount]
  user root
  env.statusfile /var/log/openvpn-status.log

  [openvpn_usertransfer_network.vpn]
  user root
  env.statusfile /var/log/openvpn/network.vpn/openvpn-status.log

  [openvpn_usercount_network.vpn]
  user root
  env.statusfile /var/log/openvpn/network.vpn/openvpn-status.log

Credits
=======

This plugin was originaly created by Jeffrey Forman ( https://github.com/jforman )

Its current version has been written by Pierre-Yves Landure for Biapy:

  * http://www.biapy.fr/
  * http://howto.biapy.com/
  * https://github.com/biapy