litmus_paper 1.3.0 → 1.4.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjFkOWE0OWYyNzFhOGZmNTgyN2ZmZGI0YzNiZWJhN2I1OTNjNzAwYQ==
-  data.tar.gz: !binary |-
-    NzNlMDI0OTAwMzk3MDQ3YjQyYmQ1ZDNjODMwZDZkMTRiYmRmZTQ5NA==
+SHA1:
+  metadata.gz: 81d5bca1668f1457cd9c766f4e5213ea2867921d
+  data.tar.gz: d6c0158e8d8895dcd00e8af89183900a022613f4
 SHA512:
-  metadata.gz: !binary |-
-    NzQwZjVkNzA3NmNkZWE5YTM4NGM4ZmJkMmMzOGE5MzBmOWJmYWFiOTg2ZGMx
-    MjRmZTZlMzRjZDY1YTVkNTYxNjg1MDIzYzJjMWM4ZTRjYjJhYmUyYTZiNDdm
-    OTEwMGFlOWZlOGUyZjEyZjY4NmQ5NWZhMDBkOGQ1MDllMWFjMmI=
-  data.tar.gz: !binary |-
-    MTJkYmU2NzU0NDY2MmJiZDVhNWMyNzUzZDQyYmUzN2MwYWRlZjRiMmJlMzdj
-    MWE1ZWY0NzU5MTcwM2VhMjJhY2I3MDVkM2QzNWJhYjZhMmVjMWZiZDBiYTU2
-    NzJhMmE0NmFiNGVmMGIzOTk3YzdmZDQwMzc2OTcxZTE2Y2Q5YmM=
+  metadata.gz: 843f555781fd9e5c2c9f28289322a18e44bfef87bcb680c563f86f3745e1bd943a84ef99d61e053339469821c8dfed2a433a229ff388b61d2bef2dab7202966c
+  data.tar.gz: 4fa41594e74cf755f2e5119a68861c47c3503b5bd2d0bd6c50280df6bbc2fbfaf7c89bdd3ac09eda09e7f1b47ba1f3868c7078d0f471da18baec45b0ba0e2359

data/README.md

@@ -176,6 +176,11 @@ Here are all the types of checks currently implemented:
   * weight (0-100)
   * timeout (defaults to 5s)
 
+- `unix_socket_utilization` (`Metric::UnixSocketUtilitization`): Compares the number of active, queued requests against the maximum number of expected connections, [see](lib/litmus_paper/metric/unix_socket_utilization.rb) for the implementation of the algorithm.
+  * weight (0-100)
+  * socket_path (path on the filesystem where the socket is located)
+  * maxconn (maximum number of concurrent connection the server backing the socket is supposed to handle)
+
 - `big_brother_service` (`Metric::BigBrotherService`): Used in conjunction with [Big Brother](https://github.com/braintree/big_brother), reports health based on the overall health of another load balanced service.
   * service
 

data/lib/litmus_paper/metric/unix_socket_utilization.rb

@@ -0,0 +1,35 @@
+require 'raindrops'
+
+module LitmusPaper
+  module Metric
+    class UnixSocketUtilitization
+      def initialize(weight, socket_path, maxconn)
+        @weight = weight
+        @socket_path = socket_path
+        @maxconn = maxconn
+      end
+
+      def current_health
+        stats = _stats
+        if stats.queued == 0
+          return @weight
+        else
+          return [
+            @weight - (
+              (@weight * _stats.active.to_f) / (3 * @maxconn.to_f) +
+              (2 * @weight * _stats.queued.to_f) / (3 * @maxconn.to_f)
+            ), 1
+          ].max
+        end
+      end
+
+      def _stats
+        Raindrops::Linux.unix_listener_stats([@socket_path])[@socket_path]
+      end
+
+      def to_s
+        "Metric::UnixSocketUtilitization(weight: #{@weight}, maxconn: #{@maxconn}, path: #{@socket_path})"
+      end
+    end
+  end
+end

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "1.3.0"
+  VERSION = "1.4.1"
 end

data/lib/litmus_paper.rb

@@ -31,6 +31,7 @@ require 'litmus_paper/metric/cpu_load'
 require 'litmus_paper/metric/haproxy_backends_health'
 require 'litmus_paper/metric/internet_health'
 require 'litmus_paper/metric/script'
+require 'litmus_paper/metric/unix_socket_utilization'
 require 'litmus_paper/service'
 require 'litmus_paper/status_file'
 require 'litmus_paper/util'

data/litmus_paper.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency "remote_syslog_logger", "~> 1.0.3"
   gem.add_dependency "unicorn", "~> 4.6.2"
   gem.add_dependency "colorize"
+  gem.add_dependency "raindrops", "~> 0.19.0"
 
   gem.add_development_dependency "rspec", "~> 2.9.0"
   gem.add_development_dependency "rack-test", "~> 0.6.1"

data/spec/litmus_paper/metric/unix_socket_utilization_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe LitmusPaper::Metric::UnixSocketUtilitization do
+  describe "#current_health" do
+    it "returns supplied weight when there is no queued request" do
+      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 0, :active => 10}),
+      )
+      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+        100,
+        '/var/run/foo.sock',
+        10
+      ).current_health
+      health.should == 100
+    end
+
+    it "adjusts weight based on queued requests" do
+      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 7, :active => 10}),
+      )
+      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+        100,
+        '/var/run/foo.sock',
+        10
+      ).current_health
+      health.to_i.should == 20
+    end
+
+    it "sets weight to 1 when queued requests is more than maxconn" do
+      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 11, :active => 10}),
+      )
+      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+        100,
+        '/var/run/foo.sock',
+        10
+      ).current_health
+      health.should == 1
+    end
+  end
+end

metadata

@@ -1,125 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Braintreeps
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: remote_syslog_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 4.6.2
 - !ruby/object:Gem::Dependency
   name: colorize
   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: raindrops
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: rake_commit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
 description: Backend health tester for HA Services
@@ -132,10 +146,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rake_commit
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rake_commit"
+- ".ruby-version"
+- ".travis.yml"
 - Dockerfile
 - Gemfile
 - LICENSE
@@ -175,6 +189,7 @@ files:
 - lib/litmus_paper/metric/haproxy_backends_health.rb
 - lib/litmus_paper/metric/internet_health.rb
 - lib/litmus_paper/metric/script.rb
+- lib/litmus_paper/metric/unix_socket_utilization.rb
 - lib/litmus_paper/service.rb
 - lib/litmus_paper/status_file.rb
 - lib/litmus_paper/terminal_output.rb
@@ -201,6 +216,7 @@ files:
 - spec/litmus_paper/metric/haproxy_backends_health_spec.rb
 - spec/litmus_paper/metric/internet_health_spec.rb
 - spec/litmus_paper/metric/script_spec.rb
+- spec/litmus_paper/metric/unix_socket_utilization_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb
 - spec/litmus_paper_spec.rb
@@ -237,17 +253,17 @@ 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.6.14
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Backend health tester for HA Services, partner project of big_brother
@@ -270,6 +286,7 @@ test_files:
 - spec/litmus_paper/metric/haproxy_backends_health_spec.rb
 - spec/litmus_paper/metric/internet_health_spec.rb
 - spec/litmus_paper/metric/script_spec.rb
+- spec/litmus_paper/metric/unix_socket_utilization_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb
 - spec/litmus_paper_spec.rb