ruby_script_exporter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a7c4a79deaa97a719986d2ca70f60a41e64d90c876758ed70f79ccc3689f7dc
+  data.tar.gz: 0cb360305395f727f7061ccc1b2a00ee026429d757210816605f9a1a60e5bd06
+SHA512:
+  metadata.gz: 818dcf6e0ba66db57d8e3199805393c1fb71fec075db55ec1d86600bc117979f1f18614b8cabb59c808476fae56275b955fb3e833f09843248b2ff29502b84ac
+  data.tar.gz: 80d871bc0407e38204a52250706fa2c3c821887f1a80734f2515419a823a286306a3e32d337ffcb0ca0ace39c9c512b28d632a8a79a350d5bbc2d237b28a70e2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_script_exporter.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem 'sinatra'
+gem 'rackup'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    ruby_script_exporter (0.0.1)
+      rackup (~> 2.1.0)
+      sinatra (~> 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    rack (3.0.8)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    sinatra (4.0.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.0.0)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    tilt (2.3.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rackup
+  rake (~> 13.0)
+  ruby_script_exporter!
+  sinatra
+
+BUNDLED WITH
+   2.4.10

data/README.md

@@ -0,0 +1,31 @@
+# RubyScriptExporter
+
+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.
+
+## 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
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_script_exporter.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/example_services/dummy.rb

@@ -0,0 +1,19 @@
+type :time, :counter, 'Seconds since 1970'
+
+service 'dummy service' do
+  label :service_label, '1234'
+
+  probe 'dummy probe' do
+    run do
+      observe :time, Time.now
+    end
+  end
+
+  probe 'cached dummy probe' do
+    cache_for 30
+
+    run do
+      observe :time, Time.now
+    end
+  end
+end

data/exe/ruby_script_exporter

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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',
+}
+
+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

@@ -0,0 +1,17 @@
+module RubyScriptExporter
+  class Executor
+
+    def initialize(services)
+      @services = services
+    end
+
+    def probes
+      @services.map(&:probes).flatten
+    end
+
+    def run
+      probes.map(&:run).flatten
+    end
+
+  end
+end

data/lib/ruby_script_exporter/formatter.rb

@@ -0,0 +1,23 @@
+module RubyScriptExporter
+  class Formatter
+
+    def initialize(measurements)
+      @measurements = measurements
+    end
+
+    def format
+      output = []
+
+      @measurements.group_by(&:measurement).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
+        end
+      end
+
+      output.join("\n")
+    end
+  end
+end

data/lib/ruby_script_exporter/measurement.rb

@@ -0,0 +1,46 @@
+module RubyScriptExporter
+  class Measurement
+
+    attr_reader :measurement
+    attr_reader :value
+
+    def initialize(measurement, value, timestamp:, probe:, **labels)
+      @measurement = measurement
+      @value = value
+      @probe = probe
+      @labels = labels
+      @timestamp = timestamp
+    end
+
+    def to_s
+      "<Measurement #{@measurement} #{@value} #{@labels.inspect}>"
+    end
+
+    def combined_labels
+      @probe.combined_labels.merge(@labels)
+    end
+
+    def format_as_open_metric
+      line = @measurement.to_s
+
+      if combined_labels.any?
+        line << '{'
+        line << combined_labels.map do |key, value|
+          "#{key}=\"#{value}\""
+        end.join(',')
+        line << '}'
+      end
+
+      line << ' '
+      line << @value.to_s
+
+      if @probe.caches_result?
+        line << ' '
+        line << @timestamp.to_s
+      end
+
+      line
+    end
+
+  end
+end

data/lib/ruby_script_exporter/probe.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RubyScriptExporter
+  class Probe
+
+    attr_reader :name
+    attr_reader :labels
+    attr_accessor :cache_for
+    attr_writer :runner_proc
+
+    def initialize(name, service)
+      @name = name
+      @service = service
+      @labels = {}
+      @last_measurements = nil
+      @last_run_at = nil
+    end
+
+    def combined_labels
+      @service.combined_labels.merge({
+        probe: @name,
+      }).merge(@labels).compact
+    end
+
+    def caches_result?
+      !!cache_for
+    end
+
+    def run
+      if caches_result? && @last_measurements && @last_run_at > (Time.now.to_f - @cache_for)
+        return @last_measurements
+      end
+
+      raise ArgumentError, 'No runner given' unless @runner_proc
+
+      runner = Runner.new(self)
+      runner.instance_eval(&@runner_proc)
+      @last_run_at = Time.now.to_f
+      @last_measurements = runner.measurements
+    end
+  end
+
+  class Probe::Builder
+    attr_accessor :probe
+
+    def initialize(name, service)
+      @probe = Probe.new(name, service)
+    end
+
+    def cache_for(time)
+       @probe.cache_for = time
+    end
+
+    def label(key, value)
+      @probe.labels[key] = value
+    end
+
+    def run(&block)
+      @probe.runner_proc = block
+    end
+  end
+
+end

data/lib/ruby_script_exporter/runner.rb

@@ -0,0 +1,17 @@
+module RubyScriptExporter
+  class Runner
+
+    attr_reader :measurements
+
+    def initialize(probe)
+      @probe = probe
+      @measurements = []
+    end
+
+    def observe(measurement, value, **labels)
+      timestamp = Time.now.to_i * 1000
+      @measurements << Measurement.new(measurement, value, timestamp:, probe: @probe, **labels)
+    end
+  end
+end
+

data/lib/ruby_script_exporter/script_loader.rb

@@ -0,0 +1,45 @@
+module RubyScriptExporter
+  class ScriptLoader
+
+    attr_reader :services
+
+    def initialize
+      @services = []
+    end
+
+    def service(name, &block)
+      service_builder = RubyScriptExporter::Service::Builder.new(name)
+      service_builder.instance_eval(&block)
+      @services << service_builder.service
+    end
+
+    def type(name, type, help = nil)
+      Type.register_type(name, type, help)
+    end
+
+    def self.load_file(file)
+      loader = ScriptLoader.new
+      code = File.open(file).read
+      loader.instance_eval code
+      loader.services
+    end
+
+    def self.load_directory(directory)
+      unless directory.start_with?('/')
+        directory = File.join(Dir.pwd, directory)
+      end
+      directory = File.join(directory, '/*.rb')
+
+      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)}"
+
+      services
+    end
+  end
+end
+

