deimos 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb1166f1af8b6589e45dc0a2ab20fec615b691db7348e91199b368714a43e3a1
-  data.tar.gz: 562fd8af67609e08de2f1063053a6f8cd6f84671a844e4d44b5bf61543a14800
+  metadata.gz: 15cc6372bc401ffa051316be8573fd8066b5f1749753679d680459c8846a394d
+  data.tar.gz: 504c5872e4c5c71ebd1f269075667589697fd3e20b95e6f10461e01fb2d8009a
 SHA512:
-  metadata.gz: 980ee84529e282e676faa1191f8053ee6ff451d466f13888a5ecbf0448e450ef9e5c27cb04392847bedb2511c8fb473f38cd2ceeea7320132b5463df619c204b
-  data.tar.gz: 20afcdeea07eab350938a88580898c0a6e5a11a7b695394c94eac68eeb5ea37e44bc80722f3b70fe5d50f82ccfa397fc0508f8bdd53d1cc61505224a2678b7f3
+  metadata.gz: 115bd70bb83642e7e58eeb5fd79856a0c1bb42390f879898ae015d0180bd81770ef6eb9499af239b1dc0ed6c90330f175abd4176a8b0b61834d1603e5dc83075
+  data.tar.gz: 4bf4b534367761779afc0c359cd5081c308d7245049b4a8c28fd953ef1d7a332d3d4af32e45098221f96a86a32ae94e2e8f02238b53fb635572a38668bbb6da9

data/Gemfile.lock

@@ -2,23 +2,38 @@ PATH
   remote: .
   specs:
     deimos (0.1.0)
+      activesupport
+      concurrent-ruby
       huyegger
+      prometheus-client
       sinatra
       sinatra-contrib
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
     backports (3.12.0)
     coderay (1.1.2)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     huyegger (0.4.4)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     method_source (0.9.2)
+    minitest (5.11.3)
     multi_json (1.13.1)
     mustermann (1.0.3)
+    prometheus-client (0.9.0)
+      quantile (~> 0.2.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    quantile (0.2.1)
     rack (2.0.6)
     rack-protection (2.0.5)
       rack
@@ -48,7 +63,10 @@ GEM
       rack-protection (= 2.0.5)
       sinatra (= 2.0.5)
       tilt (>= 1.3, < 3)
+    thread_safe (0.3.6)
     tilt (2.0.9)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,8 +1,10 @@
 # Deimos
 
-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/deimos`. To experiment with that code, run `bin/console` for an interactive prompt.
+Deimos is an application designed to be run alongside Phobos, but can be run in any context to provide a unified status and metrics interface for kubernetes style applications.
 
-TODO: Delete this and the text above, and describe your gem
+## Name
+
+Deimos, brother of Phobos, from Greek mythology. The personification of dread and terror. Also it is the other natural Martian satelite, the first being Phobos
 
 ## Installation
 
@@ -22,7 +24,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+```ruby
+Deimos.configure do |config|
+    config.log_level = ENV.fetch("LOG_LEVEL", ::Logger::INFO)
+    config.port      = ENV.fetch("PORT", 5000)
+    config.bind      = ENV.fetch("BIND_IP", "0.0.0.0")
+    # An application hash that allows you to add more rack apps
+    # Doesn't override the defaults, just merges
+    config.applications.merge('/path' => Rack::App.new)
+    # Allows you to inject more middlewares into the application
+    config.applications.middleware << Middleware
+end
+```
+
+### Status
+
+Deimos allows you to add as many status checks are you like, however the API expects a true or false response. Any false responses from the bound blocks will return an `internal_server_error`
+
+```ruby
+Deimos.status.add(:allocations) { AllocationService::Status.new.call }
+Deimos.status.add(:another_check) { true }
+```
+```json
+# GET /status
+{ "allocations":true, "another_check":true }
+```
+
+Status checks are run in parallel.
+
+
+### Metrics
+
+Deimos uses `ActiveSupport::Notification` and `Prometheus` under the hood. 
+
+#### Subscribing
+
+The subsription takes, three required arguments and a block.
+* The event name to subscribe to
+* The type of collector
+* The prometheus label
+
+It also takes any extra keyword arguments and passes them to the collector, allowing you to specify extra options for each type of collector
+
+* [Prometheus Collectors](https://github.com/prometheus/client_ruby#metrics)
+* [ActiveSupport Notifications](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html)
+
+```ruby
+Deimos.metrics.subscribe('event.name', type: :gauge, label: 'Label') do |event, collector|
+    collector.increment({}, event.payload[:value])
+    # event is an ActiveSupport::Notification::Event
+    # event.name      # => "render"
+    # event.duration  # => 10 (in milliseconds)
+    # event.payload   # => {some: :payload}
+
+    # collector is a Prometheus::Client::#{type.classify}
+  end
+```
+
+#### Instrumenting
+
+`Deimos.metrics.instrument` delegates directly to `ActiveSupport::Notifications.instrument`, please see the [ActiveSupport Notifications](https://api.rubyonrails.org/classes/ActiveSupport/Notifications.html) documentation for more information
+
+```ruby
+Deimos.metrics.instrument('product_count', value: 10 + i) do
+    # can wrap a block to give you code execution duration
+end
+```
 
 ## Development
 
@@ -32,7 +101,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deimos.
+Bug reports and pull requests are welcome on GitHub at https://github.com/adamcarlile/deimos.
 
 ## License
 

data/deimos.gemspec

@@ -23,6 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sinatra"
   spec.add_dependency "sinatra-contrib"
   spec.add_dependency "huyegger"
+  spec.add_dependency "concurrent-ruby"
+  spec.add_dependency "prometheus-client"
+  spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/deimos/endpoints/metrics.rb

@@ -0,0 +1,11 @@
+module Deimos
+  module Endpoints
+    class Metrics < Sinatra::Application
+      disable :logging
+      set :logger, Deimos.logger
+      
+      use Prometheus::Middleware::Exporter, registry: Deimos.metrics.registry, path: ''
+      
+    end
+  end
+end

data/lib/deimos/endpoints/status.rb

@@ -0,0 +1,17 @@
+module Deimos
+  module Endpoints
+    class Status < Sinatra::Application
+      disable :logging
+      set :logger, Deimos.logger
+
+      get "/" do
+        status_runner = Deimos.status.run!
+
+        content_type :json
+        status status_runner.status
+        status_runner.body
+      end
+      
+    end
+  end
+end

data/lib/deimos/metrics/manager.rb

@@ -0,0 +1,48 @@
+module Deimos
+  module Metrics
+    class Manager
+      TYPES = {
+        counter: Prometheus::Client::Counter,
+        gauge: Prometheus::Client::Gauge,
+        histogram: Prometheus::Client::Histogram,
+        summary: Prometheus::Client::Summary
+      }
+
+      delegate :instrument, to: ActiveSupport::Notifications
+    
+      def subscriptions
+        @subscriptions ||= []
+      end
+
+      def collectors
+        @collectors ||= {}
+      end
+
+      def registry
+        @registry ||= Prometheus::Client.registry
+      end
+
+      def subscribe(event_name, type:, label:, **kwargs, &block)
+        Deimos.logger.info "Metrics: Subscribed to #{event_name}..."
+        subscriptions << ActiveSupport::Notifications.subscribe(event_name) do |*args|
+          event = ActiveSupport::Notifications::Event.new(*args)
+          collector = register_collector!(event_name, type, label, kwargs)
+          if block_given?
+            yield(event, collector)
+          else
+            Deimos.logger.info event
+          end
+        end
+      end
+
+      private
+
+      def register_collector!(event_name, type, about, **kwargs)
+        return collectors[event_name] if collectors[event_name].present?
+        name = event_name.gsub(".", "_").to_sym
+        collectors[event_name] = TYPES[type].new(name, about, kwargs).tap { |x| registry.register(x) }
+      end
+
+    end
+  end
+end

data/lib/deimos/status/manager.rb

@@ -0,0 +1,21 @@
+module Deimos
+  module Status
+    class Manager
+
+      attr_reader :checks
+      def checks
+        @checks ||= {}
+      end
+
+      def add(name, &block)
+        Deimos.logger.info "Status: Reporting #{name} status..."
+
+        checks[name] = block || Proc.new { true }
+      end
+
+      def run!
+        Deimos::Status::Runner.new(checks)
+      end
+    end
+  end
+end

data/lib/deimos/status/runner.rb

@@ -0,0 +1,30 @@
+module Deimos
+  module Status
+    class Runner
+      def initialize(checks)
+        @checks = checks.dup
+      end
+
+      def status
+        ok? ? :ok : :internal_server_error
+      end
+
+      def body
+        completed_checks.to_json
+      end
+
+      private
+
+      def ok?
+        completed_checks.values.all?
+      end
+
+      def completed_checks
+        @completed_checks ||= @checks.transform_values do |function|
+          Concurrent::Promises.future(&function)
+        end.transform_values(&:value)
+      end
+      
+    end
+  end
+end

data/lib/deimos/version.rb

@@ -1,3 +1,3 @@
 module Deimos
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/deimos.rb

@@ -1,27 +1,53 @@
+require 'rack'
 require 'huyegger'
 require 'sinatra'
+require 'active_support'
 require 'sinatra/contrib'
+require "sinatra/json"
 require 'webrick'
 require 'logger'
+require 'webrick'
+require 'concurrent-ruby'
+require 'prometheus/client'
+require 'prometheus/middleware/exporter'
 
 require "deimos/version"
 
 require 'deimos/logger'
-require 'deimos/manager'
+require 'deimos/status/runner'
+require 'deimos/status/manager'
+require 'deimos/metrics/manager'
 
 module Deimos
   module_function
 
   def boot!
-    require 'deimos/status'
-    Thread.new { Deimos::Status.run! }
+    require 'deimos/endpoints/status'
+    require 'deimos/endpoints/metrics'
+    Thread.new do 
+      ::Rack::Handler::WEBrick.run(application, {
+        BindAddress: Deimos.config.bind,
+        Port: Deimos.config.port,
+        Logger: Deimos.logger,
+        AccessLog: []
+      })
+    end
+  end
+
+  def application
+    Rack::Builder.new do
+      Deimos.middleware.each { |m| use m }
+      run Rack::URLMap.new(Deimos.applications)
+    end
   end
 
   def config
     @config ||= OpenStruct.new.tap do |x|
-      x.log_level = ENV.fetch("LOG_LEVEL", ::Logger::INFO)
-      x.port      = ENV.fetch("PORT", 5000)
-      x.bind      = ENV.fetch("BIND_IP", "0.0.0.0")
+      x.log_level    = ENV.fetch("LOG_LEVEL", ::Logger::INFO)
+      x.port         = ENV.fetch("PORT", 5000)
+      x.bind         = ENV.fetch("BIND_IP", "0.0.0.0")
+      x.applications = {}
+      x.middleware   = []
     end
   end
 
@@ -29,12 +55,23 @@ module Deimos
     yield(config)
   end
 
-  def manager
-    @manager ||= Deimos::Manager.new
+  def middleware
+    @middleware ||= [Rack::Deflater, Deimos::Logger] | config.middleware
+  end
+
+  def applications
+    @applications ||= {
+      "/status" => Deimos::Endpoints::Status,
+      "/metrics" => Deimos::Endpoints::Metrics
+    }.merge(config.applications)
+  end
+
+  def status
+    @status ||= Deimos::Status::Manager.new
   end
 
-  def add(*args, &block)
-    manager.add(*args, &block)
+  def metrics
+    @metrics ||= Deimos::Metrics::Manager.new
   end
 
   def logger

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deimos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Carlile
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-03 00:00:00.000000000 Z
+date: 2019-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -52,6 +52,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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: 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: activesupport
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -127,9 +169,12 @@ files:
 - bin/setup
 - deimos.gemspec
 - lib/deimos.rb
+- lib/deimos/endpoints/metrics.rb
+- lib/deimos/endpoints/status.rb
 - lib/deimos/logger.rb
-- lib/deimos/manager.rb
-- lib/deimos/status.rb
+- lib/deimos/metrics/manager.rb
+- lib/deimos/status/manager.rb
+- lib/deimos/status/runner.rb
 - lib/deimos/version.rb
 homepage: https://github.com/adamcarlile/deimos
 licenses:

data/lib/deimos/manager.rb

@@ -1,17 +0,0 @@
-module Deimos
-  class Manager
-
-    def checks
-      @checks ||= {}
-    end
-
-    def add(name, &block)
-      checks[name] = block || Proc.new { true }
-    end
-
-    def call
-      checks.transform_values(&:call).to_json
-    end
-
-  end
-end

data/lib/deimos/status.rb

@@ -1,27 +0,0 @@
-require "sinatra/base"
-require "sinatra/json"
-require 'webrick'
-
-# Sinatra Applicaiton to present basic health check endpoint
-module Deimos
-  class Status < Sinatra::Application
-
-    set :bind, Deimos.config.bind
-    set :port, Deimos.config.port
-    disable :show_exceptions, :traps, :logging
-
-    use Deimos::Logger
-
-    set :quiet, true
-    set :logger, Deimos.logger
-    set :server, :webrick
-    set :server_settings,
-      Logger: Deimos.logger,
-      AccessLog: []
-
-    get "/status" do
-      content_type :json
-      Deimos.manager.call
-    end
-  end
-end