sensu-plugins-nginx 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05d1419977c60acb91e63b663fcc053cf8e76649
-  data.tar.gz: 2b0476465460a7a844d5db59192f88af53590328
+  metadata.gz: 476205e6bed938636daf2e723fdca5d0547eadd5
+  data.tar.gz: 24104bf3d8f97424618621b661c752f22dee69a0
 SHA512:
-  metadata.gz: c35f35a6c7a717e6a41feab1ebfd51aea9e8700a9f22cfdc6ec66584a57420771462475a21af709838aa304f6a6251a479ab86b802e31cbd2f84d7c368bdcd74
-  data.tar.gz: 66050a2c8581f4806e9e539bd6057117d72d32d328e9a001fca7ed2faddc7e1dc138c9456b100d0e400d12637093aaf2d0178c2adf11d15f0edfe992a3b5ab02
+  metadata.gz: 95133fd68e7d3834c3c0e84cc18a78fea12f496a2720e0081c26e4d0ed4563f1f3f09ae476e57017a28b23f900e3ad4ea26a9b5b24491b697d56c2ac0108e722
+  data.tar.gz: 338d1d7f21e436e95fd277223e710c2451dc66551c15bda7ad412ff2b0ca576a35b29ac9a1740a1f4fa5c7142f98788adf6327993de03dbfb7351ac0cf37ca4d

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 
 ## [Unreleased]
 
+## [2.1.0] - 2017-02-28
+### Added
+- add `check-nginx-status` plugin (@hany)
+
 ## [2.0.0] - 2016-05-24
 ### Changed
 - remove support for rubies < 2.0
@@ -56,7 +60,8 @@ This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachang
 ## 0.0.1 - 2015-02-11 **YANKED**
 - initial stable release
 
-[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/2.0.0...HEAD
+[Unreleased]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/2.1.0...HEAD
+[2.1.0]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/1.0.0...2.0.0
 [1.0.0]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/0.0.6...1.0.0
 [0.0.6]: https://github.com/sensu-plugins/sensu-plugins-nginx/compare/0.0.5...0.0.6

data/README.md

@@ -10,11 +10,15 @@
 
 **metrics-nginx**
 
-Fetch the nginx status page and convert the response into graphite metrics
+Fetch the nginx status page and convert the response into metrics
+
+**check-nginx-status**
+
+Check nginx statistics
 
 ## Files
  * bin/metrics-nginx.rb
-Get the nginx metrics from the status page url for use with Graphite
+ * bin/check-nginx-status.rb
 
 ## Usage
 

data/bin/check-nginx-status.rb

@@ -0,0 +1,139 @@
+#! /usr/bin/env ruby
+#
+#   check-nginx-status
+#
+# DESCRIPTION:
+# Sensu Check that fetches Nginx Status
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+# You need to enable nginx status
+# https://easyengine.io/tutorials/nginx/status-page/
+# check-nginx-status.rb --help
+#
+# NOTES:
+#
+# LICENSE:
+# Adapted from official metrics-nginx plugin (Pete Shima <me@peteshima.com>)
+# Magic Online http://www.magic.fr  @2016 - hanynowsky@gmail.com
+# Released under the same terms as Sensu (the MIT license); see LICENSE  for details.
+# Last Modified October 2016
+#
+
+require 'net/https'
+require 'uri'
+require 'socket'
+require 'sensu-plugin/check/cli'
+
+#
+# Nginx Status Check
+#
+class CheckNginxStatus < Sensu::Plugin::Check::CLI
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'Full URL to nginx status page, example: https://yoursite.com/nginx_status This ignores ALL other options'
+
+  option :hostname,
+         short: '-h HOSTNAME',
+         long: '--host HOSTNAME', description: 'Nginx hostname', default: 'localhost'
+
+  option :port,
+         short: '-p PORT',
+         long: '--port PORT',
+         description: 'Nginx  port',
+         default: '80'
+
+  option :activecon,
+         short: '-a ACTIVE_CONNECTION_THRESHOLD',
+         long: '--activecon ACTIVE_CONNECTION_THRESHOLD',
+         description: 'Active connections threshold',
+         default: 300
+
+  option :waitingreq,
+         short: '-w WAITING_REQUESTS_THRESHOLD',
+         long: '--waitingreq WAITING_REQUESTS_THRESHOLD',
+         description: 'Waiting requests threshold',
+         default: 30
+
+  option :path,
+         short: '-q STATUSPATH',
+         long: '--statspath STATUSPATH',
+         description: 'Path to your stub status module',
+         default: 'nginx_status'
+
+  option :hostheader,
+         long: '--hostheader HOSTHEADER',
+         description: 'Set the Host header to this string'
+
+  #
+  # Acquire Nginx Status
+  #
+  def statutor
+    found = false
+    attempts = 0
+    begin
+      until found || attempts >= 10
+        attempts += 1
+        if config[:url]
+          uri = URI.parse(config[:url])
+          http = Net::HTTP.new(uri.host, uri.port)
+          if uri.scheme == 'https'
+            http.use_ssl = true
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
+          request = Net::HTTP::Get.new(uri.request_uri)
+          if config[:hostheader]
+            request['Host'] = config[:hostheader]
+          end
+          response = http.request(request)
+          if response.code == '200'
+            found = true
+          elsif !response.header['location'].nil?
+            config[:url] = response.header['location']
+          end
+        else
+          response = Net::HTTP.start(config[:hostname], config[:port]) do |connection|
+            request = Net::HTTP::Get.new("/#{config[:path]}")
+            connection.request(request)
+          end
+        end
+        return response
+      end
+    rescue => e
+      unknown "Could not fetch Nginx status | #{e.message}"
+    end
+  end
+
+  #
+  # Main function
+  #
+  def run
+    code = statutor
+    #### Metrics
+    code.body.split(/\r?\n/).each do |line|
+      if line =~ /^Active connections:\s+(\d+)/
+        connections = line.match(/^Active connections:\s+(\d+)/).to_a
+        if connections[1].to_i > config[:activecon].to_i
+          warning "Active connections: #{connections[1]}"
+        end
+      end
+      if line =~ /^Reading:\s+(\d+).*Writing:\s+(\d+).*Waiting:\s+(\d+)/
+        queue = line.match(/^Reading:\s+(\d+).*Writing:\s+(\d+).*Waiting:\s+(\d+)/).to_a
+        warning "Waiting requests: #{queue[3]}" if queue[3].to_i > config[:waitingreq].to_i
+      end
+    end
+    #####
+    ok 'Nginx is Alive and healthy' if code.code.to_i == 200
+    warning 'Nginx Status endpoint is mis-configured' if code.code.to_i == 301
+    critical 'Nginx is Down'
+  end
+end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-nginx
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sensu-Plugins and contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-24 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -155,6 +155,7 @@ description: |-
                                 for metrics collection, including: metrics via `stub_status`.
 email: "<sensu-users@googlegroups.com>"
 executables:
+- check-nginx-status.rb
 - metrics-nginx.rb
 extensions: []
 extra_rdoc_files: []
@@ -162,6 +163,7 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- bin/check-nginx-status.rb
 - bin/metrics-nginx.rb
 - lib/sensu-plugins-nginx.rb
 - lib/sensu-plugins-nginx/version.rb
@@ -191,9 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sensu plugins for the NGINX server
 test_files: []
-has_rdoc: