sensu-plugins-tomcat 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 30c3379221831241e30f59f1f3bae3a9628f72af
-  data.tar.gz: 5c8044b42b0928eeef060da305c5bca12b5da71b
+SHA256:
+  metadata.gz: 4c477350a971edfc09651df6c5f8afc7a3044a0ed92899c83a961901d43388d6
+  data.tar.gz: 7fb8697f83894e93747e5cadf5ca7f4e11ff24eb13f4b112c1c0454ad0e96f4b
 SHA512:
-  metadata.gz: 8526341ec362f072f18908fec4f7d1d2a5e5ce9487e616ff651b73053871a8e76fb5892c02b2d43daf1d7eb301947a2e7bfed463b92d1fe7b447a094df981ee6
-  data.tar.gz: c5e1c3593a210dbf7bf7ddc582ffb51e5ef7e3fad7491abb5c02e0bd38c6966e08d6a3c648ec64363d7be8fa78558b699407de128d433e589c72361980ab814a
+  metadata.gz: 5648422e52b2e4e90bf0884b933f42d7c850556824d7140dc8a09fd3c5ecf872055e14c574bfd33651bdeb459aa5a6f997e785bf83ad068b54a16445460b3822
+  data.tar.gz: fb8e7c320467b8f2f6b394012e37bb90279ed8d4692018e511bddeebf9c8cc2daa18d509db5b933f866f842a30cb46fe0d5d7ec4c5e24688b778b567ff1e4a92

data/CHANGELOG.md

@@ -1,7 +1,17 @@
-#Change Log
+# Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+This CHANGELOG follows the format listed [here](https://github.com/sensu-plugins/community/blob/master/HOW_WE_CHANGELOG.md)
+
 ## Unreleased
+
+## [0.2.0] - 2017-12-22
+### Added
+- metrics-tomcat-jmxproxy.rb: Support querying metrics from the jmxproxy servlet (@luyseyal)
+
+### Changed
+- updated changelog gudelines and PR templates (@majormoses)
+
 ## [0.1.1] 2017-06
 ### Fixed
 - Corrected long option value for passwords - from "passowrd" to "password"
@@ -17,5 +27,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-tomcat/compare/0.1.1...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-tomcat/compare/0.2.0...HEAD
+[0.2.0]: https://github.com/sensu-plugins/sensu-plugins-tomcat/compare/0.1.1...0.2.0
 [0.1.1]: https://github.com/sensu-plugins/sensu-plugins-tomcat/compare/0.1.0...0.1.1

data/README.md

@@ -16,9 +16,14 @@ Check current runtime status/deploymnet status of a application:
 
 Check the percentage of JVM Memory
 
+**metrics-tomcat-jmxproxy**
+
+Return value of JMX attribute to Graphite via Tomcat's JMXProxy
+
 ## Files
  * check-tomcat-app-deployment.rb
  * check-tomcat-heap-pcnt.rb
+ * metrics-tomcat-jmxproxy.rb
 
 ## Usage
 

data/bin/metrics-tomcat-jmxproxy.rb

