rack-healthz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f2db9eb6e4e77c61d09a7c24c09ed1054be13a9
+  data.tar.gz: 47d097eda0ea43b797347f8c5c72be986a9adde3
+SHA512:
+  metadata.gz: 6f4c748f5b46b7128b12ad568c873d9dada21b438c885ff2738d591e7c949f48d79e236c8fc0e60635885a887e0b3381703eca359d7affda37158322baecba34
+  data.tar.gz: ebbd397052a57252725f2edd24f094532d0871de79a476bd1d43d50aabe4c38d03f4d5c28dc422ac77374ca3d7191fbe4d5f351c7691181c8de157d5133c412b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-healthz.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    rack-healthz (0.1.0)
+      autoloaded
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    autoloaded (2.2.1)
+    rack (2.0.7)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rack
+  rack-healthz!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,35 @@
+# Rack::Healthz
+
+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/rack/healthz`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-healthz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-healthz
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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]/rack-healthz.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack/healthz"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,13 @@
+require 'rack/healthz'
+
+use Rack::Healthz
+
+app = Proc.new do |env|
+  if env["PATH_INFO"] == "/foo"
+    ['404', {'Content-Type' => 'text/html'}, ['A barebones rack app.']]
+  else
+    ['200', {'Content-Type' => 'text/html'}, ['A barebones rack app.']]
+  end
+end
+
+run app

data/lib/rack/healthz.rb

@@ -0,0 +1,86 @@
+require "rack/healthz/version"
+require 'autoloaded'
+require 'json'
+
+module Rack
+  class Healthz
+    Autoloaded.module {}
+    class Error < StandardError;
+    end
+
+    def initialize(app, stats_path: "/healthz", max_time_between_requests: 3600)
+      @app = app
+      @count = 0
+      @my_stats = {}
+      @up_at = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      @last_success_time = nil
+      @stats_path = stats_path
+      @max_time_between_requests = max_time_between_requests
+    end
+
+    def call(env)
+      if env.fetch("PATH_INFO") == @stats_path
+        now = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        [return_status(now), {'Content-Type' => 'application/json'}, [body_out(now)]]
+      else
+        @count += 1
+        start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        result = @app.call env
+        end_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        elapsed_time = end_time - start_time
+        response_code = result.first.to_i
+        request_category = response_code / 100
+        if !(@my_stats.key? request_category)
+          @my_stats[request_category] = RequestAccumulator.new
+        end
+        @my_stats[request_category] << elapsed_time
+        if response_code < 400
+          @last_success_time = end_time
+        end
+        result
+      end
+    end
+
+    def return_status(now)
+      if healthy?(now)
+        200
+      else
+        503
+      end
+    end
+
+    def status(now)
+      if healthy?(now)
+        "healthy"
+      else
+        "unhealthy"
+      end
+    end
+
+    def healthy?(now)
+      !time_since_last_success(now).nil? and (time_since_last_success(now) < @max_time_between_requests)
+    end
+
+    def time_since_last_success(now)
+      @last_success_time ? now - @last_success_time : nil
+    end
+
+    def uptime(now)
+      now - @up_at
+    end
+
+    def body_out(now)
+      result = {
+          'count' => @count,
+          'uptime' => uptime(now),
+          'time_since_last_success' => time_since_last_success(now),
+          'status' => status(now), # TODO
+          'stats' => {},
+      }
+      @my_stats.each_pair do |status_category, reqest_accumulator|
+        result['stats'][status_category.to_s + 'xx'] = reqest_accumulator.to_h
+      end
+      result.to_json
+    end
+  end
+end

data/lib/rack/healthz/request_accumulator.rb

@@ -0,0 +1,43 @@
+module Rack
+  class Healthz
+    class RequestAccumulator
+
+      attr_reader :min_time, :max_time, :count, :std, :mean
+
+      def initialize
+        @count = 0
+        @sum_of_times = 0.0
+        @sum_of_square_times = 0.0
+        @min_time = Float::INFINITY
+        @max_time = -Float::INFINITY
+      end
+
+      def <<(elapsed_time)
+        @count += 1
+        @sum_of_times += elapsed_time
+        @sum_of_square_times += elapsed_time ** 2
+        @min_time = [@min_time, elapsed_time].min
+        @max_time = [@max_time, elapsed_time].max
+        @mean = @sum_of_times / @count
+        @std = if @count > 1
+                 Math.sqrt((@sum_of_square_times / @count) - (@sum_of_times / @count) ** 2)
+               elsif @count == 1
+                 0.0
+               else
+                 nil
+               end
+        self
+      end
+
+      def to_h
+        {
+            'count' => count,
+            'min' => min_time,
+            'max' => max_time,
+            'mean' => mean,
+            'std' => std
+        }
+      end
+    end
+  end
+end

data/lib/rack/healthz/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Healthz
+    VERSION = "0.1.0"
+  end
+end

data/rack-healthz.gemspec

@@ -0,0 +1,43 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/healthz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-healthz"
+  spec.version       = Rack::Healthz::VERSION
+  spec.authors       = ["Andrew Eberbach", "Jon Kwinta"]
+  spec.email         = ["andrew@ebertech.ca", "jon@ebertech.ca"]
+
+  spec.summary       = %q{A health Endpoint}
+  spec.description   = %q{A health Endpoint}
+
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  #
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rack"
+
+  spec.add_runtime_dependency "autoloaded"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: rack-healthz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Eberbach
+- Jon Kwinta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  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'
+- !ruby/object:Gem::Dependency
+  name: autoloaded
+  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'
+description: A health Endpoint
+email:
+- andrew@ebertech.ca
+- jon@ebertech.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- lib/rack/healthz.rb
+- lib/rack/healthz/request_accumulator.rb
+- lib/rack/healthz/version.rb
+- rack-healthz.gemspec
+homepage: 
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2.1
+signing_key: 
+specification_version: 4
+summary: A health Endpoint
+test_files: []