consul-templaterb 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c96f61a1890c149604e52ed7d68bd239fe6b8df3bdf12b21fc5aacc07d985b
-  data.tar.gz: 7053673ba6ee2775cdc80a04fd2c8b2d8956b41f58108eac1617599d604072bd
+  metadata.gz: 1d751a91e60648e8c967bd3401a6d1d595c01f95a4da6ca3537dad89247d2755
+  data.tar.gz: 662f076af6864fd541319e0e0ae4c41e6f09cbc96f578d700c403bd315df7420
 SHA512:
-  metadata.gz: 75c8c5f6b55d8246942f0e86a7d2041d54822b980379c49e06b51f2d806f316dc8f35674751eb6610b50ec465140ac8412133765378aa60d47057557dbd694a8
-  data.tar.gz: 24366dc573380c88460224829282e80ed8e39f3312daf885cd28c8d5e3028c87d0239b4b0fdc8920820e101c58e5e47121ab181ff1fae6cbf769b4152c2e20c2
+  metadata.gz: c58c6e86c13d2ca37bbb2d4a82aace1d39c27fe76fd4bbf43372d6131d2e14004cbe9d9b6205e40008ab4ad992a44417651aa3739709eb88881d904d3f4161ba
+  data.tar.gz: 9f0baecd48f648c0f04a49bc4366d8b85f2cf635d4bb9bd0d572dec9edf3e7fc0a3157f103ef31669cb2856827a4da4cbe73644d9071dcd4de5f3ad4d60451c6

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## (UNRELEASED)
 
+## 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:

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

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.29.0'.freeze
+    VERSION = '1.30.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']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 1.30.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-06 00:00:00.000000000 Z
+date: 2020-12-18 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