litmus_paper 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 9167b4c597e469bded0f8b14fad5fc3d1e13f1b75dc34026f2e864c6dc9d51f5
-  data.tar.gz: 577ae4f3475c9674549c8b4fa9c7a46566302e841b0596a331cd4990d25c13cb
+SHA1:
+  metadata.gz: 90d66e516c05b1928cca5f319524f41b6578b885
+  data.tar.gz: a6f9aed4e14be636749bfa4536bc295044481704
 SHA512:
-  metadata.gz: e24c3869e8c0b64809cd05f21f3039cc7427201dea6d5f8e9273b35aa9a3c2c9e75769ea2b91b6a178649fcf0fb17e29fd520f236aa314cf6e959e44f490d35e
-  data.tar.gz: abe0f3b37f24f939bdffe680515b69e870fe51f4fdadd17d3fc908b07260b302264a5c687551b626abdadff5dd1247605a94bcef7eb0a8993e23850fec589b52
+  metadata.gz: 18c970635472e70bb906be5f2be7fa126dcb6c134ca0a5a606239da7f25a0ec24f4aa6f0f36acf9cbdbff07dcdf66c04397e85b947d723e4f1561f3577fe03ef
+  data.tar.gz: 701a21b78fbd8b7e528e074bf1d18e8131b1f4d60a807d4c1fc781fc9afcab2efe3bcb3d9d4a1bf36c2aeeec77fae8d47c8e60bec6d12840b3ce307a180b778d

data/.travis.yml

@@ -2,9 +2,8 @@ before_install:
     - gem update bundler
 language: ruby
 rvm:
-- 1.9.3
-- 2.0.0
-- 2.2.3
+- 2.3
+- 2.5
 sudo: false
 notifications:
   email:

data/README.md

@@ -176,7 +176,12 @@ 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.
+- `tcp_socket_utilization` (`Metric::TcpSocketUtilization`): Compares the number of active, queued requests against the maximum number of expected connections, [see](lib/litmus_paper/metric/socket_utilization.rb) for the implementation of the algorithm.
+  * weight (0-100)
+  * address (IP:port combination, e.g. `0.0.0.0:8192`)
+  * maxconn (maximum number of concurrent connection the server backing the socket is supposed to handle)
+
+- `unix_socket_utilization` (`Metric::UnixSocketUtilization`): Compares the number of active, queued requests against the maximum number of expected connections, [see](lib/litmus_paper/metric/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)

data/lib/litmus_paper.rb

@@ -31,6 +31,8 @@ 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/socket_utilization'
+require 'litmus_paper/metric/tcp_socket_utilization'
 require 'litmus_paper/metric/unix_socket_utilization'
 require 'litmus_paper/service'
 require 'litmus_paper/status_file'

data/lib/litmus_paper/configuration_file.rb

@@ -84,6 +84,16 @@ module LitmusPaper
             domain_socket = dep_config.delete(:domain_socket)
             cluster = dep_config.delete(:cluster)
             Metric::HaproxyBackendsHealth.new(weight, domain_socket, cluster, check_config)
+          when :tcp_socket_utilization
+            weight = check_config.delete(:weight)
+            address = check_config.delete(:address)
+            maxconn = check_config.delete(:maxconn)
+            Metric::TcpSocketUtilization.new(weight, address, maxconn)
+          when :unix_socket_utilization
+            weight = check_config.delete(:weight)
+            socket_path = check_config.delete(:socket_path)
+            maxconn = check_config.delete(:maxconn)
+            Metric::UnixSocketUtilization.new(weight, socket_path, maxconn)
         end
       end
     end

data/lib/litmus_paper/metric/socket_utilization.rb

@@ -0,0 +1,48 @@
+require 'raindrops'
+
+module LitmusPaper
+  module Metric
+    class SocketUtilization
+      attr_reader :weight, :maxconn
+
+      def initialize(weight, maxconn)
+        @weight = weight
+        @maxconn = maxconn
+      end
+
+      def current_health
+        stats = _stats
+
+        if stats.queued == 0
+          return weight
+        end
+
+        [
+          weight - (
+            (weight * stats.active.to_f) / (3 * maxconn.to_f) +
+            (2 * weight * stats.queued.to_f) / (3 * maxconn.to_f)
+          ),
+          1
+        ].max
+      end
+
+      def stats
+        stats = _stats
+
+        {
+          :socket_active => stats.active,
+          :socket_queued => stats.queued,
+          :socket_utilization => ((stats.queued / maxconn.to_f) * 100).round,
+        }
+      end
+
+      def _stats
+        raise "Sub-classes must implement _stats"
+      end
+
+      def to_s
+        raise "Sub-classes must implement to_s"
+      end
+    end
+  end
+end

data/lib/litmus_paper/metric/tcp_socket_utilization.rb

@@ -0,0 +1,27 @@
+require 'raindrops'
+
+module LitmusPaper
+  module Metric
+    class TcpSocketUtilization < SocketUtilization
+      attr_reader :address
+
+      def initialize(weight, address, maxconn)
+        super(weight, maxconn)
+        @address = address
+      end
+
+      def _stats
+        Raindrops::Linux.tcp_listener_stats([address])[address]
+      end
+
+      def to_s
+        current_stats = stats
+        active = current_stats[:socket_active]
+        queued = current_stats[:socket_queued]
+        utilization = current_stats[:socket_utilization]
+
+        "Metric::TcpSocketUtilitization(weight: #{weight}, maxconn: #{maxconn}, active: #{active}, queued: #{queued}, utilization: #{utilization}, address: #{address})"
+      end
+    end
+  end
+end

data/lib/litmus_paper/metric/unix_socket_utilization.rb

@@ -2,46 +2,32 @@ require 'raindrops'
 
 module LitmusPaper
   module Metric
-    class UnixSocketUtilitization
+    class UnixSocketUtilization < SocketUtilization
+      attr_reader :socket_path
+
       def initialize(weight, socket_path, maxconn)
-        @weight = weight
+        super(weight, maxconn)
         @socket_path = socket_path
-        @maxconn = maxconn
-      end
-
-      def current_health
-        stats = _stats
-
-        if stats.queued == 0
-          return @weight
-        end
-
-        [
-          @weight - (
-            (@weight * stats.active.to_f) / (3 * @maxconn.to_f) +
-            (2 * @weight * stats.queued.to_f) / (3 * @maxconn.to_f)
-          ),
-          1
-        ].max
-      end
-
-      def stats
-        stats = _stats
-
-        {
-          :socket_active => stats.active,
-          :socket_queued => stats.queued,
-          :socket_utilization => ((stats.queued / @maxconn.to_f) * 100).round,
-        }
       end
 
       def _stats
-        Raindrops::Linux.unix_listener_stats([@socket_path])[@socket_path]
+        Raindrops::Linux.unix_listener_stats([socket_path])[socket_path]
       end
 
       def to_s
-        "Metric::UnixSocketUtilitization(weight: #{@weight}, maxconn: #{@maxconn}, active: #{@active.to_i}, queued: #{@queued.to_i}, path: #{@socket_path})"
+        current_stats = stats
+        active = current_stats[:socket_active]
+        queued = current_stats[:socket_queued]
+        utilization = current_stats[:socket_utilization]
+
+        "Metric::UnixSocketUtilization(weight: #{weight}, maxconn: #{maxconn}, active: #{active}, queued: #{queued}, utilization: #{utilization}, path: #{socket_path})"
       end
     end
+
+    def self.const_missing(const_name)
+      super unless const_name == :UnixSocketUtilitization
+      warn "`LitmusPaper::Metric::UnixSocketUtilitization` has been deprecated. Use `LitmusPaper::Metric::UnixSocketUtilization` instead."
+      UnixSocketUtilization
+    end
   end
 end

data/lib/litmus_paper/version.rb

@@ -1,3 +1,3 @@
 module LitmusPaper
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/litmus_paper.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Backend health tester for HA Services}
   gem.summary       = %q{Backend health tester for HA Services, partner project of big_brother}
   gem.homepage      = "https://github.com/braintree/litmus_paper"
+  gem.licenses      = ['MIT']
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/litmus_paper/app_spec.rb

@@ -461,14 +461,14 @@ describe LitmusPaper::App do
 
   describe "GET /:service/metrics" do
     it "returns the forced health value for a healthy service" do
-      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+      LitmusPaper::Metric::UnixSocketUtilization.any_instance.stub(
         :_stats => OpenStruct.new({:queued => 7, :active => 10}),
       )
       LitmusPaper::Metric::CPULoad.any_instance.stub(
         :load_average => 0.1
       )
       cpu_load = LitmusPaper::Metric::CPULoad.new(50)
-      socket_utilization = LitmusPaper::Metric::UnixSocketUtilitization.new(100, '/var/run/foo.sock', 10)
+      socket_utilization = LitmusPaper::Metric::UnixSocketUtilization.new(100, '/var/run/foo.sock', 10)
       internet_health = LitmusPaper::Metric::InternetHealth.new(100, [
         "127.0.0.1:3000",
         "127.0.0.1:3001",

data/spec/litmus_paper/metric/tcp_socket_utilization_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe LitmusPaper::Metric::TcpSocketUtilization do
+  describe "#current_health" do
+    it "returns supplied weight when there is no queued request" do
+      LitmusPaper::Metric::TcpSocketUtilization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 0, :active => 10}),
+      )
+      health = LitmusPaper::Metric::TcpSocketUtilization.new(
+        100,
+        '127.0.0.1:8123',
+        10
+      ).current_health
+      health.should == 100
+    end
+
+    it "adjusts weight based on queued requests" do
+      LitmusPaper::Metric::TcpSocketUtilization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 7, :active => 10}),
+      )
+      health = LitmusPaper::Metric::TcpSocketUtilization.new(
+        100,
+        '127.0.0.1:8123',
+        10
+      ).current_health
+      health.to_i.should == 20
+    end
+
+    it "sets weight to 1 when queued requests is more than maxconn" do
+      LitmusPaper::Metric::TcpSocketUtilization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 11, :active => 10}),
+      )
+      health = LitmusPaper::Metric::TcpSocketUtilization.new(
+        100,
+        '127.0.0.1:8123',
+        10
+      ).current_health
+      health.should == 1
+    end
+  end
+
+  describe "#stats" do
+    it "reports metrics" do
+      LitmusPaper::Metric::TcpSocketUtilization.any_instance.stub(
+        :_stats => OpenStruct.new({:queued => 7, :active => 10}),
+      )
+      metric = LitmusPaper::Metric::TcpSocketUtilization.new(
+        100,
+        '127.0.0.1:8123',
+        10
+      )
+      metric.stats.should == {
+        :socket_active => 10,
+        :socket_queued => 7,
+        :socket_utilization => 70,
+      }
+    end
+  end
+end

data/spec/litmus_paper/metric/unix_socket_utilization_spec.rb

@@ -1,12 +1,19 @@
 require 'spec_helper'
 
-describe LitmusPaper::Metric::UnixSocketUtilitization do
+describe LitmusPaper::Metric::UnixSocketUtilization do
+  describe "mispelled const compatibility is retained" do
+    it 'compatibility is retained' do
+      LitmusPaper::Metric::UnixSocketUtilitization.should ==
+        LitmusPaper::Metric::UnixSocketUtilization
+    end
+  end
+
   describe "#current_health" do
     it "returns supplied weight when there is no queued request" do
-      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+      LitmusPaper::Metric::UnixSocketUtilization.any_instance.stub(
         :_stats => OpenStruct.new({:queued => 0, :active => 10}),
       )
-      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+      health = LitmusPaper::Metric::UnixSocketUtilization.new(
         100,
         '/var/run/foo.sock',
         10
@@ -15,10 +22,10 @@ describe LitmusPaper::Metric::UnixSocketUtilitization do
     end
 
     it "adjusts weight based on queued requests" do
-      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+      LitmusPaper::Metric::UnixSocketUtilization.any_instance.stub(
         :_stats => OpenStruct.new({:queued => 7, :active => 10}),
       )
-      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+      health = LitmusPaper::Metric::UnixSocketUtilization.new(
         100,
         '/var/run/foo.sock',
         10
@@ -27,10 +34,10 @@ describe LitmusPaper::Metric::UnixSocketUtilitization do
     end
 
     it "sets weight to 1 when queued requests is more than maxconn" do
-      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+      LitmusPaper::Metric::UnixSocketUtilization.any_instance.stub(
         :_stats => OpenStruct.new({:queued => 11, :active => 10}),
       )
-      health = LitmusPaper::Metric::UnixSocketUtilitization.new(
+      health = LitmusPaper::Metric::UnixSocketUtilization.new(
         100,
         '/var/run/foo.sock',
         10
@@ -41,10 +48,10 @@ describe LitmusPaper::Metric::UnixSocketUtilitization do
 
   describe "#stats" do
     it "reports metrics" do
-      LitmusPaper::Metric::UnixSocketUtilitization.any_instance.stub(
+      LitmusPaper::Metric::UnixSocketUtilization.any_instance.stub(
         :_stats => OpenStruct.new({:queued => 7, :active => 10}),
       )
-      metric = LitmusPaper::Metric::UnixSocketUtilitization.new(
+      metric = LitmusPaper::Metric::UnixSocketUtilization.new(
         100,
         '/var/run/foo.sock',
         10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Braintreeps
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -189,6 +189,8 @@ 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/socket_utilization.rb
+- lib/litmus_paper/metric/tcp_socket_utilization.rb
 - lib/litmus_paper/metric/unix_socket_utilization.rb
 - lib/litmus_paper/service.rb
 - lib/litmus_paper/status_file.rb
@@ -216,6 +218,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/tcp_socket_utilization_spec.rb
 - spec/litmus_paper/metric/unix_socket_utilization_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb
@@ -245,7 +248,8 @@ files:
 - spec/support/test.reload.config
 - spec/support/test.unicorn.config
 homepage: https://github.com/braintree/litmus_paper
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -262,7 +266,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Backend health tester for HA Services, partner project of big_brother
@@ -285,6 +290,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/tcp_socket_utilization_spec.rb
 - spec/litmus_paper/metric/unix_socket_utilization_spec.rb
 - spec/litmus_paper/service_spec.rb
 - spec/litmus_paper/status_file_spec.rb