consul-templaterb 1.9.2 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59bf13c2279da7eb5ba1955ca645420d91033cfb8d608a5a881824bf5492d6ed
-  data.tar.gz: a042648698f120b575308868d60e4dc92dbe47163f5f5c59a7ddd21f7194dac3
+  metadata.gz: 5782528a3540e33076a9db4244d558f9e62d846b68f7aa57cb625dbc2cca7415
+  data.tar.gz: c3d33c3bb5f760f1b0108807213e8d59aceca92cce6eccb67c32ff759010ece8
 SHA512:
-  metadata.gz: 978c146a7bd5f11f5bc3de56e0952c465f0011a24201e3a61268b27a34c4ba641e6f2841bb43911d8a1288c5854147164ed0468dbe3c0f4009e279e8addd724f
-  data.tar.gz: 63989a0b6cfded326d6ede9698163f68cfab2bda46c12a403814f45c89d49fb679d434c7a769581463fdd6d21f3325fb8910a8fcc279c3dd68bca5d846f659d0
+  metadata.gz: 02cb21ad2703bfd0a847181c4b4d0b5bd4a96503130e949db99498461dee4e1744e35b406a056ddcd2023eacc6aac3463e51b33685748a8733dd02fa57852efd
+  data.tar.gz: 19015ff464cdeb7ee09b04471d78562b415b02878349c2d9c5bd96acac758276759efdff2132000558b96d3003ac473d29369c47090189fc29cf16178918e3d6

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## (UNRELEASED)
 
+## 1.9.3 (January 9, 2019)
+
+IMPROVEMENTS:
+
+ * Perform some randomization on retries, so in case of massive errors,
+   system will likely re-open all connections at the same time.
+ * consul-timeline more optimize ringbuffer for larger history
+ * UI improvements (tooltips for services/checks)
+
 ## 1.9.2 (January 4, 2019)
 
 IMPROVEMENTS:

data/lib/consul/async/consul_endpoint.rb

@@ -137,7 +137,7 @@ module Consul
           "[#{stats.body_bytes_human.ljust(8)}][#{stats.bytes_per_sec_human.ljust(9)}]"\
           " #{path.ljust(48)} idx:#{result.x_consul_index}, next in #{result.retry_in} s"
         end
-        on_error { |http| STDERR.puts "[ERROR]: #{path}: #{http.error}" }
+        on_error { |http| STDERR.puts "[ERROR]: #{path}: #{http.error.inspect}" }
       end
 
       def on_response(&block)
@@ -185,8 +185,12 @@ module Consul
         http.response_header['X-Consul-Index']
       end
 
+      def _compute_retry_in(retry_in)
+        retry_in / 2 + Consul::Async::Utilities.random.rand(retry_in)
+      end
+
       def _handle_error(http, consul_index)
-        retry_in = [600, conf.retry_duration + 2**@consecutive_errors].min
+        retry_in = _compute_retry_in([600, conf.retry_duration + 2**@consecutive_errors].min)
         STDERR.puts "[ERROR][#{path}] X-Consul-Index:#{consul_index} - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
         @consecutive_errors += 1
         http_result = HttpResponse.new(http)
@@ -227,6 +231,7 @@ module Consul
               else
                 retry_in = modified ? conf.min_duration : conf.retry_on_non_diff
               end
+              retry_in = _compute_retry_in(retry_in)
               retry_in = 0.1 if retry_in < 0.1
               unless @stopping
                 EventMachine.add_timer(retry_in) do

data/lib/consul/async/utilities.rb

@@ -33,6 +33,11 @@ module Consul
           raise "Don't know how to load parameters file #{parameters_file}: JSON and YAML supported"
         end
       end
+
+      def self.random
+        @random = Random.new unless @random
+        @random
+      end
     end
   end
 end

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.9.2'.freeze
+    VERSION = '1.9.3'.freeze
   end
 end

data/samples/consul-ui/common/header.html.erb

@@ -31,6 +31,7 @@
     <meta name="description" content="Display Consul information"/>
     <meta name="author" content="Criteo"/>
     <title><%= param('title', 'Consul Real Time information') %></title>
+    <link rel="icon" type="image/png" href="images/favicon.png" sizes="32x32" />
     <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
     <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.11/css/all.css" integrity="sha384-p2jx59pefphTFIpeqCcISO9MdVfIm4pNnsL08A6v5vaQc4owkQqxMV8kg4Yvhaw/" crossorigin="anonymous">
     <link rel="stylesheet" href="css/style.css">

data/samples/consul-ui/js/service.js

@@ -251,7 +251,7 @@ class ConsulService {
       serviceHtml.appendChild(tagsGenerator(instance.tags));
       serviceHtml.appendChild(serviceMetaGenerator(instance.sMeta));
       serviceHtml.appendChild(connectGenerator(instance))
-      serviceHtml.appendChild(checksStatusGenerator(instance.checks));
+      serviceHtml.appendChild(checksStatusGenerator(instance));
       serviceHtml.setAttribute('status', state);
       $("#instances-list").append(serviceHtml);
     }

data/samples/consul-ui/js/timeline.js

@@ -457,7 +457,7 @@ class ServiceTimeline {
                         var checkName = document.createElement('div');
                         checkName.setAttribute('class', 'lookup checkName');
                         checkName.setAttribute('data-toggle', 'tooltip');
-                        checkName.setAttribute('title', c['id']+'\n\n' + c.output);
+                        checkName.setAttribute('title', 'ID: ' + c['id'] + '\nName: ' + c['name'] + '\n\n' + c.output);
                         checkName.appendChild(document.createTextNode(c['name']));
                         checksCell.appendChild(checkName);
                     }

data/samples/consul-ui/js/utils.js

@@ -52,6 +52,10 @@ function serviceTitleGenerator(instance) {
   }
 
   var htmlTitle = document.createElement('h5');
+  htmlTitle.setAttribute('title', 'Node Name: ' + instance.name +
+                                  '\nAddress : ' + instance.addr +
+                                  '\nService ID: ' + instance.id +
+                                  '\nService Port : ' + instance.port);
 
   var instanceLink = document.createElement('a');
   instanceLink.setAttribute('class',  'instance-name');
@@ -223,14 +227,16 @@ function servicesGenerator(instanceServices) {
   return services;
 }
 
-function checksStatusGenerator(instanceChecks) {
+function checksStatusGenerator(instance) {
+  var instanceChecks = instance.checks;
   var checks = document.createElement('div');
   checks.className = 'checks';
   checks.appendChild(document.createTextNode("Checks: "));
   checks.appendChild(document.createElement('br'));
 
   for (var checkKey in instanceChecks) {
-    checkId = Math.floor(Math.random()*10000);
+    var checkInstance = instanceChecks[checkKey];
+    var checkId = instance.name + '::' + checkInstance.checkid;
     var btn = 'btn-' + toCSSClass(instanceChecks[checkKey]['status'])
     var check = document.createElement('div');
 
@@ -240,6 +246,7 @@ function checksStatusGenerator(instanceChecks) {
     btnCheck.setAttribute('data-toggle', 'collapse');
     btnCheck.setAttribute('data-target', '#' + checkId);
     btnCheck.setAttribute('aria-expanded', 'false');
+    btnCheck.setAttribute('title', checkInstance.checkid);
 
     btnCheck.appendChild(document.createTextNode(instanceChecks[checkKey]['name']));
 

data/samples/consul-ui/ringbuffer.rb

@@ -0,0 +1,107 @@
+module ConsulTimeline
+  class RingBufferNode
+    attr_reader :prev, :value, :next
+    attr_writer :prev, :next, :value
+    def initialize(value, p_elem, n_elem)
+      @value = value
+      @prev = p_elem
+      @next = n_elem
+    end
+
+    # Insert element before current element, return inserted Node
+    def insert_before(obj)
+      old_prev = @prev
+      @prev = RingBufferNode.new(obj, old_prev, self)
+      old_prev&.next = @prev
+      @prev
+    end
+
+    # Append element after current ince, return inserted Node
+    def append(obj)
+      old_next = @next
+      @next = RingBufferNode.new(obj, self, old_next)
+      old_next&.prev = @next
+      @next
+    end
+
+    def to_s
+      "[prev=#{@prev.object_id}, next=#{@next.object_id}, value=#{@value}]"
+    end
+  end
+  class SortedRingBuffer
+    include Enumerable
+    def initialize(max_size, sort_func)
+      raise "Invalid size #{max_size}" unless max_size.positive?
+      @head = RingBufferNode.new(nil, nil, nil)
+      @sort_func = sort_func
+      @tail = @head
+      @max_size = max_size
+      (max_size - 1).times do
+        @head = @head.insert_before(nil)
+      end
+    end
+
+    def push(obj)
+      return unless obj
+      cur = @tail
+      raise "No head.next found in #{@head}" unless @head.next
+      while cur && cur.value && @sort_func.call(cur.value, obj).positive?
+        cur = cur.prev
+      end
+      if cur.nil?
+        # The value we try to insert is before @head
+        # no need to do anything
+      elsif cur == @head
+        # This is the head, just update the value
+        @head.value = obj
+      else
+        @head = @head.next
+        @head.prev = nil
+        new_val = cur.append(obj)
+        @tail = new_val if @tail == cur
+      end
+    end
+
+    def each
+      return enum_for(:each) unless block_given? # Sparkling magic!
+      cur = @head
+      until cur.nil?
+        yield cur.value if cur.value
+        cur = cur.next
+      end
+    end
+
+    def to_a
+      arr = Array.new(@max_size)
+      cur = @head
+      i = 0
+      until cur.nil?
+        if cur.value
+          arr[i] = cur.value
+          i += 1
+        end
+        cur = cur.next
+      end
+      if i != @max_size
+        arr.reject(&:nil?)
+      else
+        arr
+      end
+    end
+  end
+end
+
+if ARGV.count.positive? && ARGV[0] == 'debug'
+  require 'json'
+  size = (ARGV[1] || 10).to_i
+  ringbuff = ConsulTimeline::SortedRingBuffer.new(size, ->(a, b) { a <=> b })
+  ringbuff.push 0.5
+  puts ringbuff.to_a
+  (size * 10).times do |i|
+    ringbuff.push(2 * i + Random.rand(size / 10))
+  end
+  ringbuff.push 99_999_999_999_999
+  arr = ringbuff.to_a
+  raise "OOPS wrong size := #{arr.count} instead of #{size}" unless arr.count == size
+  STDOUT.puts JSON.generate(arr)
+end

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

@@ -55,33 +55,7 @@ old_state = if @previous_state
             end
 
 unless @events
-  class RingBuffer < Array
-    attr_reader :max_size
-
-    def initialize(max_size:, enum: nil)
-      @max_size = max_size
-      warn "Ringbuffer initialized with #{max_size}"
-      enum&.each { |e| self << e }
-    end
-
-    def <<(element)
-      return unless element
-      if size >= @max_size
-        shift
-      end
-      previous_e = last
-      after = []
-      while !previous_e.nil? && (previous_e['idx'] > element['idx'])
-        after.insert(0, pop)
-        previous_e = last
-      end
-      push(element)
-      after.each do |x|
-        push(x)
-      end
-      self
-    end
-  end
+  load File.expand_path(File.join(File.dirname(template_info['source']), 'ringbuffer.rb'))
 
   def diff(old, new_e)
     diff = OpenStruct.new
@@ -92,7 +66,7 @@ unless @events
     diff
   end
 
-  @events = RingBuffer.new(max_size: (ENV['CONSUL_TIMELINE_BUFFER'] || 10000).to_i)
+  @events = ::ConsulTimeline::SortedRingBuffer.new((ENV['CONSUL_TIMELINE_BUFFER'] || 10000).to_i, lambda {|a, b| a['idx'] <=> b['idx'] })
 end
 @new_events = []
 
@@ -209,7 +183,7 @@ sorted_events = @new_events.sort do |a, b|
   end
   res
 end
-sorted_events.each { |e| @events << e }
+sorted_events.each { |e| @events.push e }
 @new_events.clear
 
 # We save the previous state only when we have a complete state once
@@ -217,4 +191,4 @@ if template_info['was_rendered_once']
   warn "First full rendering completed at #{@current_time} !" unless @previous_state
   @previous_state = cur_state
 end
-%><%= JSON.generate(@events) %>
+%><%= JSON.generate(@events.to_a) %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.9.3
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-04 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -184,11 +184,13 @@ files:
 - samples/consul-ui/consul_nodes.json.erb
 - samples/consul-ui/consul_services.json.erb
 - samples/consul-ui/css/style.css
+- samples/consul-ui/images/favicon.png
 - samples/consul-ui/js/keys.js
 - samples/consul-ui/js/nodes.js
 - samples/consul-ui/js/service.js
 - samples/consul-ui/js/timeline.js
 - samples/consul-ui/js/utils.js
+- samples/consul-ui/ringbuffer.rb
 - samples/consul-ui/timeline.json.erb
 - samples/consul-ui/vendors/highlight/atom-one-dark.css
 - samples/consul-ui/vendors/highlight/highlight.pack.js