sensu-checks-php-fpm 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01eb287a1d8b7e3b20090ca44459426c31399851
+  data.tar.gz: c2fb910700c4dc37dae20a2b3f839efbd64ff5d5
+SHA512:
+  metadata.gz: e799966d5b7bf79e53fb185013d4bd1eb9bc28a2efe63b9ec40f6ec83939bd510c83848c1fc7e1e63f80c4a05ef7c635d026acb888d1a66e6c711a43b43698a7
+  data.tar.gz: 395a703bdb80213407c94c13560a380772507bcf5d2db9f80aecf9deac81cf153781755a079be726c7902a9bb59044083ca3136836e2f6337f17b9c3684e37c5

data/LICENSE

@@ -0,0 +1,16 @@
+A modified MIT License (MIT)
+
+Copyright (c) 2016 Dirk Gustke
+
+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.
+
+Neither the Software, nor any derivative product, shall be used to operate weapons
+
+Neither the Software, nor any derivative product, shall be used for any military use
+
+Neither the Software, nor any derivative product, shall be used for any use by intelligence agencies
+
+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,134 @@
+# sensu-checks-php-fpm
+
+Check your php-fpm setup over sockets or on their direct ip/port combination.
+So you avoid checking nginx, apache, XYZ along with the check.
+
+## DEPENDENCIES
+
+Testing the sockets directly depends on `libfcgi0ldbl`
+
+
+## INSTALLATION
+
+This gem will give an actual installation explanation, as the default sensu plugins miss it and the sensu documentation lacks any detailed explanation.
+
+If this gem is listed in rubygems.org, you can just go ahead and do
+```
+sensu-install -p sensu-check-php-fpm
+```
+
+If this gem is not listed there, you can still install it; the hard way.
+```
+git clone git@github.com:vmpublishing/sensu-checks-php-fpm [SOME_PATH]
+cd [SOME_PATH]
+/opt/sensu/embedded/bin/gem build *.gemspec
+/opt/sensu/embedded/bin/gem install *.gem
+```
+
+Alter `/opt/sensu/embedded/bin/gem` to the path to the gem-file sensu uses on your machine.
+
+
+## USAGE
+
+### ping check
+
+#### Parameters
+
+| name | parameter_name | default value | required | description |
+|------|----------------|---------------|----------|-------------|
+| hostname | -h, --host |  | yes, unless socket is set | This sets the "Host: " HTTP header for the request |
+| port | -P, --port | 80 | no | The port of php-fpm to connect to |
+| address | -a, --address | localhost | no | The address of php-fpm to connect to. Hostname or IP |
+| query_string | -q, --query-string | no | Optional query string to send along with the path (ie. 'pool=some_pool&sticky_flag=foo' ) |
+| ping_path | -p, --ping-path | /ping | no | The configured path, where the ping resides. Check your pool config. |
+| response | -r, --response | pong | no | The configured response to the ping request |
+| request_timeout | -t, --request-timeout | 60 | no | HTTP request timeout. When the sensu timeout is greater than this and this timeout is reached, it will produce a critical error |
+| socket | -s, --socket | nil | no | Check ping over the socket, instead over http. This renders 'hostname', 'port', 'address' and 'request_timeout' useless |
+
+#### sample json config file for sockets
+```
+{
+  "checks": {
+    "check_php_fpm_ping": {
+      "command":      "check-php-fpm-ping.rb -s /var/run/php-fpm.sock -p /ping",
+      "standalone":   true,
+      "subscribers":  ["all"],
+      "interval":     10,
+      "timeout":      120,
+      "ttl":          180
+    }
+  }
+}
+```
+
+#### sample json config file for http
+```
+{
+  "checks": {
+    "check_php_fpm_ping": {
+      "command":      "check-php-fpm-ping.rb -a 127.0.0.1 -P 5678 -h www.example.com -p /ping -t 60",
+      "standalone":   true,
+      "subscribers":  ["all"],
+      "interval":     10,
+      "timeout":      120,
+      "ttl":          180
+    }
+  }
+}
+```
+
+### metrics
+
+#### Parameters
+
+| name | parameter_name | default value | required | description |
+|------|----------------|---------------|----------|-------------|
+| hostname | -h, --host |  | yes, unless socket is set | This sets the "Host: " HTTP header for the request |
+| port | -P, --port | 80 | no | The port of php-fpm to connect to |
+| address | -a, --address | localhost | no | The address of php-fpm to connect to. Hostname or IP |
+| query_string | -q, --query-string | no | Optional query string to send along with the path (ie. 'pool=some_pool&sticky_flag=foo') |
+| status_path | -p, --ping-path | /status | no | The configured path, where the status resides. Check your pool config. |
+| request_timeout | -t, --request-timeout | 60 | no | HTTP request timeout. When the sensu timeout is greater than this and this timeout is reached, it will produce a critical error |
+| socket | -s, --socket | nil | no | Check ping over the socket, instead over http. This renders 'hostname', 'port', 'address' and 'request_timeout' useless |
+| scheme | -C, --scheme | [hostname].php-fpm | no | Metric naming scheme, text to prepend to metric and scheme_append |
+| scheme_append | -S, --scheme_append | nil | no | Set a string that will be placed right after the host identification and the script identification but before the measurements (ie. hostname.php-fpm.scheme_append.slow_requests) |
+
+#### sample json config file for sockets
+```
+{
+  "metrics": {
+    "metric_php_fpm_status": {
+      "type":         "metric",
+      "command":      "metric-php-fpm-status.rb -s /var/run/php-fpm.sock -p /status",
+      "standalone":   true,
+      "subscribers":  ["all"],
+      "interval":     10,
+      "timeout":      120,
+      "ttl":          180
+    }
+  }
+}
+```
+
+#### sample json config file for http
+```
+{
+  "metrics": {
+    "metric_php_fpm_status": {
+      "type":         "metric",
+      "command":      "metric-php-fpm-status.rb -a 127.0.0.1 -P 5678 -h www.example.com -p /ping -t 60",
+      "standalone":   true,
+      "subscribers":  ["all"],
+      "interval":     10,
+      "timeout":      120,
+      "ttl":          180
+    }
+  }
+}
+```
+
+
+## CONTRIBUTING
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vmpublishing/sensu-checks-php-fpm.
+

