distribute_reads 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d5f81a8379060ca196ed7550fa1dcafc706afc7
-  data.tar.gz: 78f4f6af58f6c6b184d1e56532e9c7d910846719
+  metadata.gz: b6f3a694f47520a9cf55b522c9a2acf4ec54be50
+  data.tar.gz: 20d1d2439e24112ac8d165ad79623edc65222f9d
 SHA512:
-  metadata.gz: 78b965141d1bd574726480b2c795131539fb1fcfa2f8456307f4f10ffc34b893826d2c822d170602588a19ab1b09f3d360ab016555f2b5d8e2e9fb92c4c09f40
-  data.tar.gz: ef38d4ed23658799456f197bff9d0a25ab044e81994aaa453a37495990d108e761e02de0ac97dd017115ba3b9ace8cefbacd157755de3ff80fc43e00ca77ce6c
+  metadata.gz: 5434b9aa41816fed52ed2cb9f4f18445b4d5242b9f8f78ad40830e00981ffa2cd46dad8fbe8e4e77f3b98716624075b4e0854bb99d19554fa07492c5f9c90b31
+  data.tar.gz: 7d4116b3c7a8c17a96cf6838fbf29f16a89454162a699786b73dba5e64475d757c749143f12b0275fef333329474db60e822343908e8fda4f34f51af8896d4d3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.1
+
+- Fixed lag check for Postgres 10
+- Added `replication_lag` method
+
 ## 0.2.0
 
 Breaking

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -145,9 +145,17 @@ distribute_reads(primary: true) do
 end
 ```
 
+## Reference
+
+Get replication lag
+
+```ruby
+DistributeReads.replication_lag
+```
+
 ## Thanks
 
-Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara and [Nick Elser](https://github.com/nickelser) for the write-through cache.
+Thanks to [TaskRabbit](https://github.com/taskrabbit) for Makara, [Sherin Kurian](https://github.com/sherinkurian) for the max lag option, and [Nick Elser](https://github.com/nickelser) for the write-through cache.
 
 ## History
 
@@ -161,3 +169,14 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/distribute_reads/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To test, run:
+
+```sh
+git clone https://github.com/ankane/distribute_reads.git
+cd distribute_reads
+createdb distribute_reads_test_primary
+createdb distribute_reads_test_replica
+bundle
+bundle exec rake
+```

data/distribute_reads.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Scale database reads with replicas in Rails"
   spec.homepage      = "https://github.com/ankane/distribute_reads"
+  spec.license       = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/distribute_reads/version.rb

@@ -1,3 +1,3 @@
 module DistributeReads
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/distribute_reads.rb

@@ -19,6 +19,12 @@ module DistributeReads
     lag_failover: false
   }
 
+  def self.replication_lag(connection: nil)
+    distribute_reads do
+      lag(connection: connection)
+    end
+  end
+
   def self.lag(connection: nil)
     raise DistributeReads::Error, "Don't use outside distribute_reads" unless Thread.current[:distribute_reads]
 
@@ -29,11 +35,23 @@ module DistributeReads
         warn "[distribute_reads] Multiple replicas available, lag only reported for one"
       end
 
+      # cache the version number
+      @server_version_num ||= {}
+      cache_key = connection.pool.object_id
+      @server_version_num[cache_key] ||= connection.execute("SHOW server_version_num").first["server_version_num"].to_i
+
+      lag_condition =
+        if @server_version_num[cache_key] >= 100000
+          "pg_last_wal_receive_lsn() = pg_last_wal_replay_lsn()"
+        else
+          "pg_last_xlog_receive_location() = pg_last_xlog_replay_location()"
+        end
+
       connection.execute(
         "SELECT CASE
-          WHEN NOT pg_is_in_recovery() OR pg_last_xlog_receive_location() = pg_last_xlog_replay_location() THEN 0
+          WHEN NOT pg_is_in_recovery() OR #{lag_condition} THEN 0
           ELSE EXTRACT (EPOCH FROM NOW() - pg_last_xact_replay_timestamp())
-        END AS lag"
+        END AS lag".squish
       ).first["lag"].to_f
     else
       raise DistributeReads::Error, "Option not supported with this adapter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distribute_reads
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: makara
@@ -105,6 +105,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - distribute_reads.gemspec
@@ -115,7 +116,8 @@ files:
 - lib/distribute_reads/job_methods.rb
 - lib/distribute_reads/version.rb
 homepage: https://github.com/ankane/distribute_reads
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []