consul-templaterb 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a383446773f29932a2919164fa521013123aa859be0e6f93141672083261257
-  data.tar.gz: 4d8d2916f5d25eba9d9782b5a21b762091df24e1cd7950d250418b12a1da0a46
+  metadata.gz: 1322b0762c3a9ea41ae648227b38f42e21166193fbae07cc5b1b450b7814ce6b
+  data.tar.gz: e656d9e1b4cff345704bfe1e32ce71fc9be6b9433f554a0c6184ef506423e453
 SHA512:
-  metadata.gz: e170417393ad454623c8a2d6e67e2d71ee6642f5ab61ca300836406c8892dd0c8852c610d4671f75c887c547134f8ddd046d20952a75149d8ad8e88c5e6f6230
-  data.tar.gz: 4ac536f6a1f67f3d43d59829cf0427ecc92176e6adba35956ece9f392c8dcc87a9c68824eb9f1b84e3ed86e043996802aeecd8010ccc0f7cbfbb64a97fbae1f8
+  metadata.gz: 89029f97088f851c676263d79d584e0b6cfa22b72f2008690857f5341b7af3f8b7b627d082ada09b057010c97358cd75846f18ed8b825e4e212a0c07c0998abf
+  data.tar.gz: e2581df1a03190bb75a1f40838282ab49c9184e32a5fcf7807b1f86febbb1b0a88ea1deb93cddfe256c3aeccfeaf3874d4ad99f8b53935200fd15c9c8d71d821

data/.rubocop.yml

@@ -7,13 +7,13 @@ Metrics/AbcSize:
   Max: 82
 
 Metrics/BlockLength:
-  Max: 145
+  Max: 160
 
 Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  Max: 250
+  Max: 275
 
 Metrics/CyclomaticComplexity:
   Max: 20
@@ -25,7 +25,7 @@ Metrics/MethodLength:
   Max: 65
 
 Metrics/ParameterLists:
-  Max: 12
+  Max: 14
 
 Metrics/PerceivedComplexity:
   Max: 23

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## (UNRELEASED)
 
+## 1.23.0 (February 18, 2020)
+
+NEW FEATURES:
+
+ * Implementation of #59 - implementation of `--retry` and `--vault-retry` new flags
+   Those flags work in a similar way as in consul-template: stop program after X failures
+   of consul or vault endpoints
+ * Added --fail-fast that stop the programs immediately if vault or consul are not available
+   at startup (also works with `--once`)
+
 ## 1.22.0 (January 17, 2020)
 
 NEW FEATURES:

data/README.md

@@ -160,6 +160,9 @@ $ consul-templaterb --help
 USAGE: consul-templaterb [[options]]
     -h, --help                       Show help
     -v, --version                    Show Version
+        --retry, --consul-retry-attempts [RETRIES]
+                                     If consul fails after n retries, stop the program, default=10
+    -f, --[no-]fail-fast             If consul/vault endpoints fail at startup, fail immediately
     -g, --no-gzip-compression        Disable GZIP compression in HTTP requests
     -c, --consul-addr=<address>      Address of Consul, eg: http://localhost:8500
     -l, --log-level=<log_level>      Log level, default=info, any of none|error|info|debug
@@ -167,6 +170,8 @@ USAGE: consul-templaterb [[options]]
     -V, --vault-addr=<address>       Address of Vault, eg: http://localhost:8200
         --vault-token=<token>        Token used to authenticate against vault.
         --[no-]vault-renew           Control auto-renewal of the Vault token. Default: activated
+        --vault-retry, --vault-retry-attempts [RETRIES]
+                                     If vault fails after n retries, stop the program, default=10
         --vault-lease-duration-factor=<factor>
                                      Wait at least <factor> * lease time before updating a Vault secret. Default: 0.5
     -w, --wait=<min_duration>        Wait at least n seconds before each template generation

data/bin/consul-templaterb

@@ -27,6 +27,8 @@ options = {
     },
     base_url: ENV['VAULT_ADDR'] || 'http://localhost:8200',
     token: ENV['VAULT_TOKEN'] || nil,
+    max_consecutive_errors_on_endpoint: 10, # Stop program after n consecutive failures on same endpoint
+    fail_fast_errors: nil,                  # fail fast the program if endpoint was never success
     token_renew: true,
     retry_duration: 10,
     lease_duration_factor: 0.5, # The time it waits before actualizing data based on the lease time: 2h lease * 0.5 = Fetch data every 1h
@@ -45,6 +47,8 @@ options = {
     },
     base_url: ENV['CONSUL_HTTP_ADDR'] || 'http://localhost:8500',
     token: ENV['CONSUL_HTTP_TOKEN'] || nil,
+    max_consecutive_errors_on_endpoint: 10, # Stop program after n consecutive failures on same endpoint
+    fail_fast_errors: nil,                  # fail fast the program if endpoint was never success
     retry_duration: 10,      # On error, retry after n seconds
     min_duration: 5,         # On sucess and when differences are found
     retry_on_non_diff: 3,    # On success but when there are not differences
@@ -94,6 +98,17 @@ optparse = OptionParser.new do |opts|
     exit 0
   end
 
+  opts.on('--retry [RETRIES]', '--consul-retry-attempts [RETRIES]', Integer,
+          "If consul fails after n retries, stop the program, default=#{options[:consul][:max_consecutive_errors_on_endpoint]}") do |value|
+    raise "#{value} Must be greater or equal to 0" unless value >= 0
+    options[:consul][:max_consecutive_errors_on_endpoint] = value
+  end
+
+  opts.on('-f', '--[no-]fail-fast', 'If consul/vault endpoints fail at startup, fail immediately') do |v|
+    options[:consul][:fail_fast_errors] = v
+    options[:vault][:fail_fast_errors] = v
+  end
+
   opts.on('-g', '--no-gzip-compression', 'Disable GZIP compression in HTTP requests') do
     options[:consul][:enable_gzip_compression] = false
   end
@@ -123,6 +138,12 @@ optparse = OptionParser.new do |opts|
     options[:vault][:token_renew] = vault_renew
   end
 
+  opts.on('--vault-retry [RETRIES]', '--vault-retry-attempts [RETRIES]', Integer,
+          "If vault fails after n retries, stop the program, default=#{options[:vault][:max_consecutive_errors_on_endpoint]}") do |value|
+    raise "#{value} Must be greater or equal to 0" unless value >= 0
+    options[:vault][:max_consecutive_errors_on_endpoint] = value
+  end
+
   opts.on('--vault-lease-duration-factor=<factor>', Float, 'Wait at least <factor> * lease time before updating a Vault secret. Default: 0.5') do |factor|
     options[:vault][:lease_duration_factor] = factor
   end

data/lib/consul/async/consul_endpoint.rb

@@ -7,7 +7,8 @@ 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, :enable_gzip_compression
+                  :missing_index_retry_time_on_diff, :missing_index_retry_time_on_unchanged, :debug, :enable_gzip_compression,
+                  :fail_fast_errors, :max_consecutive_errors_on_endpoint
       def initialize(base_url: 'http://localhost:8500',
                      debug: { network: false },
                      token: nil,
@@ -19,7 +20,9 @@ module Consul
                      missing_index_retry_time_on_diff: 15,
                      missing_index_retry_time_on_unchanged: 60,
                      enable_gzip_compression: true,
-                     paths: {})
+                     paths: {},
+                     max_consecutive_errors_on_endpoint: 10,
+                     fail_fast_errors: 1)
         @base_url = base_url
         @token = token
         @debug = debug
@@ -32,6 +35,8 @@ module Consul
         @missing_index_retry_time_on_diff = missing_index_retry_time_on_diff
         @missing_index_retry_time_on_unchanged = missing_index_retry_time_on_unchanged
         @paths = paths
+        @max_consecutive_errors_on_endpoint = max_consecutive_errors_on_endpoint
+        @fail_fast_errors = fail_fast_errors
       end
 
       def ch(path, symbol)
@@ -57,7 +62,9 @@ module Consul
                                 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)
+                                paths: @paths,
+                                max_consecutive_errors_on_endpoint: @max_consecutive_errors_on_endpoint,
+                                fail_fast_errors: @fail_fast_errors)
       end
     end
     class ConsulResult

data/lib/consul/async/consul_template.rb

@@ -79,8 +79,9 @@ module Consul
     end
 
     class EndPointsManager
-      attr_reader :consul_conf, :vault_conf, :net_info, :start_time, :coordinate, :remote_resource, :templates
+      attr_reader :consul_conf, :vault_conf, :running, :net_info, :start_time, :coordinate, :remote_resource, :templates
       def initialize(consul_configuration, vault_configuration, templates, trim_mode = nil)
+        @running = true
         @consul_conf = consul_configuration
         @vault_conf = vault_configuration
         @trim_mode = trim_mode
@@ -106,6 +107,8 @@ module Consul
           },
           params: {}
         }
+        @max_consecutive_errors_on_endpoint = consul_configuration.max_consecutive_errors_on_endpoint || 10
+        @fail_fast_errors = consul_configuration.fail_fast_errors
         @coordinate = Coordinate.new(self)
         @remote_resource = RemoteResource.new(self)
 
@@ -221,7 +224,7 @@ module Consul
         raise "You need to provide a vault token to use 'secret' keyword" if vault_conf.token.nil?
         path = "/v1/#{path}".gsub(%r{/{2,}}, '/')
         query_params = { list: 'true' }
-        create_if_missing(path, query_params) do
+        create_if_missing(path, query_params, vault_conf.fail_fast_errors, vault_conf.max_consecutive_errors_on_endpoint) do
           ConsulTemplateVaultSecretList.new(VaultEndpoint.new(vault_conf, path, 'GET', true, query_params, JSON.generate(data: { keys: [] })))
         end
       end
@@ -231,7 +234,9 @@ module Consul
         path = "/v1/#{path}".gsub(%r{/{2,}}, '/')
         query_params = {}
         method = post_data ? 'POST' : 'GET'
-        create_if_missing(path, query_params) { ConsulTemplateVaultSecret.new(VaultEndpoint.new(vault_conf, path, method, true, query_params, JSON.generate(data: {}))) }
+        create_if_missing(path, query_params, vault_conf.fail_fast_errors, vault_conf.max_consecutive_errors_on_endpoint) do
+          ConsulTemplateVaultSecret.new(VaultEndpoint.new(vault_conf, path, method, true, query_params, JSON.generate(data: {})))
+        end
       end
 
       # render a relative file with the given params accessible from template
@@ -329,6 +334,7 @@ module Consul
       end
 
       def terminate
+        @running = false
         @endpoints.each_value do |v|
           v.endpoint.terminate
         end
@@ -341,7 +347,7 @@ module Consul
         VaultEndpoint.new(vault_conf, path, :POST, {}, {})
       end
 
-      def create_if_missing(path, query_params)
+      def create_if_missing(path, query_params, fail_fast_errors = @fail_fast_errors, max_consecutive_errors_on_endpoint = @max_consecutive_errors_on_endpoint)
         fqdn = path.dup
         query_params.each_pair do |k, v|
           fqdn = "#{fqdn}&#{k}=#{v}"
@@ -357,7 +363,17 @@ module Consul
             @net_info[:changes] += 1 if result.modified?
             @net_info[:network_bytes] += result.http.response_header['Content-Length'].to_i
           end
-          tpl.endpoint.on_error { @net_info[:errors] = @net_info[:errors] + 1 }
+          tpl.endpoint.on_error do |_err|
+            @net_info[:errors] = @net_info[:errors] + 1
+            if tpl.endpoint.stats.successes.zero? && fail_fast_errors
+              ::Consul::Async::Debug.puts_error "Endpoint #{path} is failing at first call with fail fast activated, terminating..."
+              terminate
+            end
+            if tpl.endpoint.stats.consecutive_errors > max_consecutive_errors_on_endpoint
+              ::Consul::Async::Debug.puts_error "Endpoint #{path} has too many consecutive errors: #{tpl.endpoint.stats.consecutive_errors}, terminating..."
+              terminate
+            end
+          end
         end
         tpl._seen_at(@iteration)
         tpl

data/lib/consul/async/consul_template_engine.rb

@@ -44,6 +44,12 @@ module Consul
 
       # Run templating engine once
       def do_run(template_manager, template_renders)
+        unless template_manager.running
+          ::Consul::Async::Debug.puts_info '[FATAL] TemplateManager has been stopped, stopping everything'
+          @result = 3
+          EventMachine.stop
+          return
+        end
         results = template_renders.map(&:run)
         all_ready = results.all?(&:ready?)
         if !@all_templates_rendered && all_ready

data/lib/consul/async/stats.rb

@@ -3,7 +3,7 @@ require 'consul/async/utilities'
 module Consul
   module Async
     class EndPointStats
-      attr_reader :successes, :errors, :start, :body_bytes, :last_error, :last_success, :last_modified, :changes, :network_bytes
+      attr_reader :successes, :errors, :consecutive_errors, :start, :body_bytes, :last_error, :last_success, :last_modified, :changes, :network_bytes
 
       def initialize
         @start = Time.now.utc
@@ -15,6 +15,7 @@ module Consul
         @last_error = @start
         @last_success = @start
         @last_modified = @start
+        @consecutive_errors = 0
       end
 
       def on_response(res)
@@ -23,12 +24,14 @@ module Consul
         @body_bytes += res.http.response.bytesize
         @changes += 1 if res.modified?
         @last_modified = @last_success if res.modified?
+        @consecutive_errors = 0
         @network_bytes += res.http.response_header['Content-Length'].to_i
       end
 
       def on_error(_http)
         @last_error = Time.now.utc
         @errors += 1
+        @consecutive_errors += 1
       end
 
       def bytes_per_sec(now = Time.now.utc)

data/lib/consul/async/vault_endpoint.rb

@@ -10,7 +10,7 @@ module Consul
   module Async
     class VaultConfiguration
       attr_reader :base_url, :token, :token_renew, :retry_duration, :min_duration, :wait_duration, :max_retry_duration, :retry_on_non_diff,
-                  :lease_duration_factor, :debug
+                  :lease_duration_factor, :debug, :max_consecutive_errors_on_endpoint, :fail_fast_errors
 
       def initialize(base_url: 'http://localhost:8200',
                      debug: { network: false },
@@ -20,7 +20,9 @@ module Consul
                      min_duration: 0.1,
                      lease_duration_factor: 0.5,
                      max_retry_duration: 600,
-                     paths: {})
+                     paths: {},
+                     max_consecutive_errors_on_endpoint: 10,
+                     fail_fast_errors: false)
         @base_url = base_url
         @token_renew = token_renew
         @debug = debug
@@ -30,6 +32,8 @@ module Consul
         @lease_duration_factor = lease_duration_factor
         @paths = paths
         @token = token
+        @max_consecutive_errors_on_endpoint = max_consecutive_errors_on_endpoint
+        @fail_fast_errors = fail_fast_errors
       end
 
       def ch(path, symbol)
@@ -51,7 +55,9 @@ module Consul
                                min_duration: ch(path, :min_duration),
                                max_retry_duration: ch(path, :max_retry_duration),
                                lease_duration_factor: ch(path, :lease_duration_factor),
-                               paths: @paths)
+                               paths: @paths,
+                               max_consecutive_errors_on_endpoint: @max_consecutive_errors_on_endpoint,
+                               fail_fast_errors: @fail_fast_errors)
       end
     end
     class VaultResult

data/lib/consul/async/version.rb

@@ -1,5 +1,5 @@
 module Consul
   module Async
-    VERSION = '1.22.0'.freeze
+    VERSION = '1.23.0'.freeze
   end
 end

data/samples/metrics.erb

@@ -7,7 +7,7 @@
 #   EXCLUDE_SERVICES: comma-separated services regexps to exclude (example: lbl7.*,netsvc-probe.*,consul-probed.*)
 #   PROMETHEUS_EXPORTED_SERVICE_META: comma-separated list of meta to export into metrics of service
 <%
-  service_metas_to_export = (ENV['PROMETHEUS_EXPORTED_SERVICE_META'] || 'version,os,criteo_flavor,node_group').split(',')
+  service_metas_to_export = (ENV['PROMETHEUS_EXPORTED_SERVICE_META'] || 'OWNERS,version,os,criteo_flavor,node_group').split(',')
 
   service_tag_filter = ENV['SERVICES_TAG_FILTER'] || nil
   instance_must_tag = ENV['INSTANCE_MUST_TAG'] || service_tag_filter

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul-templaterb
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - SRE Core Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-17 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-http-request