sensu-plugins-http-boutetnico 1.0.0

data/bin/metrics-http-json.rb

@@ -0,0 +1,137 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: false
+
+#   metrics-http-json.rb
+#
+# DESCRIPTION:
+#   Hits an HTTP endpoint which emits JSON and pushes data into Graphite.
+#
+# OUTPUT:
+#   Graphite formatted data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: rest-client
+#
+# USAGE:
+#   EX: ./metrics-http-json.rb -u 'http://127.0.0.1:8080/jolokia/read/com\
+#   .mchange.v2.c3p0:name=datasource,type=PooledDataSource' -s hostname.c3p0\
+#    -m 'Connections::numConnections,BusyConnections::numBusyConnections'\
+#    -o 'value'
+#
+# NOTES:
+#   The metric option is a comma separated list of the metric (how it will
+#   appear in Graphite) and the JSON key which holds the value you want to
+#   graph. The object option is optional and is the name of the JSON object
+#   which holds the key/value pairs you want to graph.
+#
+# LICENSE:
+#   phamby@gmail.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'rest-client'
+require 'socket'
+require 'json'
+require 'uri'
+#
+# HttpJsonGraphite - see description above
+#
+class HttpJsonGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :url,
+         description: 'Full URL to the endpoint',
+         short: '-u URL',
+         long: '--url URL',
+         default: 'http://localhost:8080'
+
+  option :scheme,
+         description: 'Metric naming scheme',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: Socket.gethostname.to_s
+
+  option :metric,
+         description: 'Metric/JSON key pair ex:Connections::numConnections',
+         short: '-m METRIC::JSONKEY',
+         long: '--metric METRIC::JSONKEY'
+
+  option :headers,
+         description: 'Additional HTTP request headers to send. Example: Authorization:XYZ,User-Agent:ABC',
+         short: '-H HEADER1:val,HEADER2:val',
+         long: '--headers HEADER1:val,HEADER2:val'
+
+  option :object,
+         description: 'The JSON object containing the data',
+         short: '-o OBJECT',
+         long: '--object OBJECT'
+
+  option :insecure,
+         description: 'By default, every SSL connection made is verified to be secure. This option allows you to disable the verification',
+         short: '-k',
+         long: '--insecure',
+         boolean: true,
+         default: false
+
+  option :debug,
+         short: '-d',
+         long: '--debug',
+         default: false
+
+  def run
+    puts "args config: #{config}" if config[:debug]
+
+    scheme = config[:scheme].to_s
+    metric_pair_input = config[:metric].to_s
+    if config[:object]
+      object = config[:object].to_s
+    end
+
+    header_dict = {}
+    if config[:headers]
+      config[:headers].split(',').each do |header|
+        h, v = header.split(':', 2)
+        header_dict[h] = v.strip
+      end
+    end
+
+    # TODO: figure out what to do here
+    url = URI.encode(config[:url].to_s) # rubocop:disable Lint/UriEscapeUnescape
+    begin
+      r = RestClient::Request.execute(
+        url: url,
+        method: :get,
+        verify_ssl: !config[:insecure],
+        headers: header_dict
+      )
+
+      puts "Http response: #{r}" if config[:debug]
+      metric_pair_array = metric_pair_input.split(/,/)
+      metric_pair_array.each do |m|
+        metric, attribute = m.to_s.split(/::/)
+        puts "metric: #{metric}, attribute: #{attribute}" if config[:debug]
+        unless object.nil?
+          ::JSON.parse(r)[object].each do |k, v|
+            if k == attribute
+              output([scheme, metric].join('.'), v)
+            end
+          end
+        end
+        ::JSON.parse(r).each do |k, v|
+          if k == attribute
+            output([scheme, metric].join('.'), v)
+          end
+        end
+      end
+    rescue Errno::ECONNREFUSED
+      critical "#{config[:url]} is not responding"
+    rescue RestClient::RequestTimeout
+      critical "#{config[:url]} Connection timed out"
+    end
+    ok
+  end
+end

data/bin/metrics-libcurl.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
+#
+#   metrics-libcurl
+#
+# DESCRIPTION:
+#   Simple wrapper around libcurl for getting timing stats from the various phases
+#   of connecting to an HTTP/HTTPS server.
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: typhoeus
+#
+# USAGE:
+#   #YELLOW
+#
+# NOTES:
+#   Based on: metrics-curl.rb
+#   by Joe Miller.
+#
+# LICENSE:
+#   Copyright 2019 Jef Spaleta
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'socket'
+require 'English'
+require 'sensu-plugin/metric/cli'
+require 'typhoeus'
+require 'json'
+
+#
+# Libcurl Metrics
+#
+class LibcurlMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'valid cUrl url to connect (default: http://127.0.0.1:80/)',
+         default: 'http://127.0.0.1:80/'
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.curl_timings"
+  option :debug,
+         description: 'Include debug output, should not use in production.',
+         short: '-d',
+         long: '--debug',
+         default: false
+  option :libcurl_options,
+         description: 'Libcurl Options as a key/value JSON string',
+         short: '-o JSON',
+         long: '--options  JSON',
+         default: '{}'
+  option :http_headers,
+         description: 'HTTP Request Headers as key/value JSON string',
+         short: '-H JSON',
+         long: '--headers  JSON',
+         default: '{}'
+  option :http_params,
+         description: 'HTTP Request Parameters as key/value JSON string',
+         short: '-P JSON',
+         long: '--params  JSON',
+         default: '{}'
+  option :http_response_error,
+         description: 'return critical status (2) if http response error status encountered (>= 400)',
+         short: '-c',
+         long: '--critical_http_error',
+         default: false
+  option :http_redirect_warning,
+         description: 'return warning status (1) if http response redirect status encountered (3xx)',
+         short: '-w',
+         long: '--warn_redirect',
+         default: false
+  option :help,
+         short: '-h',
+         long: '--help',
+         description: 'Show this message',
+         on: :tail,
+         boolean: true,
+         show_options: true
+
+  def usage_details
+    <<~USAGE
+      Detailed Info:
+        This wrapper makes use of libcurl directly instead of the curl executable by way of the Typhoeus RubyGem.
+        You can provide additional libcurl options via the commandline using the --options argument.
+
+      Options Examples:
+        Follow Redirects: --options '{\"followlocation\": true}'
+        Use Proxy: --options '{proxy: \"http://proxyurl.com\", proxyuserpwd: \"user:password\"}'
+        Disable TLS Verification: '{\"ssl_verifypeer\": false}'
+
+      References:
+        Typhoeus Docs: https://www.rubydoc.info/gems/typhoeus/1.3.1
+        Libcurl Options: https://curl.haxx.se/libcurl/c/curl_easy_setopt.html
+    USAGE
+  end
+
+  def run
+    if config[:help]
+      puts usage_details
+      ok
+    end
+
+    puts "[DEBUG] args config: #{config}" if config[:debug]
+    begin
+      headers = ::JSON.parse(config[:http_headers])
+    rescue ::JSON::ParserError
+      critical "Error parsing http_headers JSON\n"
+    end
+    begin
+      params = ::JSON.parse(config[:http_params])
+    rescue ::JSON::ParserError
+      critical "Error parsing http_params JSON\n"
+    end
+    begin
+      hash = ::JSON.parse(config[:libcurl_options])
+    rescue ::JSON::ParserError
+      critical "Error parsing libcurl_options JSON\n"
+    end
+
+    begin
+      opts = Hash[hash.map { |k, v| [k.to_sym, v] }]
+      opts[:headers] = headers unless headers.empty?
+      opts[:params] = params unless params.empty?
+      request = Typhoeus::Request.new(config[:url], opts)
+      if config[:debug]
+        puts "[DEBUG] Request Options: #{request.options}"
+        puts "[DEBUG] Request Base Url: #{request.base_url}"
+        puts "[DEBUG] Request Full Url: #{request.url}"
+      end
+      response = request.run
+      Typhoeus.get(config[:url], followlocation: true)
+      if config[:debug]
+        puts "[DEBUG] Response HTTP Code: #{response.response_code}"
+        puts "[DEBUG] Response Return Code: #{response.return_code}"
+      end
+    rescue TyphoeusError
+      critical "Something went wrong\n Request Options: #{request.options}\n Request Base Url: #{request.base_url}\n Request Full Url: #{request.url}"
+    end
+    output "#{config[:scheme]}.time_total", response.total_time
+    output "#{config[:scheme]}.time_namelookup", response.namelookup_time
+    output "#{config[:scheme]}.time_connect", response.connect_time
+    output "#{config[:scheme]}.time_pretransfer", response.pretransfer_time
+    output "#{config[:scheme]}.time_redirect", response.redirect_time
+    output "#{config[:scheme]}.time_starttransfer", response.starttransfer_time
+    output "#{config[:scheme]}.http_code", response.response_code
+    if response.response_code == 0
+      critical
+    end
+
+    critical if config[:http_response_error] && response.response_code >= 400
+    warning if config[:http_redirect_warning] && response.response_code.between?(300, 399)
+    ok
+  end
+end