data/lib/ruby_script_exporter/server.rb

@@ -0,0 +1,28 @@
+require 'sinatra'
+
+module RubyScriptExporter
+  class Server < Sinatra::Base
+
+    def self.service_directory=(service_directory)
+      @service_directory = service_directory
+    end
+
+    def self.reload_on_request=(reload_on_request)
+      @reload_on_request = reload_on_request
+    end
+
+    def self.services
+      return @services if @services && !@reload_on_request
+
+      @services = RubyScriptExporter::ScriptLoader.load_directory(@service_directory)
+    end
+
+    set :default_content_type, 'text'
+
+    get '/metrics' do
+      measurements = Executor.new(self.class.services).run
+      Formatter.new(measurements).format
+    end
+  end
+end
+

data/lib/ruby_script_exporter/service.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RubyScriptExporter
+  class Service
+
+    attr_reader :name
+    attr_reader :probes
+    attr_reader :labels
+
+    def initialize(name)
+      @name = name
+      @probes = []
+      @labels = {}
+    end
+
+    def combined_labels
+      {
+        service: @name,
+      }.merge(@labels).compact
+    end
+
+  end
+
+  class Service::Builder
+    attr_reader :service
+
+    def initialize(name)
+      @service = Service.new(name)
+    end
+
+    def label(key, value)
+      @service.labels[key] = value
+    end
+
+    def probe(name, &block)
+      probe_builder = Probe::Builder.new(name, @service)
+      probe_builder.instance_eval(&block)
+      @service.probes << probe_builder.probe
+    end
+  end
+end

data/lib/ruby_script_exporter/type.rb

@@ -0,0 +1,41 @@
+module RubyScriptExporter
+  class Type
+
+    @types = {}
+
+    def initialize(name, type, help = nil)
+      @name = name
+      @type = type
+      @help = help
+    end
+
+    def self.register_type(name, type, help = nil)
+      raise ArgumentError, "Type for measurement '#{name}' already registered." if @types.key?(name)
+
+      @types[name.to_sym] = Type.new(name, type, help)
+    end
+
+    def self.from_name(name)
+      type = @types[name.to_sym]
+
+      unless type
+        puts "Warning type for measurement #{name} not found, defaulting to gauge."
+        type = register_type(name, :gauge)
+      end
+
+      type
+    end
+
+    def self.clear_types
+      @types = {}
+    end
+
+    def format_for_open_metrics
+      type_description = ''
+      type_description << "# HELP #{@name} #{@help}\n" if @help
+      type_description << "# TYPE #{@name} #{@type}"
+      type_description
+    end
+
+  end
+end

data/lib/ruby_script_exporter/util.rb

@@ -0,0 +1,11 @@
+module RubyScriptExporter
+  module Util
+
+    def self.counterize(string, count)
+      string = string.prepend('s') if count != 1
+
+      "#{count} #{string}"
+    end
+
+  end
+end

data/lib/ruby_script_exporter/version.rb

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

data/lib/ruby_script_exporter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "ruby_script_exporter/version"
+require_relative "ruby_script_exporter/probe"
+require_relative "ruby_script_exporter/service"
+require_relative "ruby_script_exporter/server"
+require_relative "ruby_script_exporter/executor"
+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"

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: ruby_script_exporter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Schaflitzl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 
+email:
+- gems@martin-sc.de
+executables:
+- ruby_script_exporter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- example_services/dummy.rb
+- exe/ruby_script_exporter
+- lib/ruby_script_exporter.rb
+- lib/ruby_script_exporter/executor.rb
+- lib/ruby_script_exporter/formatter.rb
+- lib/ruby_script_exporter/measurement.rb
+- lib/ruby_script_exporter/probe.rb
+- lib/ruby_script_exporter/runner.rb
+- lib/ruby_script_exporter/script_loader.rb
+- lib/ruby_script_exporter/server.rb
+- lib/ruby_script_exporter/service.rb
+- lib/ruby_script_exporter/type.rb
+- lib/ruby_script_exporter/util.rb
+- lib/ruby_script_exporter/version.rb
+homepage: https://rubygems.org/gems/ruby_script_exporter
+licenses: []
+metadata:
+  homepage_uri: https://rubygems.org/gems/ruby_script_exporter
+  source_code_uri: https://github.com/mschaf/ruby_script_exporter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Export metrics to prometheus from ruby snippets.
+test_files: []