data/bin/check-php-fpm-ping.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+
+require 'sensu-plugin/check/cli'
+require 'net/http'
+
+
+class CheckPhpFpmPing < Sensu::Plugin::Check::CLI
+
+  option :hostname,
+         short:            '-h HOSTNAME',
+         long:             '--host HOSTNAME',
+         description:      'This sets the "Host: " parameter of the HTTP-Request, not the address (ie. www.example.com). When not using sockets, this is required!',
+         default:          ''
+
+  option :port,
+         short:            '-P PORT',
+         long:             '--port PORT',
+         description:      'The php-fpm port to check',
+         default:          '80'
+
+  option :address,
+         short:            '-a ADDRESS',
+         long:             '--address ADDRESS',
+         description:      "The php-fpm address to check. examples: '127.0.0.1' or 'localhost'",
+         default:          'localhost'
+
+  option :query_string,
+         short:            '-q ARGUMENTS',
+         long:             '--query-string ARGUMENTS',
+         description:      "optional query string to send (ie: 'pool=some_pool&stick_flag=13')",
+         default:          ''
+
+  option :ping_path,
+         short:            '-p PATH',
+         long:             '--ping-path PATH',
+         description:      'The configured path for the ping test in your php-fpm.ini / pool*.ini',
+         default:          '/ping'
+
+  option :response,
+         short:            '-r RESPONSE',
+         long:             '--response RESPONSE',
+         description:      'The expected response on the ping request',
+         default:          'pong'
+
+  option :socket,
+         short:            '-s SOCKET',
+         long:             '--soclet SOCKET',
+         description:      'Request ping over socket. This renders :hostname, :port, :address and :request_timeout useless',
+         default:          nil
+
+  option :request_timeout,
+         short:            '-t TIMEOUT',
+         long:             '--request-timeout TIMEOUT',
+         description:      'Set the connect timeout to X',
+         default:          '60'
+
+  def run
+
+    if config[:socket] # do something completely different on this flag
+      response = `SCRIPT_NAME=#{config[:ping_path]} SCRIPT_FILENAME=#{config[:ping_path]} QUERY_STRING=#{config[:query_string]} REQUEST_METHOD=GET cgi-fcgi -bind -connect #{config[:socket]}`
+      response_body = response.split("\r\n\r\n")[1]
+      if config[:response] == response_body
+        ok "PHP-FPM said '#{response_body}'"
+      else
+        critical "PHP-FPM said '#{response.body}' instead of '#{config[:response]}'"
+      end
+    else # ok, do the http stuff
+      uri = URI("http://#{config[:hostname]}#{config[:ping_path]}?#{config[:query_string]}") # actually hostname does not matter at this point, as it is overwritten
+
+      response = Net::HTTP.start(config[:address], config[:port], read_timeout: config[:request_timeout].to_i) do |http|
+        request = Net::HTTP::Get.new(uri)
+        request['Host'] = config[:hostname] # it matters here
+
+        http.request(request)
+      end
+
+      if '200' == response.code
+        if config[:response] == response.body
+          ok "PHP-FPM said '#{response.body}'"
+        else
+          critical "PHP-FPM said '#{response.body}' instead of '#{config[:response]}'"
+        end
+      else
+        critical "Expected 200, #{response.code} found"
+      end # response.code
+
+    end # http section
+
+  rescue Net::ReadTimeout => e
+    critical "PHP-FPM request timeout: '#{e.message}'"
+  end # def run
+
+end # class
+