data/lib/sensu-plugins-http.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'sensu-plugins-http/version'
+require 'sensu-plugins-http/common'
+require 'sensu-plugins-http/aws-v4'

data/lib/sensu-plugins-http/aws-v4.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SensuPluginsHttp
+  module AwsV4
+    # Returns a modified request object with AWS v4 signature headers
+    # and authentication options (if any)
+    #
+    # @param [Net::HTTP] http
+    #   The http object used to execute the request.  Used to build uri
+    # @param [Net::HTTPGenericRequest] req
+    #   The http request.  Used to populate headers, path, method, and body
+    # @param [Hash] options Details about how to configure the request
+    # @option options [String] :aws_v4_service
+    #   AWS service to use in signature.  Defaults to 'execute-api'
+    # @option options [String] :aws_v4_region
+    #   AWS region to use in signature.  Defaults to
+    #   ENV['AWS_REGION'] or ENV['AWS_DEFAULT_REGION']
+    def apply_v4_signature(http, req, options = {})
+      require 'aws-sdk'
+
+      fake_seahorse = Struct.new(:endpoint, :body, :headers, :http_method)
+      headers = {}
+      req.each_name { |name| headers[name] = req[name] }
+      protocol = http.use_ssl? ? 'https' : 'http'
+      uri = URI.parse("#{protocol}://#{http.address}:#{http.port}#{req.path}")
+      fake_req = fake_seahorse.new(uri, req.body || '',
+                                   headers, req.method)
+
+      credentials = Aws::CredentialProviderChain.new.resolve
+      service = options[:aws_v4_service] || 'execute-api'
+      region = options[:aws_v4_region] || ENV['AWS_REGION'] || ENV['AWS_DEFAULT_REGION']
+      signer = Aws::Signers::V4.new(credentials, service, region)
+
+      signed_req = signer.sign(fake_req)
+      signed_req.headers.each { |key, value| req[key] = value }
+
+      req
+    end
+  end
+end

data/lib/sensu-plugins-http/common.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Common
+  def initialize
+    super()
+    aws_config
+  end
+
+  def aws_config
+    if config[:aws_access_key_id] && config[:aws_secret_access_key]
+      Aws.config.update(
+        credentials: Aws::Credentials.new(config[:aws_access_key_id], config[:aws_secret_access_key])
+      )
+    end
+
+    Aws.config.update(
+      region: config[:aws_region]
+    )
+  end
+
+  def merge_s3_config
+    return if config[:s3_config_bucket].nil? || config[:s3_config_key].nil?
+
+    aws_config
+
+    s3 = Aws::S3::Client.new
+    begin
+      resp = s3.get_object(bucket: config[:s3_config_bucket], key: config[:s3_config_key])
+      s3_config = JSON.parse(resp.body.read, symbolize_names: true)
+      config.merge!(s3_config)
+    rescue StandardError
+      critical 'Error getting config file from s3'
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SensuPluginsHttp
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,290 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-http-boutetnico
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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.85.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.85.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.25
+description: |-
+  This plugin provides native HTTP instrumentation
+                                for monitoring and metrics collection, including:
+                                response code, JSON response, HTTP last modified,
+                                SSL expiry, and metrics via `curl`.
+email: "<sensu-users@googlegroups.com>"
+executables:
+- metrics-curl.rb
+- metrics-http-json.rb
+- check-https-cert.rb
+- check-head-redirect.rb
+- check-http-json.rb
+- check-http-cors.rb
+- check-last-modified.rb
+- metrics-libcurl.rb
+- check-http.rb
+- metrics-http-json-deep.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-head-redirect.rb
+- bin/check-http-cors.rb
+- bin/check-http-json.rb
+- bin/check-http.rb
+- bin/check-https-cert.rb
+- bin/check-last-modified.rb
+- bin/metrics-curl.rb
+- bin/metrics-http-json-deep.rb
+- bin/metrics-http-json.rb
+- bin/metrics-libcurl.rb
+- lib/sensu-plugins-http.rb
+- lib/sensu-plugins-http/aws-v4.rb
+- lib/sensu-plugins-http/common.rb
+- lib/sensu-plugins-http/version.rb
+homepage: https://github.com/boutetnico/sensu-plugins-http
+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: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for various http monitors and metrics
+test_files: []