litmus_paper 1.2.0 → 1.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjFkOWE0OWYyNzFhOGZmNTgyN2ZmZGI0YzNiZWJhN2I1OTNjNzAwYQ==
+  data.tar.gz: !binary |-
+    NzNlMDI0OTAwMzk3MDQ3YjQyYmQ1ZDNjODMwZDZkMTRiYmRmZTQ5NA==
+SHA512:
+  metadata.gz: !binary |-
+    NzQwZjVkNzA3NmNkZWE5YTM4NGM4ZmJkMmMzOGE5MzBmOWJmYWFiOTg2ZGMx
+    MjRmZTZlMzRjZDY1YTVkNTYxNjg1MDIzYzJjMWM4ZTRjYjJhYmUyYTZiNDdm
+    OTEwMGFlOWZlOGUyZjEyZjY4NmQ5NWZhMDBkOGQ1MDllMWFjMmI=
+  data.tar.gz: !binary |-
+    MTJkYmU2NzU0NDY2MmJiZDVhNWMyNzUzZDQyYmUzN2MwYWRlZjRiMmJlMzdj
+    MWE1ZWY0NzU5MTcwM2VhMjJhY2I3MDVkM2QzNWJhYjZhMmVjMWZiZDBiYTU2
+    NzJhMmE0NmFiNGVmMGIzOTk3YzdmZDQwMzc2OTcxZTE2Y2Q5YmM=

data/README.md

@@ -179,6 +179,12 @@ Here are all the types of checks currently implemented:
 - `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
 
+- `haproxy_backends_health` (`Metric::HaproxyBackendsHealth`): Checks UP/DOWN status across a set of servers in a Haproxy cluster and computes a litmus weight based on the HAProxy weights of the servers which have an UP status.
+  * weight (0-100)
+  * haproxy socket
+  * cluster
+  * timeout (defaults to 2s)
+
 ### HAProxy agent check configuration
 
 Litmus paper can also report health checks in HAProxy agent check format. The agent check functionality takes the health data from a service health check, and exposes it on a different port in the format HAProxy expects.

data/lib/litmus_paper/configuration_file.rb

@@ -79,6 +79,11 @@ module LitmusPaper
             command = check_config.delete(:command)
             weight = check_config.delete(:weight)
             Metric::Script.new(command, weight, check_config)
+          when :haproxy_backends_health
+            weight = check_config.delete(:weight)
+            domain_socket = dep_config.delete(:domain_socket)
+            cluster = dep_config.delete(:cluster)
+            Metric::HaproxyBackendsHealth.new(weight, domain_socket, cluster, check_config)
         end
       end
     end

data/lib/litmus_paper/dependency/haproxy_backends.rb

@@ -1,8 +1,10 @@
-require 'csv'
+require 'litmus_paper/haproxy_util'
 
 module LitmusPaper
   module Dependency
     class HaproxyBackends
+      include LitmusPaper::HaproxyUtil
+
       def initialize(domain_socket, cluster, options = {})
         @domain_socket = domain_socket
         @cluster = cluster
@@ -10,8 +12,7 @@ module LitmusPaper
       end
 
       def available?
-        stats = _parse_stats(_fetch_stats)
-        backend = _find_backend(stats, @cluster)
+        backend = find_backend(@domain_socket, @timeout, @cluster)
 
         if backend['weight'].to_i == 0
           LitmusPaper.logger.info(
@@ -31,27 +32,6 @@ module LitmusPaper
       def to_s
         "Dependency::HaproxyBackends(#{@domain_socket}, #{@cluster})"
       end
-
-      def _find_backend(stats, cluster)
-        stats.detect do |line|
-          line['# pxname'] == cluster && line['svname'] == 'BACKEND'
-        end
-      end
-
-      def _parse_stats(csv)
-        stats = CSV.parse(csv)
-        headers = stats.shift
-        stats.map { |stat| Hash[headers.zip(stat)] }
-      end
-
-      def _fetch_stats
-        Timeout.timeout(@timeout) do
-          UNIXSocket.open(@domain_socket) do |socket|
-            socket.send("show stat\n", 0)
-            socket.read
-          end
-        end
-      end
     end
   end
 end

data/lib/litmus_paper/haproxy_util.rb

@@ -0,0 +1,39 @@
+require 'csv'
+
+module LitmusPaper
+  module HaproxyUtil
+    def find_servers(socket, timeout, cluster)
+      stats = _get_stats(socket, timeout)
+      stats.select do |line|
+        line['# pxname'] == cluster && line['svname'] !~ /BACKEND|FRONTEND/
+      end
+    end
+
+    def find_backend(socket, timeout, cluster)
+      stats = _get_stats(socket, timeout)
+      stats.detect do |line|
+        line['# pxname'] == cluster && line['svname'] == 'BACKEND'
+      end
+    end
+
+    def _get_stats(socket, timeout)
+      _parse_stats(_fetch_stats(socket, timeout))
+    end
+
+    def _fetch_stats(socket, timeout)
+      Timeout.timeout(timeout) do
+        UNIXSocket.open(socket) do |socket|
+          socket.send("show stat\n", 0)
+          socket.read
+        end
+      end
+    end
+
+    def _parse_stats(csv)
+      stats = CSV.parse(csv)
+      headers = stats.shift
+      stats.map { |stat| Hash[headers.zip(stat)] }
+    end
+  end
+end
+

data/lib/litmus_paper/metric/haproxy_backends_health.rb

@@ -0,0 +1,33 @@
+require 'litmus_paper/haproxy_util'
+
+module LitmusPaper
+  module Metric
+    class HaproxyBackendsHealth
+      include LitmusPaper::HaproxyUtil
+
+      def initialize(weight, domain_socket, cluster, options = {})
+        @weight = weight
+        @domain_socket = domain_socket
+        @cluster = cluster
+        @timeout = options.fetch(:timeout_seconds, 2)
+      end
+
+      def current_health
+        servers = find_servers(@domain_socket, @timeout, @cluster)
+
+        up_weight = servers
+          .select { |server| server["status"] == "UP" }
+          .inject(0) { |sum, server| sum + server["weight"].to_f }
+
+        total_weight = servers
+          .inject(0) { |sum, server| sum + server["weight"].to_f }
+
+        ((up_weight / total_weight) * @weight).to_i
+      end
+
+      def to_s
+        "Metric::HaproxyBackendsHealth(#{@weight}, #{@cluster})"
+      end
+    end
+  end
+end

data/lib/litmus_paper/version.rb

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

data/lib/litmus_paper.rb

@@ -22,11 +22,13 @@ require 'litmus_paper/dependency/haproxy_backends'
 require 'litmus_paper/dependency/http'
 require 'litmus_paper/dependency/script'
 require 'litmus_paper/dependency/tcp'
+require 'litmus_paper/haproxy_util'
 require 'litmus_paper/health'
 require 'litmus_paper/logger'
 require 'litmus_paper/metric/big_brother_service'
 require 'litmus_paper/metric/constant_metric'
 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/service'

data/spec/litmus_paper/agent_check_server_spec.rb

@@ -11,7 +11,7 @@ describe LitmusPaper::AgentCheckServer do
     port_open = false
     while ! port_open do
       begin
-        TCPSocket.new('localhost', 9191)
+        TCPSocket.new('127.0.0.1', 9191)
       rescue StandardError => e
         sleep 0.1
         next
@@ -26,12 +26,12 @@ describe LitmusPaper::AgentCheckServer do
 
   describe "The agent-check text protocol" do
     it "returns the health from a passing test" do
-      TCPSocket.open('localhost', 9191) do |s|
+      TCPSocket.open('127.0.0.1', 9191) do |s|
         s.gets.should match(/ready\tup\t\d+%\r\n/)
       end
     end
     it "returns the health from a failing test" do
-      TCPSocket.open('localhost', 9192) do |s|
+      TCPSocket.open('127.0.0.1', 9192) do |s|
         s.gets.should match(/down\t0%\r\n/)
       end
     end

data/spec/litmus_paper/metric/haproxy_backends_health_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe LitmusPaper::Metric::HaproxyBackendsHealth do
+  describe "#current_health" do
+    before(:each) do
+      FileUtils.rm_rf("/tmp/stub-haproxy-stats")
+      system "spec/support/haproxy_test_socket /tmp/stub-haproxy-stats &"
+      sleep 1
+    end
+
+    it "should report as 33 if 2/3 of the nodes are down (yellow cluster)" do
+      health = LitmusPaper::Metric::HaproxyBackendsHealth.new(100, "/tmp/stub-haproxy-stats", "yellow_cluster")
+      health.current_health.should == 33
+    end
+
+
+    it "should report as 0 if all of the nodes are down (orange cluster)" do
+      health = LitmusPaper::Metric::HaproxyBackendsHealth.new(100, "/tmp/stub-haproxy-stats", "orange_cluster")
+      health.current_health.should == 0
+    end
+
+    it "should report as 100 if all of the nodes are up (green cluster)" do
+      health = LitmusPaper::Metric::HaproxyBackendsHealth.new(100, "/tmp/stub-haproxy-stats", "green_cluster")
+      health.current_health.should == 100
+    end
+
+    it "uses weight in calculating the health (yellow)" do
+      health = LitmusPaper::Metric::HaproxyBackendsHealth.new(50, "/tmp/stub-haproxy-stats", "yellow_cluster")
+      health.current_health.should == 16
+    end
+  end
+
+  describe "#to_s" do
+    it "is the name of the class and the cluster name " do
+      metric = LitmusPaper::Metric::HaproxyBackendsHealth.new(100, "/tmp/stub-haproxy-stats", "green_cluster")
+      metric.to_s.should == "Metric::HaproxyBackendsHealth(100, green_cluster)"
+    end
+  end
+end

data/spec/litmus_paper/metric/internet_health_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe LitmusPaper::Dependency::TCP do
+describe LitmusPaper::Metric::InternetHealth do
 
   describe "#current_health" do
     before(:all) do
@@ -85,11 +85,11 @@ describe LitmusPaper::Dependency::TCP do
       internet_health = LitmusPaper::Metric::InternetHealth.new(
         100,
         [
-          "127.0.0.1:6000",
-          "127.0.0.1:6001",
           "127.0.0.1:6002",
           "127.0.0.1:6003",
           "127.0.0.1:6004",
+          "127.0.0.1:6005",
+          "127.0.0.1:6006",
         ],
       )
       internet_health.current_health.should == 0

data/spec/support/haproxy_test_socket

@@ -25,6 +25,10 @@ orange,FRONTEND,,,0,0,2000,0,0,0,0,0,0,,,,,OPEN,,,,,,,,,1,5,0,,,,0,0,0,0,,,,,,,,
 orange_cluster,orange1,0,0,0,0,,0,0,0,,0,,0,0,0,0,DOWN,1,1,0,0,0,35,0,,1,6,1,,0,,2,0,,0,L4OK,,5,,,,,,,0,,,,0,0,
 orange_cluster,orange2,0,0,0,0,,0,0,0,,0,,0,0,0,0,DOWN,1,1,0,0,0,35,0,,1,6,1,,0,,2,0,,0,L4OK,,5,,,,,,,0,,,,0,0,
 orange_cluster,BACKEND,0,0,0,0,0,0,0,0,0,0,,0,0,0,0,DOWN,0,0,0,,0,35,0,,1,6,0,,0,,1,0,,0,,,,,,,,,,,,,,0,0,
+green,FRONTEND,,,0,0,2000,0,0,0,0,0,0,,,,,OPEN,,,,,,,,,1,5,0,,,,0,0,0,0,,,,,,,,,,,0,0,0,,,
+green_cluster,orange1,0,0,0,0,,0,0,0,,0,,0,0,0,0,UP,1,1,0,0,0,35,0,,1,6,1,,0,,2,0,,0,L4OK,,5,,,,,,,0,,,,0,0,
+green_cluster,orange2,0,0,0,0,,0,0,0,,0,,0,0,0,0,UP,1,1,0,0,0,35,0,,1,6,1,,0,,2,0,,0,L4OK,,5,,,,,,,0,,,,0,0,
+green_cluster,BACKEND,0,0,0,0,0,0,0,0,0,0,,0,0,0,0,UP,0,0,0,,0,35,0,,1,6,0,,0,,1,0,,0,,,,,,,,,,,,,,0,0,
 DATA
       socket.close
     rescue Errno::EPIPE

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: litmus_paper
 version: !ruby/object:Gem::Version
-  version: 1.2.0
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Braintreeps
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-24 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: remote_syslog_logger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake_commit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -183,11 +166,13 @@ files:
 - lib/litmus_paper/dependency/http.rb
 - lib/litmus_paper/dependency/script.rb
 - lib/litmus_paper/dependency/tcp.rb
+- lib/litmus_paper/haproxy_util.rb
 - lib/litmus_paper/health.rb
 - lib/litmus_paper/logger.rb
 - lib/litmus_paper/metric/big_brother_service.rb
 - lib/litmus_paper/metric/constant_metric.rb
 - lib/litmus_paper/metric/cpu_load.rb
+- lib/litmus_paper/metric/haproxy_backends_health.rb
 - lib/litmus_paper/metric/internet_health.rb
 - lib/litmus_paper/metric/script.rb
 - lib/litmus_paper/service.rb
@@ -213,6 +198,7 @@ files:
 - spec/litmus_paper/metric/big_brother_service_spec.rb
 - spec/litmus_paper/metric/constant_metric_spec.rb
 - spec/litmus_paper/metric/cpu_load_spec.rb
+- 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/service_spec.rb
@@ -244,27 +230,26 @@ files:
 - spec/support/test.unicorn.config
 homepage: https://github.com/braintree/litmus_paper
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.6.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Backend health tester for HA Services, partner project of big_brother
 test_files:
 - spec/litmus_paper/agent_check_handler_spec.rb
@@ -282,6 +267,7 @@ test_files:
 - spec/litmus_paper/metric/big_brother_service_spec.rb
 - spec/litmus_paper/metric/constant_metric_spec.rb
 - spec/litmus_paper/metric/cpu_load_spec.rb
+- 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/service_spec.rb