ruby_script_exporter 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a7c4a79deaa97a719986d2ca70f60a41e64d90c876758ed70f79ccc3689f7dc
-  data.tar.gz: 0cb360305395f727f7061ccc1b2a00ee026429d757210816605f9a1a60e5bd06
+  metadata.gz: 88837a91632cfcfb2f16988f4b173309b21fc9b9be3a30293fe19fbd4ea73943
+  data.tar.gz: f727e150aceb929705fe4e5d94cf791bdd0c31b68e6fbcfb98a48434dd81db6a
 SHA512:
-  metadata.gz: 818dcf6e0ba66db57d8e3199805393c1fb71fec075db55ec1d86600bc117979f1f18614b8cabb59c808476fae56275b955fb3e833f09843248b2ff29502b84ac
-  data.tar.gz: 80d871bc0407e38204a52250706fa2c3c821887f1a80734f2515419a823a286306a3e32d337ffcb0ca0ace39c9c512b28d632a8a79a350d5bbc2d237b28a70e2
+  metadata.gz: 3952f1924fd00357a6d35ed78ed974a8d4b26da6ec1bde52e59bfc419e12217f18e754bcf3a9dbac2ba177211586540c356273e7d3fa2f203e98d6ec831eae57
+  data.tar.gz: bed7fb348412b2011e62fc0846978a8627b1654ee2c8451d9bd85776a1f03edf607b55e59bfda50d5fcf181ee4f3448849b47bac6880b72d5d74ee1931514139

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.0.3
+
+  * Add MIT license
+
+## 0.0.2
+
+  * Added specs
+  * Added error handling
+  * Added execution time reporting
+
+## 0.0.1
+
+  * Initial release with the most basic functionality

data/Gemfile

@@ -3,8 +3,4 @@
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in ruby_script_exporter.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-gem 'sinatra'
-gem 'rackup'
+gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_script_exporter (0.0.1)
+    ruby_script_exporter (0.0.3)
       rackup (~> 2.1.0)
       sinatra (~> 4.0.0)
 
@@ -9,6 +9,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     base64 (0.2.0)
+    diff-lcs (1.5.0)
+    mqtt (0.6.0)
     mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
     rack (3.0.8)
@@ -21,6 +23,19 @@ GEM
       rack (>= 3)
       webrick (~> 1.8)
     rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
     ruby2_keywords (0.0.5)
     sinatra (4.0.0)
       mustermann (~> 3.0)
@@ -29,16 +44,18 @@ GEM
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
     tilt (2.3.0)
