newrelic_pivpn_agent 0.0.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gemspec
+

data/README.md

@@ -0,0 +1,54 @@
+## New Relic piVPN (OpenVPN) monitoring Plugin
+
+The New Relic piVPN Plugin enables monitoring piVPN, and it reports the following data:
+
+* Amount of active Users
+* Amount of bytes sent
+* Amount of bytes received
+* Average of bytes sent
+* Average of bytes received
+
+### Requirements
+
+The piVPN monitoring Plugin for New Relic requires the following:
+
+* A New Relic account. Signup for a free account at http://newrelic.com
+* You need to install this plugin on a piVPN server. That host also needs Ruby (tested with 1.8.7, 1.9.3), and support for rubygems.
+
+### Instructions for running the piVPN agent
+
+1. Install this gem from RubyGems:
+
+    `sudo gem install newrelic_pivpn_agent`
+
+2. Install config, execute
+
+    `sudo newrelic_pivpn_agent install` - it will create `/etc/newrelic/newrelic_pivpn_agent.yml` file for you.
+
+3. Edit the `/etc/newrelic/newrelic_pivpn_agent.yml` file generated in step 2. 
+ 
+    3.1. replace `YOUR_LICENSE_KEY_HERE` with your New Relic license key. Your license key can be found under Account Settings at https://rpm.newrelic.com, see https://newrelic.com/docs/subscriptions/license-key for more help.
+
+    3.2. replace the agent name 'openvpn' to any unique instance name of choice
+
+    3.3. replace the path of the piVPN status binary if needed
+
+4. Execute
+
+    `newrelic_pivpn_agent run`
+  
+5. Go back to the Plugins list and after a brief period you will see the piVPN Plugin listed in your New Relic account
+
+
+## Keep this process running
+
+You can use services like these to manage this process and run it as a daemon.
+
+- [Upstart](http://upstart.ubuntu.com/)
+- [Systemd](http://www.freedesktop.org/wiki/Software/systemd/)
+- [Runit](http://smarden.org/runit/)
+- [Monit](http://mmonit.com/monit/)
+
+## Support
+
+Please use Github issues for support.

data/Rakefile

@@ -0,0 +1,153 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('CHANGES')
+  rdoc.main = "README.rdoc"
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{name} #{version}'"
+  #sh "git tag v#{version}"
+  sh "git push origin master"
+  #sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  #replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/newrelic_pivpn_agent

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+$stdout.sync = true
+
+$LOAD_PATH.unshift File.expand_path "../../lib", __FILE__
+require "newrelic_pivpn_agent"
+require 'optparse'
+
+NewRelic::Plugin::Config.config_file = "/etc/newrelic/newrelic_pivpn_agent.yml"
+
+options = OptionParser.new do |opts|
+  opts.banner = <<-EOF
+Usage:
+  newrelic_pivpn_agent ( run | install ) [options]
+EOF
+
+  opts.on("-v", "--verbose", "Run verbosely") do
+    NewRelic::Plugin::Config.config.newrelic['verbose'] = 1
+  end
+  
+  opts.on("-c", "--config FILE", "Override the location of the newrelic_plugin.yml") do | filename |
+    if !File.exists? filename
+      puts "File not found: #{filename.inspect}"
+      exit 1
+    end
+    NewRelic::Plugin::Config.config_file = filename
+  end
+
+  opts.on("-h", "--help") do
+    puts opts
+    if File.basename($0) == File.basename(__FILE__)
+      exit 0
+    end
+  end
+
+end
+
+args = options.parse!(ARGV)
+
+if args.first == "run"
+  if !File.exists? NewRelic::Plugin::Config.config_file
+    puts "Agent config file not found: #{NewRelic::Plugin::Config.config_file.inspect}"
+    puts "Run 'sudo newrelic_pivpn_agent install' for setup config"
+    exit 1
+  end
+  NewRelicOpenvpnAgent.run
+elsif args.first == "install"
+  config_file = File.read(File.expand_path("../../config/template_newrelic_plugin.yml", __FILE__))
+ 
+  require 'fileutils'
+  FileUtils.mkdir_p "/etc/newrelic"
+  File.open("/etc/newrelic/newrelic_pivpn_agent.yml", "w") do | io |
+    io.write(config_file)
+  end
+  puts "Saved agent config file #{File.expand_path("/etc/newrelic/newrelic_pivpn_agent.yml")}"
+else
+  puts options
+end

data/config/template_newrelic_plugin.yml

@@ -0,0 +1,20 @@
+# Please make sure to update the license_key information with the license key for your New Relic
+# account.
+#
+#
+newrelic:
+  #
+  # Update with your New Relic account license key:
+  #
+  license_key: ''
+  #
+  # Set to '1' for verbose output, remove for normal output.
+  # All output goes to stdout/stderr.
+  #
+  verbose: 1
+#
+# Agent Configuration:
+#
+agents:
+  piVPN-host:
+    openvpn_status_path : "/var/log/openvpn-status.log"

data/lib/newrelic_pivpn_agent.rb

@@ -0,0 +1,60 @@
+#! /usr/bin/env ruby
+
+#
+# This is a NewRelic agent which pushes OpenVPN information.
+#
+
+require "rubygems"
+require "bundler/setup"
+require "newrelic_plugin"
+
+module NewRelicOpenvpnAgent
+  class Agent < NewRelic::Plugin::Agent::Base
+    agent_guid "home.secretnet.secretlab.pivpn"
+    agent_version "0.0.2"
+    agent_config_options :openvpn_status_path
+    agent_human_labels("OpenVPN Agent") { ident }
+
+    attr_reader :ident
+
+    def poll_cycle
+      [:total_users, :total_bytes_received, :total_bytes_sent, :average_bytes_received, :average_bytes_sent].each do |_type|
+	name, unit, _output = metric(_type)
+        report_metric name, unit, _output.call
+      end
+    end
+
+    private
+
+    def get_columns(_output, _c_index, _uniq = true, _total = true)
+      result = _output.scan(/CLIENT_LIST[\s]+([0-9a-zA-Z]+)[\s]+((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}):\d+)[\s]+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})[\s]+([0-9]+)[\s]+([0-9]+)[\s]+([A-Za-z0-9]+[\s]+[a-zA-Z0-9]+[\s]+[0-9]+[\s]+[0-9:]+[\s]+[0-9]+)(\s)+([0-9]+)(\s)+([a-zA-Z]+)/).map{|_x| _x[_c_index] }
+      result = result.uniq if _uniq
+      result = result.length if _total
+      result
+    end
+
+    def metric(_type)
+      metrics = {
+	:total_users => ["Total/Users", "Users", lambda{get_columns(ovpn_cmd, 1) }],
+        :total_bytes_received => ["Total/Bytes/Received", "bytes", lambda{ get_columns(ovpn_cmd, 4, false, false).inject(0){|_t, _b| (_t + _b.to_i) } }],
+        :total_bytes_sent => ["Total/Bytes/Sent", "bytes", lambda{ get_columns(ovpn_cmd, 5, false, false).inject(0){|_t, _b| (_t + _b.to_i) } }],
+        :average_bytes_received => ["Average/Bytes/Received", "bytes", lambda{ x = get_columns(ovpn_cmd, 4, false, false); x.inject(0){|_t, _b| (_t + _b.to_i) } / x.length }],
+        :average_bytes_sent => ["Average/Bytes/Sent", "bytes", lambda{ x = get_columns(ovpn_cmd, 5, false, false); x.inject(0){|_t, _b| (_t + _b.to_i) } / x.length }]
+      }
+      metrics[_type]
+    end
+
+    def ovpn_cmd
+      `cat #{openvpn_status_path}`
+    end
+
+  end
+
+  def self.run
+    NewRelic::Plugin::Config.config.agents.keys.each do |_agent|
+      NewRelic::Plugin::Setup.install_agent _agent, NewRelicOpenvpnAgent
+    end
+
+    NewRelic::Plugin::Run.setup_and_run
+  end
+end

data/newrelic_pivpn_agent.gemspec

@@ -0,0 +1,81 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'newrelic_pivpn_agent'
+  s.version           = '0.0.2'
+  s.date              = '2017-11-13'
+  # s.rubyforge_project = 'newrelic_pivpn_agent'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "New Relic openvpn monitoring plugin"
+  s.description = <<-EOF
+This is the New Relic plugin for monitoring OpenVPN developed by KangaCoders Ltd.
+  EOF
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Kai De Sutter"]
+  s.email    = 'kdesutter@kangacoders.com'
+  s.homepage = 'http://www.kangacoders.com/'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## This sections is only necessary if you have C extensions.
+  #s.require_paths << 'ext'
+  #s.extensions = %w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["newrelic_pivpn_agent"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md]
+  
+  s.license = 'MIT'
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.  
+  s.add_dependency('bundler')
+  s.add_dependency('newrelic_plugin', "1.0.3")
+
+  s.post_install_message = <<-EOF
+  To get started with this plugin, do
+    newrelic_pivpn_agent -h
+  to find out how to install and run the plugin agent.
+    EOF
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    README.md
+    Rakefile
+    bin/newrelic_pivpn_agent
+    config/template_newrelic_plugin.yml
+    lib/newrelic_pivpn_agent.rb
+    newrelic_pivpn_agent.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_pivpn_agent
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Kai De Sutter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: newrelic_plugin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: ! 'This is the New Relic plugin for monitoring OpenVPN developed by KangaCoders
+  Ltd.
+
+'
+email: kdesutter@kangacoders.com
+executables:
+- newrelic_pivpn_agent
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/newrelic_pivpn_agent
+- config/template_newrelic_plugin.yml
+- lib/newrelic_pivpn_agent.rb
+- newrelic_pivpn_agent.gemspec
+homepage: http://www.kangacoders.com/
+licenses:
+- MIT
+post_install_message: ! "  To get started with this plugin, do\n    newrelic_pivpn_agent
+  -h\n  to find out how to install and run the plugin agent.\n"
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 2
+summary: New Relic openvpn monitoring plugin
+test_files: []