sensu-plugins-openvpn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a23d6e4454d06f618b7b3387c342f693d57f68e
+  data.tar.gz: 6fa6851a71bd3a183290653faa15dec8b0198c81
+SHA512:
+  metadata.gz: 145abb06e6721b8d099bf3e7157c60aa1833a7cc60da692466940796b5df0c4bf52c7c2c47fd1b9c1d84056ff573e26d267675f6752c150cf37519b92d58be47
+  data.tar.gz: 2b651a944b03ad13d7f217236c97cf2bf81f76618ed92424f827e3005b8a04c9826b6b746df411db3d1029eb87ae27b97777ab52377ac6c51475a1df5525ea09

checksums.yaml.gz.sig

@@ -0,0 +1,2 @@
+���#����ϊ�}�@O�ỉX)���ZY�l��k�Q���Y����j��
\�b��)r��IHw5���)��kC���Æ����j0���,��,�j1���}���r8��Z��X�*@��Ukǃ�
+qf�
�FXZYz���fw�� �r�W��,پsr"�S��5����]Pne�/	�՗��1��ߦ_/P�N\_�TA>�0��������o�Q���?8߮F��~�إt�}�O��pѩ�򲶭nZ��K��

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased][unreleased]
+
+## [0.0.1] - 2015-07-04
+
+### Added
+- initial release
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+## Sensu-Plugins-openvpn
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-openvpn.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-openvpn)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-openvpn.svg)](http://badge.fury.io/rb/sensu-plugins-openvpn)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openvpn/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openvpn)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openvpn/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openvpn)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-openvpn.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-openvpn)
+[ ![Codeship Status for sensu-plugins/sensu-plugins-openvpn](https://codeship.com/projects/d85b26c0-e94a-0132-bf5e-5a3dd864e215/status?branch=master)](https://codeship.com/projects/82933)
+
+## Functionality
+
+## Files
+ * bin/metrics-openvpn.rb
+
+## Usage
+
+```
+{
+  "openvpn-metrics": {
+    "host": "1.2.3.4",
+    "port": "12345",
+    "service": "main"
+  }
+}
+```
+
+## Installation
+
+[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+
+## Notes

data/bin/metrics-openvpn.rb

@@ -0,0 +1,150 @@
+#! /usr/bin/env ruby
+#
+#   openvpn-metrics
+#
+# DESCRIPTION:
+#   Requires the admin interface to be enabled on the OpenVPN server.
+#   Opens a telnet connection to the admin interface, collects data,
+#   and sends it back to Sensu.
+#
+#   Some command-line options (either the builtin defaults
+#   or the options sent by sensu-server) can be overriden locally
+#   by a .json config file, like this:
+#
+#   $ cat /etc/sensu/conf.d/openvpn-metrics.json
+#   {
+#     "openvpn-metrics": {
+#       "host": "1.2.3.4",
+#       "port": "12345",
+#       "service": "users"
+#     }
+#   }
+#
+#   This is to allow different VPN servers to bind the admin interface to
+#   different host:port combos, while still sending the same command to
+#   all sensu-client instances.
+#
+#   In other words, for --host and --port the order of importance, starting
+#   with the most important, is:
+#
+#   1. Values defined locally in sensu/conf.d/*.json
+#   2. Command line options passed via --host and --port
+#   3. Built-in defaults (displayed with --help)
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2014 Sonian, Inc. and contributors. <support@sensuapp.org>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'sensu-plugin/utils'
+require 'net/telnet'
+
+class OpenvpnGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  include Sensu::Plugin::Utils
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.openvpn"
+
+  option :host,
+         description: 'Host to connect to',
+         short: '-h HOST',
+         long: '--host HOST',
+         default: 'localhost'
+
+  option :port,
+         description: 'Port to connect to',
+         short: '-p PORT',
+         long: '--port PORT',
+         default: 1195
+
+  option :timeout,
+         description: 'Connection timeout',
+         short: '-t TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 10
+
+  option :prompt,
+         description: 'Initial prompt for OpenVPN admin interface',
+         short: '-r PROMPT',
+         long: '--prompt PROMPT',
+         default: ">INFO:OpenVPN Management Interface Version 1 -- type 'help' for more info\n"
+
+  option :service,
+         description: 'If more than one openvpn service is running here, name this one to identify it',
+         short: '-e SERVICE',
+         long: '--service SERVICE',
+         default: 'main'
+
+  def run
+    # Are these options overriden locally in .json?
+    if defined? settings['openvpn-metrics']['host']
+      def_host = settings['openvpn-metrics']['host']
+    else
+      def_host = config[:host]
+    end
+
+    if defined? settings['openvpn-metrics']['port']
+      def_port = settings['openvpn-metrics']['port']
+    else
+      def_port = config[:port]
+    end
+
+    if defined? settings['openvpn-metrics']['service']
+      def_service = settings['openvpn-metrics']['service']
+    else
+      def_service = config[:service]
+    end
+
+    # collect data
+    # telnet into admin interface
+    vpn = Net::Telnet.new('Host' => def_host,
+                          'Port' => def_port,
+                          'Timeout' => config[:timeout],
+                          'Telnetmode' => false,
+                          'Prompt' => config[:prompt])
+
+    # issue stats command
+    status = vpn.cmd('String' => 'load-stats',
+                     'Match' => /^SUCCESS: nclients=[0-9]+,bytesin=[0-9]+,bytesout=[0-9]+/).lines[1].chomp
+
+    vpn.close
+
+    # Example output from actual telnet session:
+    #
+    # >INFO:OpenVPN Management Interface Version 1 -- type 'help' for more info
+    # load-stats
+    # SUCCESS: nclients=1,bytesin=371632,bytesout=176455
+
+    # grok output
+    stat_fields = status.split(',')
+    nclients = stat_fields[0].split('=')[1]
+    bytesin = stat_fields[1].split('=')[1]
+    bytesout = stat_fields[2].split('=')[1]
+
+    # send metrics to Sensu
+    output "#{config[:scheme]}.#{def_service}.nclients", nclients
+    output "#{config[:scheme]}.#{def_service}.bytesin", bytesin
+    output "#{config[:scheme]}.#{def_service}.bytesout", bytesout
+
+    ok
+  end
+end

data/lib/sensu-plugins-openvpn.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-openvpn/version'

data/lib/sensu-plugins-openvpn/version.rb

@@ -0,0 +1,10 @@
+module SensuPluginsOpenvpn
+  # This defines the version of the gem
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-openvpn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRIwEAYDVQQDDAltYXR0
+  am9uZXMxGDAWBgoJkiaJk/IsZAEZFgh5aWVsZGJvdDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNTAxMjgyMTAyNTFaFw0xNjAxMjgyMTAyNTFaMEMxEjAQBgNVBAMM
+  CW1hdHRqb25lczEYMBYGCgmSJomT8ixkARkWCHlpZWxkYm90MRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyTSzVYnO
+  CLgyrIyT1mBQakArQyW8xhi6MlDqyzXHJGeERT790U6EgoBVeS4XoK0ptFZNR8Tf
+  zko0w+Nv47TarSCgkPOaxY+mxWnAVR10dOmfeLr7huiMyps+YD56/EF2FqQ3jf/+
+  qohENfKD91qy1ieEy+Fn7Pf74ltbNKUdkb9a9eFXQ0DQ4ip5vik7DzjQkUTj4lca
+  k6ArwnmHX4YDhZoYtrQJ8jVktN0/+NtA40M5qkCYHNe5tUW25b/tKVYuioxG6b2Z
+  oIzaZxRLxf6HVAWpCVRT/F5+/yjigkX4u++eYacfLGleXQzoK7BL65vHGMJygWEE
+  0TKGqFOrl/L0AQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUEf6a8Td7MrSZc8ImbLFZAENPbz0wIQYDVR0RBBowGIEWbWF0dGpvbmVz
+  QHlpZWxkYm90LmNvbTAhBgNVHRIEGjAYgRZtYXR0am9uZXNAeWllbGRib3QuY29t
+  MA0GCSqGSIb3DQEBBQUAA4IBAQBbzXAYA3BVGw8DZ0YYoY1VHPNEcH5qPIApmHO8
+  rvSmuUT0yMEi7u00H/5uHRFf4LleGT/+sTdyXKsNPGT9kdRuQEgwi+vf7Zfvd8aX
+  UF/+4VkEYf/8rV8Ere6u2QaWPgApdMV6JjKr1fAwCTd8AuGXNaWItiPPMseSQzLJ
+  JKP4hVvbc1d+oS925B1lcBiqn2aYvElbyNAVmQPywNNqkWmvtlqj9ZVJfV5HQLdu
+  8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
+  HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
+  -----END CERTIFICATE-----
+date: 2015-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Sensu openvpn plugins
+email: "<sensu-users@googlegroups.com>"
+executables:
+- metrics-openvpn.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/metrics-openvpn.rb
+- lib/sensu-plugins-openvpn.rb
+- lib/sensu-plugins-openvpn/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-openvpn
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for openvpn
+test_files: []