ruby_script_exporter 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c519baa82ed0393d7b038669bf035a4bc05018a0ecb8da173ead0ad9d2b58d70
-  data.tar.gz: '0876858a6b675cbc71f0c52f39584dfe3fd5b21850ec54080694416339780a20'
+  metadata.gz: 91137cebd5e7ca4dcfeabeeb3994e7d4564baa586d3764106b1cb651c17e7cca
+  data.tar.gz: 3c8283bd2612f3386c1532dcf9bfefb95d6a54a6cab144eb78466743197b3aa1
 SHA512:
-  metadata.gz: e97359edfa445da493e7cf9a3fe75716aed59ecef67b387b2b9b733f2696d709e030e9b51fa56433ea1acddbb65abb0e3afeaae167ccb943b64b8f6214c598d8
-  data.tar.gz: ab958039e3494ef2141bb10da35596368fd63957d92e4ce65013ba1ea9c18f9dd94a44106806404d009ac194bb9362ab0a6a19a577e8afc8789aa0a956b054a1
+  metadata.gz: cc734f579a2707398aa24faecac8bde966820ce4ece8072984c256095d5e8ed7ce375e7e162f65882667098f566a12f62c5002f865cbfdca1fbaa2408f00fcb3
+  data.tar.gz: 20781aa8bf90e705e6c6a96f625033a0b5cc7415afdb72fd766bb9e75a2805863c858e1291b9aeabbbf76a5ba6d5d20e31e51a590589dcf5aa3229733bd2938c

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.0.4
+
+* Add HTTP observer
+
+## 0.0.3
+
+  * Add MIT license
+
 ## 0.0.2
 
   * Added specs

data/Gemfile.lock

@@ -1,18 +1,44 @@
 PATH
   remote: .
   specs:
-    ruby_script_exporter (0.0.2)
+    ruby_script_exporter (0.0.4)
+      http (~> 5.2.0)
       rackup (~> 2.1.0)
       sinatra (~> 4.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
+    bigdecimal (3.1.8)
+    byebug (11.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
     diff-lcs (1.5.0)
-    mqtt (0.6.0)
+    domain_name (0.6.20240107)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    hashdiff (1.1.0)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.6)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
+    public_suffix (6.0.0)
     rack (3.0.8)
     rack-protection (4.0.0)
       base64 (>= 0.1.0)
@@ -23,6 +49,8 @@ GEM
       rack (>= 3)
       webrick (~> 1.8)
     rake (13.0.6)
+    rexml (3.3.1)
+      strscan
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -43,19 +71,25 @@ GEM
       rack-protection (= 4.0.0)
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
+    strscan (3.1.0)
     tilt (2.3.0)
     timecop (0.9.8)
+    webmock (3.23.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
     webrick (1.8.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  mqtt
+  byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.6)
   ruby_script_exporter!
   timecop (~> 0.9.8)
+  webmock (~> 3.23.1)
 
 BUNDLED WITH
    2.4.10

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Martin Schaflitzl
+
+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

@@ -12,6 +12,7 @@ ruby_script_exporter is a small framework to expose metrics produced by ruby sni
 Usage: ruby_script_exporter [options]
     -s SERVICE_DIR, --script-directory   Specify where to look for service definitions
     -r, --reload-on-request              Reload service definitions for every request, useful for developing probes
+    --raise-errors                       Raise on errors, dont just report the probe as failed
 ```
 
 ## Example Probe
@@ -62,3 +63,23 @@ total_probe_count 1
 ```
 
 Next to `some_metric` there are also a number of internal metrics exposed.
+
+## Build in observers
+
+### HTTP
+
+Used to check a HTTP endpoint.
+
+```
+service 'some_http_service' do
+probe 'some probe' do
+  label :some_label, 'Foo'
+  
+    run do
+      observe_http("https://example.com",
+        expected_body: /Example/,
+      )
+    end
+  end
+end
+```

data/example_services/dummy.rb

@@ -5,7 +5,7 @@ service 'dummy service' do
 
   probe 'dummy probe' do
     run do
-      observe :time, Time.now
+      observe :time, Time.now.to_i
     end
   end
 
@@ -13,7 +13,7 @@ service 'dummy service' do
     cache_for 30
 
     run do
-      observe :time, Time.now
+      observe :time, Time.now.to_i
     end
   end
 end

data/exe/ruby_script_exporter

@@ -5,27 +5,8 @@ require "bundler/setup"
 require 'optparse'
 require "ruby_script_exporter"
 
-options = {
-  service_dir: 'example_services/',
-  reload_on_request: false,
-  port: 9100,
-  host: '0.0.0.0',
-}
+options = RubyScriptExporter::Util.parse_options
 
-OptionParser.new do |opts|
-  opts.banner = "Usage: ruby_script_exporter [options]"
-
-  opts.on("-s SERVICE_DIR", "--script-directory SERVICE_DIR", "Specify where to look for service definitions") do |service_dir|
-    options[:service_dir] = service_dir
-  end
-
-  opts.on("-r", "--reload-on-request", "Reload service definitions for every request, useful for developing probes") do
-    options[:reload_on_request] = true
-  end
-end.parse!
-
-RubyScriptExporter::Server.service_directory = options[:service_dir]
-RubyScriptExporter::Server.reload_on_request = options[:reload_on_request]
 RubyScriptExporter::Server.set :port, options[:port]
 RubyScriptExporter::Server.set :bind , options[:host]
 RubyScriptExporter::Server.run!

data/lib/ruby_script_exporter/executor.rb

@@ -1,6 +1,14 @@
 module RubyScriptExporter
   class Executor
 
+    Type.register_type(:cached_probe_count, :gauge, 'Count of probes which returned a cached result', global: true)
+    Type.register_type(:error_probe_count, :gauge, 'Count probes witch threw an error while executing', global: true)
+    Type.register_type(:successful_probe_count, :gauge, 'Count of probes which ran successfully', global: true)
+    Type.register_type(:timeout_probe_count, :gauge, 'Count of probes which timed out', global: true)
+    Type.register_type(:total_probe_count, :gauge, 'Total probe count', global: true)
+    Type.register_type(:probe_execution_time, :gauge, 'Execution time per probe', global: true)
+    Type.register_type(:total_execution_time, :gauge, 'Total execution time', global: true)
+
     def initialize(services, report_execution_time: false, report_counts: false)
       @services = services
       @report_execution_time = report_execution_time
@@ -26,10 +34,12 @@ module RubyScriptExporter
 
         begin
           probe_measurements, execution_time = probe.run
-        rescue Probe::ScriptError
+        rescue Probe::ScriptError => e
+          STDERR.puts "Error while executing #{probe.inspect}: #{e.inspect}"
           error_count += 1
           next
         rescue Probe::ScriptTimeout
+          STDERR.puts "Timeout while executing #{probe.inspect}"
           timeout_count += 1
           next
         end

data/lib/ruby_script_exporter/observers/http.rb

@@ -0,0 +1,44 @@
+require 'http'
+
+module RubyScriptExporter
+  module Observers
+    module Http
+      Type.register_type(:http_status, :gauge, "HTTP response status: 0:good, 1:refused, 2:timeout, 3:name_not_resolved, 4:connection_failed, 5:certificate_error, 6:response_code_invalid, 7:response_body_invalid")
+      Type.register_type(:http_response_time, :gauge, "HTTP response time")
+
+      def observe_http(url, method: :get, expected_response_code: 200, expected_body: nil, timeout: 0.9)
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        response = HTTP.timeout(timeout).public_send(method, url)
+        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+        observe :http_response_time, end_time - start_time
+
+        if expected_response_code && expected_response_code != response.code
+          observe :http_status, 6
+          return
+        end
+
+        if expected_body && !response.body.to_s.match?(expected_body)
+          observe :http_status, 7
+          return
+        end
+
+        observe :http_status, 0
+      rescue HTTP::ConnectionError => e
+        case e.message
+        when /Name or service not known/
+          observe :http_status, 3 # Name not resolved
+        when /Connection refused/
+          observe :http_status, 1 # Connection refused
+        else
+          observe :http_status, 4 # Unknown connection error
+        end
+      rescue HTTP::ConnectTimeoutError, HTTP::TimeoutError => e
+        observe :http_status, 2 # Connection timeout
+      rescue OpenSSL::SSL::SSLError
+        observe :http_status, 5 # Certificate invalid
+      end
+
+    end
+  end
+end

data/lib/ruby_script_exporter/probe.rb

@@ -13,6 +13,14 @@ module RubyScriptExporter
     attr_writer :runner_proc
     attr_reader :service
 
+    def self.raise_errors=(raise_errors)
+      @raise_errors = raise_errors
+    end
+
+    def self.raise_errors
+      @raise_errors
+    end
+
     def initialize(name, service)
       @name = name
       @service = service
@@ -51,8 +59,12 @@ module RubyScriptExporter
         end
       rescue Timeout::Error
         raise ScriptTimeout
-      rescue StandardError
-        raise ScriptError
+      rescue StandardError => e
+        if self.class.raise_errors
+          raise e
+        end
+
+        raise ScriptError, e.inspect
       end
 
       execution_time = end_time - start_time

data/lib/ruby_script_exporter/runner.rb

@@ -1,6 +1,8 @@
 module RubyScriptExporter
   class Runner
 
+    include Observers::Http
+
     attr_reader :measurements
 
     def initialize(probe)

data/lib/ruby_script_exporter/server.rb

@@ -1,4 +1,5 @@
 require 'sinatra'
+require 'logger'
 
 module RubyScriptExporter
   class Server < Sinatra::Base
@@ -17,11 +18,16 @@ module RubyScriptExporter
       @services = RubyScriptExporter::ScriptLoader.load_directory(@service_directory)
     end
 
+    def self.run
+      measurements = Executor.new(services, report_execution_time: true, report_counts: true).run
+      Formatter.new(measurements).format
+    end
+
     set :default_content_type, 'text'
+    set :logging, Logger::DEBUG
 
     get '/metrics' do
-      measurements = Executor.new(self.class.services, report_execution_time: true, report_counts: true).run
-      Formatter.new(measurements).format
+      self.class.run
     end
   end
 end

data/lib/ruby_script_exporter/type.rb

@@ -1,18 +1,21 @@
 module RubyScriptExporter
   class Type
 
+    attr_reader :global
+
     @types = {}
 
-    def initialize(name, type, help = nil)
+    def initialize(name, type, help = nil, global: false)
       @name = name
       @type = type
       @help = help
+      @global = global
     end
 
-    def self.register_type(name, type, help = nil)
+    def self.register_type(name, type, help = nil, global: false)
       raise ArgumentError, "Type for measurement '#{name}' already registered." if @types.key?(name)
 
-      @types[name.to_sym] = Type.new(name, type, help)
+      @types[name.to_sym] = Type.new(name, type, help, global: global)
     end
 
     def self.from_name(name)
@@ -26,15 +29,12 @@ module RubyScriptExporter
       type
     end
 
+    def self.types
+      @types
+    end
+
     def self.reset_types
-      @types = {}
-      register_type(:cached_probe_count, :gauge, 'Count of probes which returned a cached result')
-      register_type(:error_probe_count, :gauge, 'Count probes witch threw an error while executing')
-      register_type(:successful_probe_count, :gauge, 'Count of probes which ran successfully')
-      register_type(:timeout_probe_count, :gauge, 'Count of probes which timed out')
-      register_type(:total_probe_count, :gauge, 'Total probe count')
-      register_type(:probe_execution_time, :gauge, 'Execution time per probe')
-      register_type(:total_execution_time, :gauge, 'Total execution time')
+      @types = @types.select { |_, v| v.global }
     end
 
     def format_for_open_metrics

data/lib/ruby_script_exporter/util.rb

@@ -7,5 +7,38 @@ module RubyScriptExporter
       "#{count} #{string}"
     end
 
+    def self.parse_options
+      options = {
+        service_dir: 'example_services/',
+        reload_on_request: false,
+        port: 9100,
+        host: '0.0.0.0',
+        raise_errors: false,
+      }
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: ruby_script_exporter [options]"
+
+        opts.on("-s SERVICE_DIR", "--script-directory SERVICE_DIR", "Specify where to look for service definitions") do |service_dir|
+          options[:service_dir] = service_dir
+        end
+
+        opts.on("-r", "--reload-on-request", "Reload service definitions for every request, useful for developing probes") do
+          options[:reload_on_request] = true
+        end
+
+        opts.on("--raise-errors", "Stop and print errors instead of raising the error count") do
+          options[:raise_errors] = true
+        end
+
+      end.parse!
+
+      RubyScriptExporter::Server.service_directory = options[:service_dir]
+      RubyScriptExporter::Server.reload_on_request = options[:reload_on_request]
+      RubyScriptExporter::Probe.raise_errors = options[:raise_errors]
+
+      options
+    end
+
   end
 end

data/lib/ruby_script_exporter/version.rb

@@ -1,3 +1,3 @@
 module RubyScriptExporter
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/lib/ruby_script_exporter.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "ruby_script_exporter/version"
+require_relative "ruby_script_exporter/type"
+require_relative "ruby_script_exporter/observers/http"
 require_relative "ruby_script_exporter/probe"
 require_relative "ruby_script_exporter/service"
 require_relative "ruby_script_exporter/server"
@@ -9,5 +11,4 @@ require_relative "ruby_script_exporter/runner"
 require_relative "ruby_script_exporter/measurement"
 require_relative "ruby_script_exporter/formatter"
 require_relative "ruby_script_exporter/script_loader"
-require_relative "ruby_script_exporter/util"
-require_relative "ruby_script_exporter/type"
+require_relative "ruby_script_exporter/util"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_script_exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Martin Schaflitzl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.23.1
 description: 
 email:
 - gems@martin-sc.de
@@ -93,6 +135,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - example_services/dummy.rb
@@ -101,6 +144,7 @@ files:
 - lib/ruby_script_exporter/executor.rb
 - lib/ruby_script_exporter/formatter.rb
 - lib/ruby_script_exporter/measurement.rb
+- lib/ruby_script_exporter/observers/http.rb
 - lib/ruby_script_exporter/probe.rb
 - lib/ruby_script_exporter/runner.rb
 - lib/ruby_script_exporter/script_loader.rb
@@ -110,10 +154,12 @@ files:
 - lib/ruby_script_exporter/util.rb
 - lib/ruby_script_exporter/version.rb
 homepage: https://rubygems.org/gems/ruby_script_exporter
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://rubygems.org/gems/ruby_script_exporter
   source_code_uri: https://github.com/mschaf/ruby_script_exporter
+  changelog_uri: https://github.com/mschaf/ruby_script_exporter/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: