consul-templaterb 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8adb29eaa4b01d73d82d80cf9183f6761e06db0a3204a1a6959a41597b5475f
-  data.tar.gz: 6ac7f61796835fb9663e9f6de39f8047a192e8e8f20b07b438a0865bd82ce8a0
+  metadata.gz: a08b64a111c5cf2ceeca1568dbd94d7c5e60bcc31b4cd72aa6277324d79a6bc5
+  data.tar.gz: da25a0959dce3230625c495c219f9617044481d362bd9b05e0949f908f6e73a8
 SHA512:
-  metadata.gz: 05f0d978f9b90a5c855c6e7aee93719fef0104c530a0faa80a03232ab20e6c2945ecb9c769ab75e3f9f14f629489cfc10fa42e4fc7704b967e964fa32882bad4
-  data.tar.gz: 35f472ccf9e47b07a0d1da65ab7259ab5ae49ea917418c0f9d2edae98cada88737fa294ca4bf38044a0e6d971ab4e6bf237e2c24d13da2cc2799f3927fc9465c
+  metadata.gz: 95771fbfe7302884d595d819e95aa408f09a1f63e3fe8d3ecb457d09541b07605d6eb32dcb00f4502f3340b8a4703fcbfbcc30a79ce7a71da4ac5f25c47bfab5
+  data.tar.gz: 1ccf48e196c9c50d59f7e432a8b29b06b097422b1771b7adfab29e2e722c97da8ef0a1119ea780ce72ebb3ade169d327096616bff5c85b452affd98c1cc67ac9

data/.rubocop.yml

@@ -7,7 +7,7 @@ Metrics/AbcSize:
   Max: 80
 
 Metrics/BlockLength:
-  Max: 135
+  Max: 140
 
 Metrics/BlockNesting:
   Max: 4

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## (UNRELEASED)
 
+## 1.6.0 (November 23, 2018)
+
+BUG FIXES:
+
+ * Fixed rendering of favorites on Firefox in consul-ui
+
+NEW FEATURES:
+
+ * Added the following helpers to help dealing with new Consul features and simplify writting templates in results
+   of `service()` calls:
+     * `status` to compute aggregated status of a service taking into account all checks
+     * `weights` to deal with weights added in Consul 1.2.3
+     * `current_weight` to deal with weight computed using the current status
+
 ## 1.5.9 (November 17, 2018)
 
 BUG FIXES:

data/TemplateAPI.md

@@ -114,9 +114,32 @@ Full example: [samples/consul_template.txt.erb](samples/consul_template.txt.erb)
 optional tag. If no tag is specified, will return all instances of service. By default, it will return all the
 services that are passing or not. An optional argument passing might be used to retrieve only passing instances.
 
+### Helpers
+
+#### service_address
+
 This object also contains a Helper to get easily the correct Address by using `service_address` which returns
 the optional `['Service']['Address']` if found or `['Node']['Address']` otherwise.
 
+#### status
+
+Computing the status of an instance is non-trivial as it requires to parses all statuses of all checks and take
+the worse of all thoses Status object. The `.status` attribute can be used as an alternative as it precomputes
+this state in the same way consul does, it will then return the worse of all the statuses of all checks.
+Returned value will be one of `passing`|`warning`|`critical`.
+
+#### weights
+
+`.weights` give the ability to deal with new `Weights` feature added in Consul 1.2.3.
+It returns a Hash with `{"Passing": weight_when_service_is_passing, "Warning": weight_when_value_is_warning}`
+to allow having weighted load balancing when statuses in Consul do change. It also deals nicely with versions
+of Consul not yet supporting Weights.
+
+#### current_weight
+
+`.current_weight` computes automagically weight given the current status of service. It works the same way as
+the DNS implementation of Consul.
+
 <details><summary>Examples</summary>
 <div class="samples">
 
@@ -129,7 +152,7 @@ the optional `['Service']['Address']` if found or `['Node']['Address']` otherwis
 <%     service(service_name, tag:'http').sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
 %>  * <%= service_name %> -> <%=
   snode['Node']['Node'] %>:<%= snode['Service']['Port'] %>  <%=
-  snode['Service']['Tags'] %> status: <%
+  snode['Service']['Tags'] %> status: <%= snode.status %> Current Weight: <%= snode.current_weight %> Checks: <%
   snode['Checks'].each do |c| %> <%= c['Status']
   %><% end if snode['Checks'] %>
 <%     end

data/bin/consul-templaterb

@@ -51,6 +51,7 @@ options = {
     max_retry_duration: 600, # On consecutive errors, delay will increase, max value
     missing_index_retry_time_on_diff: 15, # On endpoints without X-Consul-Index => next request
     missing_index_retry_time_on_unchanged: 60, # Endpoints with X-Consul index and no diff
+    enable_gzip_compression: true,
     paths: {
       '/v1/catalog/services': {
         min_duration: 30,    # Since services change a lot, refresh services every 30 seconds
@@ -88,6 +89,10 @@ optparse = OptionParser.new do |opts|
     exit 0
   end
 
+  opts.on('-g', '--no-gzip-compression', 'Disable GZIP compression in HTTP requests') do
+    options[:consul][:enable_gzip_compression] = false
+  end
+
   opts.on('-c', '--consul-addr=<address>', String, 'Address of Consul, eg: http://localhost:8500') do |consul_url|
     options[:consul][:base_url] = consul_url
   end

data/lib/consul/async/consul_endpoint.rb

@@ -7,7 +7,7 @@ module Consul
   module Async
     class ConsulConfiguration
       attr_reader :base_url, :token, :retry_duration, :min_duration, :wait_duration, :max_retry_duration, :retry_on_non_diff,
-                  :missing_index_retry_time_on_diff, :missing_index_retry_time_on_unchanged, :debug
+                  :missing_index_retry_time_on_diff, :missing_index_retry_time_on_unchanged, :debug, :enable_gzip_compression
       def initialize(base_url: 'http://localhost:8500',
                      debug: { network: false },
                      token: nil,
@@ -18,10 +18,12 @@ module Consul
                      max_retry_duration: 600,
                      missing_index_retry_time_on_diff: 15,
                      missing_index_retry_time_on_unchanged: 60,
+                     enable_gzip_compression: true,
                      paths: {})
         @base_url = base_url
         @token = token
         @debug = debug
+        @enable_gzip_compression = enable_gzip_compression
         @retry_duration = retry_duration
         @min_duration = min_duration
         @wait_duration = wait_duration
@@ -54,6 +56,7 @@ module Consul
                                 max_retry_duration: ch(path, :max_retry_duration),
                                 missing_index_retry_time_on_diff: ch(path, :missing_index_retry_time_on_diff),
                                 missing_index_retry_time_on_unchanged: ch(path, :missing_index_retry_time_on_unchanged),
+                                enable_gzip_compression: enable_gzip_compression,
                                 paths: @paths)
       end
     end
@@ -171,6 +174,7 @@ module Consul
           keepalive: true,
           callback: method(:on_response)
         }
+        res[:head]['accept-encoding'] = 'identity' unless conf.enable_gzip_compression
         @query_params.each_pair do |k, v|
           res[:query][k] = v
         end

data/lib/consul/async/consul_template.rb

@@ -310,6 +310,33 @@ module Consul
         val = self['Node']['Address'] unless !val.nil? && val != ''
         val
       end
+
+      # Return the global state of a Service, will return passing|warning|critical
+      def status
+        ret = 'passing'
+        checks = self['Checks']
+        return ret unless checks
+        checks.each do |chk|
+          st = chk['Status']
+          if st == 'critical'
+            ret = st
+          elsif st == 'warning' && ret == 'passing'
+            ret = st
+          end
+        end
+        ret
+      end
+
+      # Return Consul weights even if Consul version < 1.2.3 with same semantics
+      def weights
+        self['Service']['Weights'] || { 'Passing' => 1, 'Warning' => 1 }
+      end
+
+      # Return the weights applied on instance according to current status
+      def current_weight
+        current_status = status
+        weights[current_status.capitalize] || 0
+      end
     end
 
     class ConsulTemplateService < ConsulTemplateAbstractMap

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.5.9'.freeze
+    VERSION = '1.6.0'.freeze
   end
 end

data/samples/consul-ui/consul_services.json.erb

@@ -12,20 +12,7 @@
 
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
-  # Compute the health of a Service
-  def compute_state(snode)
-    states = ['passing', []]
-    snode['Checks'].each do |chk|
-      st = chk['Status']
-      states[1] << st
-      if st == 'critical'
-        states[0] = st
-      elsif st == 'warning' && states[0] == 'passing'
-        states[0] = st
-      end
-    end
-    states
-  end
+
   def compute_attributes(snode)
     w = 100
     snode['Service']['Tags'].each do |tag|
@@ -33,9 +20,9 @@
       w = match[1].to_i if match
     end
     attributes = ""
-    states = compute_state(snode)
-    attributes = "#{attributes} disabled" if states[0] == 'critical'
-    if states[0] == 'warning'
+    node_status = snode.status
+    attributes = "#{attributes} disabled" if node_status == 'critical'
+    if node_status == 'warning'
       w = w / 8
     end
     attributes = "#{attributes} weight #{w}" if w.positive?

data/samples/consul_template.json.erb

@@ -13,19 +13,6 @@
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
   # Compute the health of a Service
-  def compute_state(snode)
-    states = ['passing', []]
-    snode['Checks'].each do |chk|
-      st = chk['Status']
-      states[1] << st
-      if st == 'critical'
-        states[0] = st
-      elsif st == 'warning' && states[0] == 'passing'
-        states[0] = st
-      end
-    end
-    states
-  end
   def compute_attributes(snode)
     w = 100
     snode['Service']['Tags'].each do |tag|
@@ -33,9 +20,9 @@
       w = match[1].to_i if match
     end
     attributes = ""
-    states = compute_state(snode)
-    attributes = "#{attributes} disabled" if states[0] == 'critical'
-    if states[0] == 'warning'
+    node_status = snode.status
+    attributes = "#{attributes} disabled" if node_status == 'critical'
+    if node_status == 'warning'
       w = w / 8
     end
     attributes = "#{attributes} weight #{w}" if w.positive?

data/samples/criteo/haproxy.cfg.erb

@@ -20,26 +20,17 @@
 
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
-  # Compute the health of a Service
-  def compute_state(node)
-    states = ['passing', []]
-    node['Checks'].each do |chk|
-      st = chk['Status']
-      states[1] << st
-      states[0] = st if st == 'critical' || (st == 'warning' && states[0] == 'passing')
-    end
-    states
-  end
+
   def compute_attributes(node)
-    w = 100
+    w = node.currrent_weight
     node['Service']['Tags'].each do |tag|
       match = /^weight-([1-9][0-9])*$/.match(tag)
       w = match[1].to_i if match
     end
     attributes = ""
-    states = compute_state(node)
-    attributes = "#{attributes} disabled" if states[0] == 'critical'
-    if states[0] == 'warning'
+    node_status = snode.status
+    attributes = "#{attributes} disabled" if node_status == 'critical'
+    if node_status == 'warning'
       w = w / 8
     end
     attributes = "#{attributes} weight #{w}" if w.positive?

data/samples/ha_proxy.cfg.erb

@@ -18,30 +18,17 @@
 
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || 'consul-agent-http,mesos-slave,mesos-agent-watcher,mesos-exporter-slave').split(',')
-  # Compute the health of a Service
-  def compute_state(node)
-    states = ['passing', []]
-    node['Checks'].each do |chk|
-      st = chk['Status']
-      states[1] << st
-      if st == 'critical'
-        states[0] = st
-      elsif st == 'warning' && states[0] == 'passing'
-        states[0] = st
-      end
-    end
-    states
-  end
-  def compute_attributes(node)
+
+  def compute_attributes(snode)
     w = 100
-    node['Service']['Tags'].each do |tag|
+    snode['Service']['Tags'].each do |tag|
       match = /^weight-([1-9][0-9])*$/.match(tag)
       w = match[1].to_i if match
     end
     attributes = ""
-    states = compute_state(node)
-    attributes = "#{attributes} disabled" if states[0] == 'critical'
-    if states[0] == 'warning'
+    node_status = snode.status
+    attributes = "#{attributes} disabled" if node_status == 'critical'
+    if node_status == 'warning'
       w = w / 8
     end
     attributes = "#{attributes} weight #{w}" if w.positive?

data/samples/metrics.erb

@@ -13,20 +13,6 @@
 
   # Services to hide
   services_blacklist = (ENV['EXCLUDE_SERVICES'] || '').split(',')
-  # Compute the health of a Service
-  def compute_state(snode)
-    states = ['passing', []]
-    snode['Checks'].each do |chk|
-      st = chk['Status']
-      states[1] << st
-      if st == 'critical'
-        states[0] = st
-      elsif st == 'warning' && states[0] == 'passing'
-        states[0] = st
-      end
-    end
-    states
-  end
   backends = {}
   service_count = 0
   services(tag: service_tag_filter).each do |service_name, tags|
@@ -38,7 +24,7 @@
         'critical' => 0,
       }
       service(service_name).each do |snode|
-        state = compute_state(snode)[0]
+        state = node.status
         res[state] += 1
       end
       backends[service_name] = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -227,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Implementation of Consul template using Ruby and .erb templating language