synapse-nginx 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba905f50502b486b5a4424be003efe1fe69fbcbc
-  data.tar.gz: 334c1aaac7042a351aad7f71d06a40b61459c98e
+  metadata.gz: 73199a08eec1e313f37926a0c8c38dd00ebca0b5
+  data.tar.gz: a36bede5643dbd71b4fb5baf9c886c876adf609b
 SHA512:
-  metadata.gz: c4ae8565ad2015c84a186be078cffd0c1ed76546b996cbfd384ef1e907a88e6a75cb405f8069c680e5bbe4c8b185e00ae8303ea5cee03d844a0070721d0d107e
-  data.tar.gz: b05887839ce9c41cc1136985208c418461367f343360d3e407caa40f6cfd2281b33691e00bbba699bac962edd5a8226c0c653f6d009a2988e6f1e5c33304b8b6
+  metadata.gz: ac9a2eb24360488f1f04ba77049fce586f0ba73d7af8df5f69209c95d528ba09eb3eccdc1aa5f58d9563dfa06ed07d9a22724cce5bc40297fa8f07e10d5c28a1
+  data.tar.gz: 60a8611e1acd216065d9674006c11d212d4615c9e45fbeb6e94e942f6daca3cc100c448b568d4af0f1c9dcd6a6dad2381f901c7f583f2f0cae6868feaf8cc4bd

data/README.md

@@ -85,7 +85,12 @@ Setting `listen_address` on a per service basis overrides the global `listen_add
 in the top level `nginx` config hash.
 * `listen_options`: additional listen options provided as a string,
 such as `reuseport`, to append to the listen line. (default is empty string)
-* `upstream_order`: how servers should be ordered in the `upstream` stanza. Setting to `asc` means sorting backends in ascending alphabetical order before generating stanza. `desc` means descending alphabetical order. `no_shuffle` means no shuffling or sorting. (default: `shuffle`, which results in random ordering of upstream servers)
+* `upstream_order`: how servers should be ordered in the `upstream` stanza.
+This defaults to `asc` to prevent reloads, and can be set to:
+  * `asc` sort upstreams in ascending alphabetical order.
+  * `desc` sort upstreams in descending alphabetical order.
+  * `shuffle` means random ordering of servers.
+  * `no_shuffle` means no shuffling or sorting.
 * `upstream_name`: The name of the generated nginx backend for this service
   (defaults to the service's key in the `services` section)
 

data/lib/synapse/config_generator/nginx.rb

@@ -38,15 +38,18 @@ class Synapse::ConfigGenerator
       # how to restart nginx
       @restart_interval = @opts.fetch('restart_interval', 2).to_i
       @restart_jitter = @opts.fetch('restart_jitter', 0).to_f
-      @restart_required = true
+      @restart_required = false
       @has_started = false
 
       # virtual clock bookkeeping for controlling how often nginx restarts
       @time = 0
       @next_restart = @time
 
-      # a place to store the parsed nginx config from each watcher
-      @watcher_configs = {}
+      # a place to store generated server + upstream stanzas, and watcher
+      # revisions so we can save CPU on updates by not re-computing stanzas
+      @servers_cache = {}
+      @upstreams_cache = {}
+      @watcher_revisions = {}
     end
 
     def normalize_watcher_provided_config(service_watcher_name, service_watcher_config)
@@ -57,9 +60,11 @@ class Synapse::ConfigGenerator
         'server' => [],
         'disabled' => false,
       }
-      unless service_watcher_config.include?('port')
+
+      unless service_watcher_config.include?('port') || service_watcher_config['disabled']
         log.warn "synapse: service #{service_watcher_name}: nginx config does not include a port; only upstream sections for the service will be created; you must move traffic there manually using server sections"
       end
+
       defaults.merge(service_watcher_config)
     end
 
@@ -96,6 +101,19 @@ class Synapse::ConfigGenerator
         # don't bind the port at all? ... idk
         next if watcher_config['mode'] == 'tcp' && watcher.backends.empty?
 
+
+        # Only regenerate if something actually changed. This saves a lot
+        # of CPU load for high churn systems
+        regenerate = watcher.revision != @watcher_revisions[watcher.name] ||
+                     @servers_cache[watcher.name].nil? ||
+                     @upstreams_cache[watcher.name].nil?
+
+        if regenerate
+          @servers_cache[watcher.name] = generate_server(watcher).flatten
+          @upstreams_cache[watcher.name] = generate_upstream(watcher).flatten
+          @watcher_revisions[watcher.name] = watcher.revision
+        end
+
         section = case watcher_config['mode']
           when 'http'
             http
@@ -104,8 +122,8 @@ class Synapse::ConfigGenerator
           else
             raise ArgumentError, "synapse does not understand #{watcher_config['mode']} as a service mode"
         end
-        section << generate_server(watcher).flatten
-        section << generate_upstream(watcher).flatten
+        section << @servers_cache[watcher.name]
+        section << @upstreams_cache[watcher.name]
       end
 
       unless http.empty?
@@ -214,15 +232,18 @@ class Synapse::ConfigGenerator
       # nginx doesn't like upstreams with no backends?
       return [] if backends.empty?
 
+      # Note that because we use the config file as the source of truth
+      # for whether or not to reload, we want some kind of sorted order
+      # by default, in this case we choose asc
       keys = case watcher_config['upstream_order']
-      when 'asc'
-        backends.keys.sort
       when 'desc'
         backends.keys.sort.reverse
+      when 'shuffle'
+        backends.keys.shuffle
       when 'no_shuffle'
         backends.keys
       else
-        backends.keys.shuffle
+        backends.keys.sort
       end
 
       stanza = [
@@ -247,7 +268,13 @@ class Synapse::ConfigGenerator
         old_config = ""
       end
 
-      if old_config == new_config
+      # The first line of the config files contain a timestamp, so to prevent
+      # un-needed restarts, only compare after that. We do not split on
+      # newlines and compare because this is called a lot, and we need to be
+      # as CPU efficient as possible.
+      old_version =  old_config[(old_config.index("\n") || 0) + 1..-1]
+      new_version =  new_config[(new_config.index("\n") || 0) + 1..-1]
+      if old_version == new_version
         return false
       else
         File.open(opts['config_file_path'],'w') {|f| f.write(new_config)}

data/lib/synapse-nginx.rb

@@ -1,6 +1,6 @@
 module Synapse
   module Nginx
     # Version information for Synapse::Nginx
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/spec/lib/synapse/nginx_spec.rb

@@ -16,6 +16,7 @@ describe Synapse::ConfigGenerator::Nginx do
     allow(mockWatcher).to receive(:config_for_generator).and_return({
       'nginx' => watcher_config
     })
+    allow(mockWatcher).to receive(:revision).and_return(1)
     mockWatcher
   end
 
@@ -28,6 +29,7 @@ describe Synapse::ConfigGenerator::Nginx do
     allow(mockWatcher).to receive(:config_for_generator).and_return({
       'nginx' => watcher_config
     })
+    allow(mockWatcher).to receive(:revision).and_return(1)
     mockWatcher
   end
 

data/synapse-nginx.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
 
-  gem.add_runtime_dependency "synapse", "~> 0.14"
+  gem.add_runtime_dependency "synapse", "~> 0.14.4"
 
   gem.add_development_dependency "rake", "~> 0"
   gem.add_development_dependency "rspec", "~> 3.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: synapse-nginx
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Joseph Lynch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: synapse
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.14.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: 0.14.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement