prometheus-collector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0b9ae81681b71f64ad5b6689d4ffb5cd3544ec774ea928b04c240635938d843
+  data.tar.gz: 8ff03517b8f2cebfd84e56fee1f16ac4426933535f9d89995b72303a4d4d8bda
+SHA512:
+  metadata.gz: 983dc30a1ab55e8cf6a872b3302d0894d801e89830042df4c3a57bd5b30f15b7f44e0eeb9db21fc8bc5c313fd87a188b1a1b0d9a2970a3334f2be632563379e5
+  data.tar.gz: 5ed27c398bd5df4a3fc5512285e55bc925ae33056567bfd367ea92ce16e36c854bd147c350f167b471e512c132c717251601f7cc1439076fb3ea37ba78be85cd

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+Application to gather prometheus style metrics
+
+# Usage
+
+Install  the gem into your gemfile
+
+```gem prometheus-collector```
+
+Install your gemset
+
+```bundle install```
+
+Consume the program.
+
+
+```
+require 'prometheus/collector'
+
+class Guage < Prometheus::Collector::Extensions::Base
+  install
+
+  def run
+    # Do some things that would be collected in Prometheus::Client Objects
+  end
+end
+```
+
+Mount the Prometheus::Collector::Application application, or start it from your app.rb
+
+```
+Prometheus::Collector::Application.start
+```
+
+# How it works
+
+The collector app makes use of the Prometheus client collector and exporter middleware to allow you to write custom applications that export prometheus style metrics.
+
+It is designed as a bare-bones scaffold to get you off the ground with a ruby applet to get some statistics.
+
+It utilizes rack and its middleware.
+
+The interface is fairly straightforward: Your Metric Executing code needs to extend Prometheus::Collector::Extensions::Base for 'repeatedly-runbable' operations and Prometheus::Collector::Extensions::Once for something that should only be executed Once.
+
+Your class should implement an instance level `run` function, and may optionally implement a class level `schedule` function: This must return a `cron` style string to tell the application when to invoke your `run` code. By default, `schedule` is set to `* * * * *` which would allow the code to be executed every minute.
+
+### Scheduling
+Scheduling is implemented via em-cron. Thus the re-scheduling of a task should occur within the parameters of the `schedule` string but is evaluated upon completion. Thus in normal operation, the code should not execute more than one `run` of a given worker definition at a time.

data/bin/prometheus-collector

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+def generate(path)
+  FileUtils.copy_entry 'template', path
+  Dir.chdir(path) do
+    system 'bundle install'
+  end
+end
+
+case ARGV[0]
+when 'generate'
+  generate ARGV[1]
+else
+  puts 'unimplemented'
+end

data/config.ru

@@ -0,0 +1,6 @@
+require 'prometheus/collector'
+
+
+Prometheus::Collector::Application.start
+
+

data/lib/prometheus/collector/application.rb

@@ -0,0 +1,53 @@
+require 'prometheus/middleware/collector'
+require 'prometheus/middleware/exporter'
+require 'rack'
+module Prometheus
+  module Collector
+    class Application
+      def self.app
+        Rack::Builder.app do
+          use Rack::CommonLogger, Prometheus::Collector.logger
+          use Rack::Deflater
+          use Prometheus::Middleware::Collector
+          use Prometheus::Middleware::Exporter
+          run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['OK']] }
+        end
+      end
+
+      def self.start
+        initialize_static_extensions
+        initialize_runnable_extensions
+        Rack::Server.start(
+          app: app, Port: 9292
+        )
+      end
+
+      def self.initialize_static_extensions
+        Prometheus::Collector.logger.info "Initializing Static Extensions"
+        Extensions.values.each do |o|
+          Prometheus::Collector.logger.info "Initializing #{o.class.name}"
+          begin
+            o.callback.call o.call
+          rescue => e
+            o.errback.call e
+          end
+        end
+        Prometheus::Collector.logger.info "Done initializing Static Extensions"
+      end
+
+      def self.initialize_runnable_extensions
+        Prometheus::Collector.logger.info "Initializing Runnable Extensions"
+        Thread.new do
+          EM.run do
+            Extensions::Runnable.values.each do |o|
+              Prometheus::Collector.logger.info "Initializing #{o.class.name}"
+              EM::Cron.schedule(o.class.schedule) do |time|
+                EM.defer(o, o.callback, o.errback)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+ end

data/lib/prometheus/collector/extensions/http_requests.rb

@@ -0,0 +1,9 @@
+class HTTPRequests < Prometheus::Collector::Extensions::Once
+  install
+
+  def run
+    return if @requests
+    @requests = Prometheus::Client::Counter.new(:http_requests, docstring: 'A counter of HTTP Requests')
+   # Prometheus::Client.registry.register(@requests)
+  end
+end

data/lib/prometheus/collector/extensions.rb

@@ -0,0 +1,76 @@
+require 'register'
+
+module Prometheus
+  module Collector
+    module Extensions
+      include Register
+      module Runnable
+        include Register
+      end
+
+      class Base
+        class << self
+          attr_writer :logger, :schedule
+
+          def logger
+            @logger ||= Prometheus::Collector.logger
+          end
+
+          def schedule
+            @schedule ||= '* * * * *'
+          end
+
+          def install
+            logger.info "Install #{name.to_sym}"
+            Prometheus::Collector::Extensions::Runnable.register name.to_sym, new
+          end
+        end
+
+        def log(msg, level: :info)
+          self.class.logger.send(level, self.class) { msg } if self.class.logger
+        end
+
+        def call
+          log 'Starting call'
+          run
+        end
+
+        def run
+          raise 'Not Implemented - please implement a run function'
+        end
+
+        def callback
+          proc { log 'Finished call' }
+        end
+
+        def errback
+          proc do |error|
+            log "Exception in call: '#{error}'", level: :error
+            log 'Backtrace:', level: :debug
+            error.backtrace.each do |l|
+              log l, level: :debug
+            end
+          end
+        end
+      end
+
+      class Once < Base
+        class << self
+          def install
+            logger.info "Install #{name.to_sym}"
+            Prometheus::Collector::Extensions.register name.to_sym, new
+          end
+        end
+
+        def call
+          log 'Installing Runner Once'
+          run
+        end
+
+        def callback
+          proc { log 'Finished Installing Runner Once' }
+        end
+      end
+    end
+  end
+end

data/lib/prometheus/collector/version.rb

@@ -0,0 +1,5 @@
+module Prometheus
+  module Collector
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/prometheus/collector.rb

@@ -0,0 +1,27 @@
+require 'prometheus/client'
+
+require 'register'
+require 'em/cron'
+require 'logger'
+
+
+require 'prometheus/collector/extensions'
+require 'prometheus/collector/application'
+
+module Prometheus
+  module Collector
+    class << self
+      attr_writer :logger
+
+      def logger
+        @logger ||= Logger.new ENV.fetch('PROMETHEUS_COLLECTOR_LOGGER', STDOUT)
+      end
+
+    end
+  end
+end
+
+Dir.glob("#{File.dirname(__FILE__)}/collector/extensions/*").each do |f|
+  require "prometheus/collector/extensions/#{File.basename(f)}"
+end
+

data/prometheus-collector.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prometheus/collector/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'prometheus-collector'
+  spec.version = Prometheus::Collector::VERSION
+  spec.authors = ['Stuart Harland']
+  spec.email   = ['essjayhch@gmail.com']
+
+  spec.summary  = 'Scaffold to collect prometheus style metrics from an application via a RACK interface'
+  spec.description = File.read('README.md')
+
+  spec.homepage = 'https://github.com/essjayhch/prometheus-collector'
+  spec.license = 'MIT'
+
+  spec.files =`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.executables << 'prometheus-collector'
+
+  spec.add_dependency  'prometheus-client', '> 0'
+  spec.add_dependency  'puma', '> 0'
+  spec.add_dependency  'rack', '> 0'
+  spec.add_dependency  'register', '> 0'
+  spec.add_dependency  'em-cron', '> 0'
+
+  spec.add_development_dependency 'fileutils'
+end

data/template/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'prometheus-collector'

data/template/app.rb

@@ -0,0 +1,18 @@
+require 'prometheus/collector'
+
+class Guage < Prometheus::Collector::Extensions::Base
+  install
+
+  def run
+    counter.increment(labels: { service: 'foo'})
+  end
+
+  def counter
+    return @counter if @counter
+    @counter = Prometheus::Client::Counter.new(:test_counter, docstring: 'Rolling Counter', labels: [:service])
+    Prometheus::Client.registry.register(@counter)
+    @counter
+  end
+end
+
+Prometheus::Collector::Application.start

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: prometheus-collector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stuart Harland
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prometheus-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: register
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  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'
+description: |
+  Application to gather prometheus style metrics
+
+  # Usage
+
+  Install  the gem into your gemfile
+
+  ```gem prometheus-collector```
+
+  Install your gemset
+
+  ```bundle install```
+
+  Consume the program.
+
+
+  ```
+  require 'prometheus/collector'
+
+  class Guage < Prometheus::Collector::Extensions::Base
+    install
+
+    def run
+      # Do some things that would be collected in Prometheus::Client Objects
+    end
+  end
+  ```
+
+  Mount the Prometheus::Collector::Application application, or start it from your app.rb
+
+  ```
+  Prometheus::Collector::Application.start
+  ```
+
+  # How it works
+
+  The collector app makes use of the Prometheus client collector and exporter middleware to allow you to write custom applications that export prometheus style metrics.
+
+  It is designed as a bare-bones scaffold to get you off the ground with a ruby applet to get some statistics.
+
+  It utilizes rack and its middleware.
+
+  The interface is fairly straightforward: Your Metric Executing code needs to extend Prometheus::Collector::Extensions::Base for 'repeatedly-runbable' operations and Prometheus::Collector::Extensions::Once for something that should only be executed Once.
+
+  Your class should implement an instance level `run` function, and may optionally implement a class level `schedule` function: This must return a `cron` style string to tell the application when to invoke your `run` code. By default, `schedule` is set to `* * * * *` which would allow the code to be executed every minute.
+
+  ### Scheduling
+  Scheduling is implemented via em-cron. Thus the re-scheduling of a task should occur within the parameters of the `schedule` string but is evaluated upon completion. Thus in normal operation, the code should not execute more than one `run` of a given worker definition at a time.
+email:
+- essjayhch@gmail.com
+executables:
+- prometheus-collector
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/prometheus-collector
+- config.ru
+- lib/prometheus/collector.rb
+- lib/prometheus/collector/application.rb
+- lib/prometheus/collector/extensions.rb
+- lib/prometheus/collector/extensions/http_requests.rb
+- lib/prometheus/collector/version.rb
+- prometheus-collector.gemspec
+- template/Gemfile
+- template/app.rb
+homepage: https://github.com/essjayhch/prometheus-collector
+licenses:
+- MIT
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Scaffold to collect prometheus style metrics from an application via a RACK
+  interface
+test_files: []