distribute_reads 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff4bc7184278bc6c6669e532f036c74e117657510a701705b8850141f3a59ed
-  data.tar.gz: de8307fbf47c7660b3a7c2563f5b399cd55d4b524c23550d383073fb49df68f2
+  metadata.gz: 5e39298a87b7d9af49c9bb2dd6bffc0174a569d994432fc86c6668f00d7b8b4b
+  data.tar.gz: 585c11f47cb258259b91ff9b3f7917ff83d06b7b1a7010732174790adac45917
 SHA512:
-  metadata.gz: b9c651428a0fccf0a02f16a8d3ab587cf54f6f3f53156e89d5eea3800ca69a2228e3fdce72215526178fab80ecad3b3b8621cc381060c784ead4259910ad3f6f
-  data.tar.gz: 2ba6dd00743e9819a1bf5edfc35b7fdfa5d8c34a11cc4f4c563b55275fe45d4d7d0b706aa9f3b3b2516b60c98b811f81e647c318b668e67b43297f04bbdfe3fc
+  metadata.gz: 527754102963062a8988612b29f92d2f6bf7f1d4e8084536983c7bf6fdbdaf92db5ae17e4d5e6ee7ae92865b5ad4e98a13a9710675dec85d8365acfeae4e7e72
+  data.tar.gz: 81c561439791aab9164e62d928d2a3ea60d9bbf9deb6217938fd36632d842e138106c11aacfb951ee48435a02bb0503d542ff861b736f9fcdac7ebfebdb5d6f2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.4
+
+- Added support for Aurora MySQL replication lag
+- Added more logging
+
 ## 0.2.3
 
 - Added support for Makara 0.4

data/README.md

@@ -72,11 +72,25 @@ end
 
 You can pass any options as well.
 
+## Lazy Evaluation
+
+ActiveRecord uses [lazy evaluation](https://www.theodinproject.com/courses/ruby-on-rails/lessons/active-record-queries), which can delay the execution of a query to outside of a `distribute_reads` block. In this case, the primary will be used.
+
+```ruby
+users = distribute_reads { User.where(orders_count: 1) } # not executed yet
+```
+
+Call `to_a` inside the block ensure the query runs on a replica.
+
+```ruby
+users = distribute_reads { User.where(orders_count: 1).to_a }
+```
+
 ## Options
 
 ### Replica Lag
 
-Raise an error when replica lag is too high
+Raise an error when replica lag is too high (specified in seconds)
 
 ```ruby
 distribute_reads(max_lag: 3) do
@@ -131,12 +145,6 @@ At some point, you may wish to distribute reads by default.
 DistributeReads.by_default = true
 ```
 
-Once you do this, Makara will use the Rails cache to track its state. To reduce load on the Rails cache, use a write-through cache in front of it.
-
-```ruby
-Makara::Cache.store = DistributeReads::CacheStore.new
-```
-
 To make queries go to primary, use:
 
 ```ruby
@@ -147,7 +155,7 @@ end
 
 ## Reference
 
-Get replication lag
+Get replication lag in seconds
 
 ```ruby
 DistributeReads.replication_lag

data/lib/distribute_reads.rb

@@ -32,7 +32,7 @@ module DistributeReads
 
     replica_pool = connection.instance_variable_get(:@slave_pool)
     if replica_pool && replica_pool.connections.size > 1
-      warn "[distribute_reads] Multiple replicas available, lag only reported for one"
+      log "Multiple replicas available, lag only reported for one"
     end
 
     if %w(PostgreSQL PostGIS).include?(connection.adapter_name)
@@ -59,8 +59,21 @@ module DistributeReads
       begin
         # makara doesn't send SHOW queries to replica, so we must force it
         Thread.current[:distribute_reads][:replica] = true
-        status = connection.exec_query("SHOW SLAVE STATUS").to_hash.first
-        status ? status["Seconds_Behind_Master"].to_f : 0.0
+
+        @aurora_mysql ||= {}
+        cache_key = connection.pool.object_id
+
+        unless @aurora_mysql.key?(cache_key)
+          @aurora_mysql[cache_key] = connection.exec_query("SHOW VARIABLES LIKE 'aurora_version'").to_hash.any?
+        end
+
+        if @aurora_mysql[cache_key]
+          status = connection.exec_query("SELECT Replica_lag_in_msec FROM mysql.ro_replica_status WHERE Server_id = @@aurora_server_id").to_hash.first
+          status ? status["Replica_lag_in_msec"].to_f / 1000.0 : 0.0
+        else
+          status = connection.exec_query("SHOW SLAVE STATUS").to_hash.first
+          status ? status["Seconds_Behind_Master"].to_f : 0.0
+        end
       ensure
         Thread.current[:distribute_reads][:replica] = replica_value
       end
@@ -69,6 +82,10 @@ module DistributeReads
     end
   end
 
+  def self.log(message)
+    warn "[distribute_reads] #{message}"
+  end
+
   # private
   def self.makara3?
     unless defined?(@makara3)

data/lib/distribute_reads/appropriate_pool.rb

@@ -5,12 +5,19 @@ module DistributeReads
         if Thread.current[:distribute_reads][:replica]
           if @slave_pool.completely_blacklisted?
             raise DistributeReads::NoReplicasAvailable, "No replicas available" if Thread.current[:distribute_reads][:failover] == false
+            DistributeReads.log "No replicas available. Falling back to master pool."
             @master_pool
           else
             @slave_pool
           end
         elsif Thread.current[:distribute_reads][:primary] || needs_master?(*args) || (blacklisted = @slave_pool.completely_blacklisted?)
-          raise DistributeReads::NoReplicasAvailable, "No replicas available" if blacklisted && Thread.current[:distribute_reads][:failover] == false
+          if blacklisted
+            if Thread.current[:distribute_reads][:failover] == false
+              raise DistributeReads::NoReplicasAvailable, "No replicas available"
+            else
+              DistributeReads.log "No replicas available. Falling back to master pool."
+            end
+          end
           stick_to_master(*args) if DistributeReads.by_default
           @master_pool
         elsif in_transaction?

data/lib/distribute_reads/global_methods.rb

@@ -21,20 +21,23 @@ module DistributeReads
         if max_lag && !options[:primary]
           Array(options[:lag_on] || [ActiveRecord::Base]).each do |base_model|
             if DistributeReads.lag(connection: base_model.connection) > max_lag
+              message = "Replica lag over #{max_lag} seconds#{options[:lag_on] ? " on #{base_model.name} connection" : ""}"
+
               if options[:lag_failover]
                 # TODO possibly per connection
                 Thread.current[:distribute_reads][:primary] = true
                 Thread.current[:distribute_reads][:replica] = false
+                DistributeReads.log "#{message}. Falling back to master pool."
                 break
               else
-                raise DistributeReads::TooMuchLag, "Replica lag over #{max_lag} seconds#{options[:lag_on] ? " on #{base_model.name} connection" : ""}"
+                raise DistributeReads::TooMuchLag, message
               end
             end
           end
         end
 
         value = yield
-        warn "[distribute_reads] Call `to_a` inside block to execute query on replica" if value.is_a?(ActiveRecord::Relation) && !previous_value
+        DistributeReads.log "Call `to_a` inside block to execute query on replica" if value.is_a?(ActiveRecord::Relation) && !previous_value
         value
       ensure
         Thread.current[:distribute_reads] = previous_value

data/lib/distribute_reads/job_methods.rb

@@ -18,7 +18,7 @@ module DistributeReads
 
     class_methods do
       def distribute_reads(*args)
-        around_perform do |job, block|
+        around_perform do |_job, block|
           distribute_reads(*args) { block.call }
         end
       end

data/lib/distribute_reads/version.rb

@@ -1,3 +1,3 @@
 module DistributeReads
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distribute_reads
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makara