data/bin/metric-php-fpm-status.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+
+require 'sensu-plugin/metric/cli'
+require 'net/http'
+
+
+class MetricPhpFpmStatus < Sensu::Plugin::Metric::CLI::Graphite
+
+  option :hostname,
+         short:            '-h HOSTNAME',
+         long:             '--host HOSTNAME',
+         description:      'This sets the "Host: " parameter of the HTTP-Request, not the address (ie. www.example.com). When not using sockets, this is required!',
+         default:          ''
+
+  option :port,
+         short:            '-P PORT',
+         long:             '--port PORT',
+         description:      'The php-fpm port to check',
+         default:          '80'
+
+  option :address,
+         short:            '-a ADDRESS',
+         long:             '--address ADDRESS',
+         description:      "The php-fpm address to check. examples: '127.0.0.1' or 'localhost'",
+         default:          'localhost'
+
+  option :query_string,
+         short:            '-q ARGUMENTS',
+         long:             '--query-string ARGUMENTS',
+         description:      "optional query string to send (ie: 'pool=some_pool&stick_flag=13')",
+         default:          ''
+
+  option :status_path,
+         short:            '-p PATH',
+         long:             '--ping-path PATH',
+         description:      'The configured path for the ping test in your php-fpm.ini / pool*.ini',
+         default:          '/status'
+
+  option :socket,
+         short:            '-s SOCKET',
+         long:             '--soclet SOCKET',
+         description:      'Request ping over socket. This renders :hostname, :port, :address and :request_timeout useless',
+         default:          nil
+
+  option :request_timeout,
+         short:            '-t TIMEOUT',
+         long:             '--request-timeout TIMEOUT',
+         description:      'Set the connect timeout to X',
+         default:          '60'
+
+  option :scheme,
+         short:            '-C SCHEME',
+         long:             '--scheme SCHEME',
+         description:      'Metric naming scheme, text to prepend to metric and scheme_append',
+         default:          "#{Socket.gethostname}.php-fpm"
+
+  option :scheme_append,
+         short:            '-S APPEND_STRING',
+         long:             '--scheme-append APPEND_STRING',
+         description:      'Set a string that will be placed right after the host identification and the script identification but before the measurements',
+         default:          nil
+
+
+  def run
+
+    body = if config[:socket] # do something completely different on this flag
+
+      response = `SCRIPT_NAME=#{config[:status_path]} SCRIPT_FILENAME=#{config[:status_path]} QUERY_STRING=#{config[:query_string]} REQUEST_METHOD=GET cgi-fcgi -bind -connect #{config[:socket]}`
+      response.split("\r\n\r\n")[1]
+
+    else # ok, do the http stuff
+
+      uri = URI("http://#{config[:hostname]}#{config[:status_path]}?#{config[:query_string]}") # actually hostname does not matter at this point, as it is overwritten
+
+      response = Net::HTTP.start(config[:address], config[:port], read_timeout: config[:request_timeout].to_i) do |http|
+        request = Net::HTTP::Get.new(uri)
+        request['Host'] = config[:hostname] # it matters here
+
+        http.request(request)
+      end
+      response.body
+
+    end # end http section
+
+    accepted_fields = %w(
+      start_since
+      accepted_conn
+      listen_queue
+      max_listen_queue
+      listen_queue_len
+      idle_processes
+      active_processes
+      total_processes
+      max_active_processes
+      max_children_reached
+      slow_requests
+    )
+    body.gsub("\r", '').split("\n").each do |status_line|
+      field_name, field_value = status_line.split(':').map(&:strip).map{|value| value.gsub(' ', '_')}
+      next unless accepted_fields.include?(field_name)
+
+      if config[:scheme_append]
+        output "#{config[:scheme]}.#{config[:scheme_append]}.#{field_name}", field_value
+      else
+        output "#{config[:scheme]}.#{field_name}", field_value
+      end
+    end
+
+    ok
+  rescue Net::ReadTimeout => e # it's the job of the check to determine errors, so do nothing
+  end # def run
+
+end # class
+

data/lib/sensu-checks-php-fpm.rb

@@ -0,0 +1,2 @@
+require 'sensu-checks-php-fpm/version.rb'
+

data/lib/sensu-checks-php-fpm/version.rb

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

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: sensu-checks-php-fpm
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- vmpublishing development
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: sensu gem to check php-fpm directly, without nginx or apache, using socket
+  [or possibly ip]. Also support for multiple pools. Also support for http (if you
+  really want to)
+email:
+- dev@vmpublishing.com
+executables:
+- metric-php-fpm-status.rb
+- check-php-fpm-ping.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/check-php-fpm-ping.rb
+- bin/metric-php-fpm-status.rb
+- lib/sensu-checks-php-fpm.rb
+- lib/sensu-checks-php-fpm/version.rb
+homepage: https://github.com/vmpublishing/sensu-checks-php-fpm
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: sensu gem to check php-fpm directly, without nginx or apache, using socket
+  [or possibly ip]
+test_files: []