+    timecop (0.9.8)
     webrick (1.8.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  rackup
+  mqtt
   rake (~> 13.0)
+  rspec (~> 3.6)
   ruby_script_exporter!
-  sinatra
+  timecop (~> 0.9.8)
 
 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

@@ -1,31 +1,64 @@
-# RubyScriptExporter
+# ruby_script_exporter
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby_script_exporter`. To experiment with that code, run `bin/console` for an interactive prompt.
+ruby_script_exporter is a small framework to expose metrics produced by ruby snippets to prometheus.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+`gem install ruby_script_exporter`
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+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
+```
+
+## Example Probe
 
-## Development
+`services/example_probe.rb`:  
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+type :some_metric, :gauge, 'Some random metric'
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+service 'some service' do
+  probe 'some probe' do
+    label :some_label, 'Foo'
+    
+    run do
+       observe :some_metric, 123
+    end
+  end
+end
+```
+ 
+Run the exporter with `ruby_script_exporter` and get `http://localhost:9100` for:  
 
-## Contributing
+```
+# HELP cached_probe_count Count of probes which returned a cached result
+# TYPE cached_probe_count gauge
+cached_probe_count 0
+# HELP error_probe_count Count probes witch threw an error while executing
+# TYPE error_probe_count gauge
+error_probe_count 0
+# HELP probe_execution_time Execution time per probe
+# TYPE probe_execution_time gauge
+probe_execution_time{service="some service",probe="some probe",some_label="Foo"} 7.915019523352385e-06
+# HELP some_metric Some random metric
+# TYPE some_metric gauge
+some_metric{service="some service",probe="some probe",some_label="Foo"} 123
+# HELP successful_probe_count Count of probes which ran successfully
+# TYPE successful_probe_count gauge
+successful_probe_count 1
+# HELP timeout_probe_count Count of probes which timed out
+# TYPE timeout_probe_count gauge
+timeout_probe_count 0
+# HELP total_execution_time Total execution time
+# TYPE total_execution_time gauge
+total_execution_time 6.38000201433897e-05
+# HELP total_probe_count Total probe count
+# TYPE total_probe_count gauge
+total_probe_count 1
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_script_exporter.
+Next to `some_metric` there are also a number of internal metrics exposed.

data/lib/ruby_script_exporter/executor.rb

@@ -1,8 +1,10 @@
 module RubyScriptExporter
   class Executor
 
-    def initialize(services)
+    def initialize(services, report_execution_time: false, report_counts: false)
       @services = services
+      @report_execution_time = report_execution_time
+      @report_counts = report_counts
     end
 
     def probes
@@ -10,7 +12,59 @@ module RubyScriptExporter
     end
 
     def run
-      probes.map(&:run).flatten
+      total_count = 0
+      successful_count = 0
+      cached_count = 0
+      error_count = 0
+      timeout_count = 0
+      measurements = []
+
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      probes.each do |probe|
+        total_count += 1
+
+        begin
+          probe_measurements, execution_time = probe.run
+        rescue Probe::ScriptError
+          error_count += 1
+          next
+        rescue Probe::ScriptTimeout
+          timeout_count += 1
+          next
+        end
+
+        measurements.concat(probe_measurements)
+
+        successful_count += 1
+        if execution_time == :cached
+          execution_time = 0
+          cached_count += 1
+        end
+
+        if @report_execution_time
+          measurements << Measurement.new(:probe_execution_time, execution_time,
+            probe: probe,
+          )
+        end
+      end
+
+      end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      total_execution_time = end_time - start_time
+
+      if @report_execution_time
+        measurements << Measurement.new(:total_execution_time, total_execution_time)
+      end
+
+      if @report_counts
+        measurements << Measurement.new(:total_probe_count, total_count)
+        measurements << Measurement.new(:successful_probe_count, successful_count)
+        measurements << Measurement.new(:cached_probe_count, cached_count)
+        measurements << Measurement.new(:error_probe_count, error_count)
+        measurements << Measurement.new(:timeout_probe_count, timeout_count)
+      end
+
+      measurements
     end
 
   end

data/lib/ruby_script_exporter/formatter.rb

@@ -8,14 +8,17 @@ module RubyScriptExporter
     def format
       output = []
 
-      @measurements.group_by(&:measurement).map do |type, measurements|
-        type = Type.from_name(type)
-        output << type.format_for_open_metrics
+      @measurements
+        .group_by(&:measurement)
+        .sort_by { |key, _| key }
+        .map do |type, measurements|
+          type = Type.from_name(type)
+          output << type.format_for_open_metrics
 
-        measurements.each do |measurement|
-          output << measurement.format_as_open_metric
+          measurements.each do |measurement|
+            output << measurement.format_as_open_metric
+          end
         end
-      end
 
       output.join("\n")
     end

data/lib/ruby_script_exporter/measurement.rb

@@ -4,7 +4,7 @@ module RubyScriptExporter
     attr_reader :measurement
     attr_reader :value
 
-    def initialize(measurement, value, timestamp:, probe:, **labels)
+    def initialize(measurement, value, timestamp: nil, probe: nil, **labels)
       @measurement = measurement
       @value = value
       @probe = probe
@@ -17,6 +17,8 @@ module RubyScriptExporter
     end
 
     def combined_labels
+      return @labels unless @probe
+
       @probe.combined_labels.merge(@labels)
     end
 
@@ -34,7 +36,7 @@ module RubyScriptExporter
       line << ' '
       line << @value.to_s
 
-      if @probe.caches_result?
+      if @probe&.caches_result?
         line << ' '
         line << @timestamp.to_s
       end

data/lib/ruby_script_exporter/probe.rb

@@ -3,10 +3,15 @@
 module RubyScriptExporter
   class Probe
 
+    class ScriptError < StandardError; end
+    class ScriptTimeout < StandardError; end
+
     attr_reader :name
     attr_reader :labels
     attr_accessor :cache_for
+    attr_accessor :timeout
     attr_writer :runner_proc
+    attr_reader :service
 
     def initialize(name, service)
       @name = name
@@ -14,6 +19,7 @@ module RubyScriptExporter
       @labels = {}
       @last_measurements = nil
       @last_run_at = nil
+      @timeout = 1
     end
 
     def combined_labels
@@ -28,15 +34,32 @@ module RubyScriptExporter
 
     def run
       if caches_result? && @last_measurements && @last_run_at > (Time.now.to_f - @cache_for)
-        return @last_measurements
+        return [@last_measurements, :cached]
       end
 
       raise ArgumentError, 'No runner given' unless @runner_proc
 
       runner = Runner.new(self)
-      runner.instance_eval(&@runner_proc)
+
+      start_time = nil
+      end_time = nil
+      begin
+        Timeout::timeout(@timeout) do
+          start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+          runner.instance_eval(&@runner_proc)
+          end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        end
+      rescue Timeout::Error
+        raise ScriptTimeout
+      rescue StandardError
+        raise ScriptError
+      end
+
+      execution_time = end_time - start_time
+
       @last_run_at = Time.now.to_f
       @last_measurements = runner.measurements
+      [@last_measurements, execution_time]
     end
   end
 
@@ -51,6 +74,10 @@ module RubyScriptExporter
        @probe.cache_for = time
     end
 
+    def timeout(timeout)
+      @probe.timeout = timeout
+    end
+
     def label(key, value)
       @probe.labels[key] = value
     end

data/lib/ruby_script_exporter/script_loader.rb

@@ -17,13 +17,17 @@ module RubyScriptExporter
       Type.register_type(name, type, help)
     end
 
-    def self.load_file(file)
+    def self.load_string(string)
       loader = ScriptLoader.new
-      code = File.open(file).read
-      loader.instance_eval code
+      Type.reset_types
+      loader.instance_eval string
       loader.services
     end
 
+    def self.load_file(file)
+      load_string File.open(file).read
+    end
+
     def self.load_directory(directory)
       unless directory.start_with?('/')
         directory = File.join(Dir.pwd, directory)
@@ -33,7 +37,6 @@ module RubyScriptExporter
       service_files = Dir[directory]
 
       puts "Loading service definitions ..."
-      Type.clear_types
       services = service_files.map { load_file(_1) }.flatten
       probe_count = services.map(&:probes).flatten.count
       puts "Loaded #{Util.counterize('service', services.count)} with a total of #{Util.counterize('probe', probe_count)}"

data/lib/ruby_script_exporter/server.rb

@@ -20,7 +20,7 @@ module RubyScriptExporter
     set :default_content_type, 'text'
 
     get '/metrics' do
-      measurements = Executor.new(self.class.services).run
+      measurements = Executor.new(self.class.services, report_execution_time: true, report_counts: true).run
       Formatter.new(measurements).format
     end
   end

data/lib/ruby_script_exporter/type.rb

@@ -26,8 +26,15 @@ module RubyScriptExporter
       type
     end
 
-    def self.clear_types
+    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')
     end
 
     def format_for_open_metrics

data/lib/ruby_script_exporter/version.rb

@@ -1,3 +1,3 @@
 module RubyScriptExporter
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_script_exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Martin Schaflitzl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !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'
 description: 
 email:
 - gems@martin-sc.de
@@ -46,9 +88,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".tool-versions"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - example_services/dummy.rb
@@ -66,10 +111,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: