consul-templaterb 1.28.2 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b99b274e76706dd09a6da62555cc79c462d5072237825fb10fea80ef3d3e558
-  data.tar.gz: 68e4a32addfb0decb19e8dbda17dfc99665c6e19da03d789cddf61196c051c7a
+  metadata.gz: 802bc9946fe5828724eff84a9564b5ec8313a5f6d795f1abb1c0dcafca94a268
+  data.tar.gz: fa0acac3ecf2d94000eb909d0001294552931e34c44ee8492d51081bd23806f0
 SHA512:
-  metadata.gz: c1385863a2b51bb12c4b900c869a82048acecec0abe9e6875e151cf39151e5f0ff983b130549191d236315c22ff45e61810c515397d75fe2847dc28e70044499
-  data.tar.gz: 9a6acde596746461c64b99145f13952e4e4cfc4ea009b9e31f65afab96f5e7ecf93f5764ad7d0e5fd98e5b37419bc5b60c169abf6aefdc5bb2cbbd55f1495c30
+  metadata.gz: 801abf727fd2f3c5db209244c5d7da533e27ff3985ac82c1c234e86f8bf70ce5f6a99bb608ca01d1d07b814d019b2f19010a7a8cbd6d7a4b5531b2345c50c280
+  data.tar.gz: 7ec7df66f3bfc071ba4fa8e6414006e9551e6ac34503c45a725b628f9891602185cae8ba69fecde220dbde25ab2dd8576c30e2158d96c303c7bb79ea7124984c

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 # CHANGELOG
 
-## (UNRELEASED)
+## 1.32.0 (Jan 27, 2021)
+
+IMPROVEMENTS:
+
+* Use Ruby 2.7.2 in Travis build
+* [VAULT] Do not handle missing secret as a blocking exception ([#73](https://github.com/criteo/consul-templaterb/pull/73))
+
+## 1.31.1 (Jan 25, 2021)
+
+IMPROVEMENTS:
+
+* Use Node.Meta.fqdn to display node names in timeline if set
+
+## 1.31.0 (Jan 18, 2021)
+
+IMPROVEMENTS:
+
+* Do not apply penalty on unmodified services not changing much (Will improve streaming performance)
+
+## 1.30.0 (Dec 18, 2020)
+
+IMPROVEMENTS:
+
+ * Allow customization to sort nodes in service view in Consul-UI ([#71](https://github.com/criteo/consul-templaterb/pull/71))
+
+NEW FEATURES:
+
+ * Auto-detection of rate-limit on Consul Side (introduced in Consul 1.6.2+), this feature
+   will work only Consul 1.9+ (see [Consul #7527](https://github.com/hashicorp/consul/issues/7527)). 
+
+## 1.29.0 (Oct 6, 2020)
+
+IMPROVEMENTS:
+
+ * When no template has been specified, stop early with an error message
 
 ## 1.28.2 (Oct 5, 2020)
 

data/bin/consul-templaterb

@@ -375,6 +375,11 @@ ARGV.each do |tpl|
   consul_engine.add_template(tpl, dest)
 end
 
+if consul_engine.templates.count.zero?
+  puts 'You must specify at least one template as arg or using -t'
+  exit 255
+end
+
 template_manager = Consul::Async::EndPointsManager.new(consul_conf, vault_conf, consul_engine.templates, options[:erb][:trim_mode])
 
 Signal.trap('USR1', 'IGNORE') unless Gem.win_platform?

data/lib/consul/async/consul_endpoint.rb

@@ -225,9 +225,34 @@ module Consul
         retry_in / 2 + Consul::Async::Utilities.random.rand(retry_in)
       end
 
+      # rubocop:disable Style/ClassVars
+      def _last_429
+        @@_last_429 ||= { count: 0 }
+      end
+      # rubocop:enable Style/ClassVars
+
       def _handle_error(http, consul_index)
         retry_in = _compute_retry_in([600, conf.retry_duration + 2**@consecutive_errors].min)
-        ::Consul::Async::Debug.puts_error "[#{path}] X-Consul-Index:#{consul_index} - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+        if http.response_header.status == 429
+          _last_429
+          retry_in = 60 + Consul::Async::Utilities.random.rand(180) if retry_in < 60
+          _last_429[:time] = Time.now.utc
+          _last_429[:count] += 1
+          if (_last_429[:count] % 10) == 1
+            if _last_429[:count] == 1
+              ::Consul::Async::Debug.puts_error "Rate limiting detected on Consul side (HTTP 429)!\n\n" \
+                                                "******************************* CONFIGURATION ISSUE DETECTED *******************************\n" \
+                                                "* Too many simultaneous connections for Consul agent #{conf.base_url}\n" \
+                                                "* You should tune 'limits.http_max_conns_per_client' to a higher value.\n" \
+                                                "* This program will behave badly until you change this.\n" \
+                                                "* See https://www.consul.io/docs/agent/options.html#http_max_conns_per_client for more info\n" \
+                                                "********************************************************************************************\n\n"
+            end
+            ::Consul::Async::Debug.puts_error "[#{path}] Too many conns to #{conf.base_url}, errors=#{_last_429[:count]} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+          end
+        else
+          ::Consul::Async::Debug.puts_error "[#{path}] X-Consul-Index:#{consul_index} - #{http.error} - Retry in #{retry_in}s #{stats.body_bytes_human}"
+        end
         @consecutive_errors += 1
         http_result = HttpResponse.new(http)
         EventMachine.add_timer(retry_in) do
@@ -272,11 +297,12 @@ module Consul
                             end
               new_content = http_result.response.freeze
               modified = @last_result.fake? || @last_result.data != new_content
-              if n_consul_index == consul_index || n_consul_index.nil?
+              if n_consul_index.nil?
                 retry_in = modified ? conf.missing_index_retry_time_on_diff : conf.missing_index_retry_time_on_unchanged
                 n_consul_index = consul_index
               else
                 retry_in = modified ? conf.min_duration : conf.retry_on_non_diff
+                retry_in = 0.1 if retry_in < (Time.now - @last_result.last_update)
               end
               retry_in = _compute_retry_in(retry_in)
               retry_in = 0.1 if retry_in < 0.1

data/lib/consul/async/vault_endpoint.rb

@@ -245,7 +245,7 @@ module Consul
           http = connection.send(http_method.downcase, build_request) # Under the hood: c.send('get', {stuff}) === c.get({stuff})
           http.callback do
             http_result = VaultHttpResponse.new(http.dup.freeze, default_value)
-            if enforce_json_200 && http.response_header.status != 200
+            if enforce_json_200 && ![200, 404].include?(http.response_header.status)
               _handle_error(http_result) { connection = EventMachine::HttpRequest.new(conf.base_url, options) }
             else
               @consecutive_errors = 0

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.28.2'.freeze
+    VERSION = '1.32.0'.freeze
   end
 end

data/samples/consul-ui/.preferences.rb.samples

@@ -0,0 +1 @@
+SORT_CONSUL_SERVICE_NODES = -> (nodes) { nodes.sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] } }

data/samples/consul-ui/README.md

@@ -94,3 +94,9 @@ This app supports the following environment variables:
 * `EXCLUDE_SERVICES`: comma-separated services to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 * `CONSUL_TIMELINE_BUFFER`: number of entries to keep in the timeline. 1000 by default.
 * `CONSUL_TIMELINE_BLACKLIST`: regexp of services to hide from timeline
+
+### Preferences
+
+Some templates allows you to override some behavior through `.preferences.rb` file.
+In order to do that, rename `.preferences.rb.samples` file to `.preferences.rb`
+and update lambda defined inside to match targeted behavior.

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

@@ -6,6 +6,19 @@
 #   INSTANCE_EXCLUDE_TAG: Exclude instances having the given tag (default: canary)
 #   EXCLUDE_SERVICES: comma-separated services regexps to exclude (default: lbl7.*,netsvc-probe.*,consul-probed.*)
 
+  unless @sort_consul_service_nodes
+    begin
+      target_dir = File.split(File.expand_path(template_info['source']))[0]
+      target = File.join(target_dir, '.preferences.rb')
+      load "#{target}"
+      STDERR.puts "Using #{target} file."
+      @sort_consul_service_nodes = SORT_CONSUL_SERVICE_NODES
+    rescue LoadError
+      STDERR.puts 'Couldn\'t find .preferences.rb file ; default configuration will be used.'
+      @sort_consul_service_nodes = -> (nodes) { nodes.sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] } }
+    end
+  end
+
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter
   instance_exclude_tag = ENV['INSTANCE_EXCLUDE_TAG']
@@ -20,7 +33,7 @@
     if !services_blacklist.any? {|r| r.match(service_name)} && (instance_must_tag.nil? || tags.include?(instance_must_tag))
       tags_per_service[service_name] = tags.sort
       the_backends = []
-      service(service_name).sort {|a,b| a['Node']['Node'] <=> b['Node']['Node'] }.each do |snode|
+      @sort_consul_service_nodes.call(service(service_name)).each do |snode|
         tags_of_instance = snode['Service']['Tags'].sort
         if (instance_must_tag.nil? || tags_of_instance.include?(instance_must_tag)) && !tags_of_instance.include?(instance_exclude_tag)
           the_backends << snode if snode['Service']['Port']

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

@@ -434,7 +434,7 @@ class ServiceTimeline {
             }
             var text = e.instance;
             if (e.instance_info && e.instance_info.node) {
-                text = e.instance_info.node;
+                text = e.instance_info.fqdn;
                 if (e.instance_info.port > 0) {
                     text += ":" + e.instance_info.port
                 }

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

@@ -41,10 +41,12 @@ cur_state = services.map do |service_name, _tags|
       mindex = chk['ModifyIndex'] || 0
       mod_index = mindex if mod_index < mindex
     end
-    ["#{instance['Node']['Node']}:#{instance['Service']['ID']}",
+    node_name = instance['Node']['Node']
+    ["#{node_name}:#{instance['Service']['ID']}",
      {
        'address' => instance.service_address,
-       'node' => instance['Node']['Node'],
+       'node' => node_name,
+       'fqdn' => instance.node_meta['fqdn'] || node_name,
        'port' => instance['Service']['Port'],
        'idx'  => mod_index || cur_index,
        'status' => instance.status,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.28.2
+  version: 1.32.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request
@@ -181,6 +181,7 @@ files:
 - samples/all_services_multi_agents.txt.erb
 - samples/all_templates.erb
 - samples/checks_in_warning_or_critical_state.yaml.erb
+- samples/consul-ui/.preferences.rb.samples
 - samples/consul-ui/README.md
 - samples/consul-ui/common/footer.html.erb
 - samples/consul-ui/common/header.html.erb