@@ -0,0 +1,138 @@
+#! /usr/bin/env ruby
+#
+#   metrics-tomcat-jmxproxy
+#
+# DESCRIPTION:
+#   Return value of JMX attribute to Graphite via Tomcat's JMXProxy
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: addressable
+#   gem: sensu-plugin
+#   gem: unirest
+#
+# USAGE:
+#  Basic Usage:
+#    ./metrics-tomcat-jmxproxy.rb
+#      --url http://localhost:8080
+#      --account admin
+#      --password password
+#      --bean 'java.lang:type=MemoryPool,name=Compressed Class Space'
+#      --attribute PeakUsage
+#      --key used
+#      --scheme my.scheme
+#
+#    my.scheme.PeakUsage.used 2523848 1513887865
+#
+# NOTES:
+#
+# See http://localhost:8080/docs/manager-howto.html for security information
+
+require 'addressable/uri'
+require 'sensu-plugin/metric/cli'
+require 'unirest'
+
+class MetricsTomcatJMXProxy < Sensu::Plugin::Metric::CLI::Graphite
+  option :url,
+         description: 'URL of the Tomcat Manager',
+         short: '-u URL',
+         long: '--url URL',
+         required: true
+
+  option :account,
+         description: 'Username of the Tomcat User that has the manager-jmx role',
+         short: '-a USERNAME',
+         long: '--account USERNAME',
+         required: true
+
+  option :password,
+         description: 'Tomcat User password',
+         short: '-p PASSWORD',
+         long: '--password PASSWORD',
+         required: true
+
+  option :bean,
+         description: 'Full name of the MBean to query',
+         short: '-b VALUE',
+         long: '--bean VALUE',
+         required: true
+
+  option :attribute,
+         description: 'MBean attribute to return. Default metric name',
+         short: '-l VALUE',
+         long: '--attribute VALUE',
+         required: true
+
+  option :attrkey,
+         description: 'Key of a CompositeData MBean attribute. Optional',
+         short: '-k VALUE',
+         long: '--key VALUE',
+         required: false
+
+  option :scheme,
+         description: 'Metric naming scheme. Defaults to hostname',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: Socket.gethostname.to_s
+
+  option :metric,
+         description: 'Override attribute name metric',
+         short: '-M METRIC',
+         long: '--metric METRIC',
+         required: false
+
+  option :timeout,
+         description: 'HTTP request timeout in seconds. Default: 5',
+         short: '-T TIMEOUT',
+         long: '--timeout TIMEOUT',
+         default: 5,
+         required: false
+
+  def run
+    uri = Addressable::URI.parse("#{config[:url]}/manager/jmxproxy?get=#{config[:bean]}&att=#{config[:attribute]}")
+    fq_metric = config[:scheme] + '.' + (config[:metric] || config[:attribute])
+
+    if config[:attrkey]
+      uri.query += "&key=#{config[:attrkey]}"
+      fq_metric += '.' + config[:attrkey].to_s
+    end
+
+    uri.normalize!
+    fq_metric.downcase!
+
+    # Fetch attribute from Tomcat
+    Unirest.timeout(config[:timeout])
+    response = Unirest.get uri.to_s, auth: { user: @config[:account].to_s, password: @config[:password].to_s }
+
+    if response.code != 200
+      critical "Failed to obtain response from Tomcat\n"\
+      "HTTP Response Code: #{response.code}\n"\
+      "URL: #{uri}\n"
+    else
+      # Supported formats:
+      # OK - Attribute get 'java.lang:type=Memory' - Verbose = false
+      # OK - Attribute get 'java.lang:type=Memory' - HeapMemoryUsage - key 'used' = 1234
+      # Error - Error message here\nstacktrace\nstacktrace\n...
+      #
+      # FIXME support CompositeData
+      # OK - Attribute get 'java.lang:type=Memory' - HeapMemoryUsage = javax.management.openmbean.CompositeDataSupport(...)
+
+      fields = response.raw_body.split(' - ')
+
+      if fields[0] != 'OK'
+        trunc_error = fields[1].split("\n")
+        critical "#{fields[0]} #{trunc_error[0].chomp}"
+      end
+
+      output(fq_metric, fields[-1].split(' = ', 2)[1].chomp)
+      ok
+    end
+  rescue Errno::ECONNREFUSED
+    critical "Could not connect to Tomcat on #{config[:url]}"
+  end
+end

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

@@ -1,8 +1,8 @@
 module SensuPluginsTomcat
   module Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-tomcat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: unirest
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.3.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 2.3.8
 - !ruby/object:Gem::Dependency
   name: crack
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: unirest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
+        version: 1.1.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.1.2
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +197,7 @@ email: "<sensu-users@googlegroups.com>"
 executables:
 - check-tomcat-app-deployment.rb
 - check-tomcat-heap-pcnt.rb
+- metrics-tomcat-jmxproxy.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -191,6 +206,7 @@ files:
 - README.md
 - bin/check-tomcat-app-deployment.rb
 - bin/check-tomcat-heap-pcnt.rb
+- bin/metrics-tomcat-jmxproxy.rb
 - lib/sensu-plugins-tomcat.rb
 - lib/sensu-plugins-tomcat/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-tomcat
@@ -219,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for tomcat