influxdb 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32eb764b72ed6837bac8c3ef72761d12770294f2
-  data.tar.gz: 5cbc233bb93ffd39948d4a0bbd522916c189a04d
+  metadata.gz: 170699d0f9146ed26b14a22529a83d4be2df7978
+  data.tar.gz: 1ec1e335f75c706b36e1f6a65ac5828d4fdf5f19
 SHA512:
-  metadata.gz: 650cf3793a7bca2653ff4b999f6dfa0ec4cd3d1bc95f1bd9e00e402d10bf546ce091d9f88becd633567b9d9c1c69c8b789185b332366e92e91efdc57db841691
-  data.tar.gz: f78046d93b485dc1e124a0d4a6076e3ed214dc02462ce44f6d9ab5e32fac0928216ab5bd917e5d3ab12bfb02f42000f65dedde1e4648b7e32bd139117ac19755
+  metadata.gz: d58bfb635ef085fc5e395f83539f0076ba68d77b919fba914c0000abe7c88447513b13f5298a213c5d32af20e0afb78ffa98a936f26bff8cc5d9d5fd89a4e99c
+  data.tar.gz: b560584b6c9722b4d5729715cdaa3b87a0485296d787383847b18be0b7b5761417e746cfb7f8fb223fa6722e3735fca2ab2ec1d776611db8a050bf48886b85aa

data/CHANGELOG.md

@@ -6,10 +6,17 @@ For the full commit log, [see here](https://github.com/influxdata/influxdb-ruby/
 
 - None yet.
 
-## v0.4.3, released 2017-10-21
+## v0.5.0, released 2017-10-21
 
-- Added warning to `InfluxDB::Write::Async#write`, marking the currently
-  ignored arguments as significant in the next release.
+- Add support for precision, retention policy and database parameters
+  to async writer (#140, #202 @rockclimber73)
+
+  **Attention** You may need to validate that your calls to the write
+  API (`InfluxDB::Client#write`, `#write_point`, `#write_points`) don't
+  accidentally included a precision, RP, and/or database argument. These
+  arguments were ignored until now. This is likely if you have changed
+  your client instance configuration in the past, when you added a
+  `async: true`. **Updating might cause data inconsistencies!**
 
 ## v0.4.2, released 2017-09-26
 

data/README.md

@@ -256,7 +256,7 @@ retention = '1h.cpu'
 influxdb.write_points(data, precision, retention)
 ```
 
-Write asynchronously (note that a retention policy cannot be specified for asynchronous writes):
+Write asynchronously:
 
 ``` ruby
 database = 'site_development'

data/lib/influxdb/version.rb

@@ -1,3 +1,3 @@
 module InfluxDB # :nodoc:
-  VERSION = "0.4.3".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/influxdb/writer/async.rb

@@ -12,17 +12,8 @@ module InfluxDB
       end
 
       def write(data, precision = nil, retention_policy = nil, database = nil)
-        if !precision.nil? || !retention_policy.nil? || !database.nil?
-          opts = {
-            precision:        precision,
-            retention_policy: retention_policy,
-            database:         database,
-          }.delete_if { |_, v| v.nil? }
-          warn_arguments(opts)
-        end
-
         data = data.is_a?(Array) ? data : [data]
-        data.map { |p| worker.push(p) }
+        data.map { |payload| worker.push(payload, precision, retention_policy, database) }
       end
 
       WORKER_MUTEX = Mutex.new
@@ -36,17 +27,6 @@ module InfluxDB
         end
       end
 
-      private
-
-      def warn_arguments(**which)
-        warn [
-          "You are using influxdb in async mode, and have provided one or",
-          "more parameter which are currently ignored:",
-          which.map { |k, v| format "%s=%p", k, v }.join(", "),
-          "Starting with v0.5.0, these arguments will no longer be ignored.",
-        ].join(" ")
-      end
-
       class Worker
         attr_reader :client,
                     :queue,
@@ -77,8 +57,8 @@ module InfluxDB
           spawn_threads!
         end
 
-        def push(payload)
-          queue.push(payload)
+        def push(payload, precision = nil, retention_policy = nil, database = nil)
+          queue.push([payload, precision, retention_policy, database])
         end
 
         def current_threads
@@ -117,22 +97,28 @@ module InfluxDB
           end
 
           loop do
-            data = []
+            data = {}
 
-            while data.size < max_post_points && !queue.empty?
+            while data.all? { |_, points| points.size < max_post_points } && !queue.empty?
               begin
-                p = queue.pop(true)
-                data.push p
+                payload, precision, retention_policy, database = queue.pop(true)
+                key = {
+                  db: database,
+                  pr: precision,
+                  rp: retention_policy,
+                }
+                data[key] ||= []
+                data[key] << payload
               rescue ThreadError
                 next
               end
             end
 
-            return if data.empty?
+            return if data.values.flatten.empty?
 
             begin
-              log(:debug) { "Found data in the queue! (#{data.length} points)" }
-              client.write(data.join("\n"), nil)
+              log(:debug) { "Found data in the queue! (#{sizes(data)})" }
+              write(data)
             rescue StandardError => e
               log :error, "Cannot write data: #{e.inspect}"
             end
@@ -145,6 +131,25 @@ module InfluxDB
           log(:debug) { "Thread exiting, flushing queue." }
           check_background_queue until queue.empty?
         end
+
+        private
+
+        def write(data)
+          data.each do |key, points|
+            client.write(points.join("\n"), key[:pr], key[:rp], key[:db])
+          end
+        end
+
+        def sizes(data)
+          data.map do |key, points|
+            without_nils = key.reject { |_, v| v.nil? }
+            if without_nils.empty?
+              "#{points.size} points"
+            else
+              "#{key} => #{points.size} points"
+            end
+          end.join(', ')
+        end
       end
     end
   end

data/spec/influxdb/cases/async_client_spec.rb

@@ -35,6 +35,52 @@ describe InfluxDB::Client do
       # but cannot be less than 2 due to MAX_POST_POINTS limit
       expect(post_request).to have_been_requested.at_least_times(2)
     end
+
+    context 'when precision, retention_policy and database are given' do
+      let(:series)           { 'test_series' }
+      let(:precision)        { 'test_precision' }
+      let(:retention_policy) { 'test_period' }
+      let(:database)         { 'test_database' }
+
+      it "writes aggregate payload to the client" do
+        queue = Queue.new
+        allow(client).to receive(:write) do |*args|
+          queue.push(args)
+        end
+
+        subject.write_point(series, { values: { t: 60 } }, precision, retention_policy, database)
+        subject.write_point(series, { values: { t: 61 } }, precision, retention_policy, database)
+
+        Timeout.timeout(worker.sleep_interval) do
+          expect(queue.pop).to eq ["#{series} t=60i\n#{series} t=61i", precision, retention_policy, database]
+        end
+      end
+
+      context 'when different precision, retention_policy and database are given' do
+        let(:precision2)        { 'test_precision2' }
+        let(:retention_policy2) { 'test_period2' }
+        let(:database2)         { 'test_database2' }
+
+        it "writes separated payloads for each {precision, retention_policy, database} set" do
+          queue = Queue.new
+          allow(client).to receive(:write) do |*args|
+            queue.push(args)
+          end
+
+          subject.write_point(series, { values: { t: 60 } }, precision,  retention_policy,  database)
+          subject.write_point(series, { values: { t: 61 } }, precision2, retention_policy,  database)
+          subject.write_point(series, { values: { t: 62 } }, precision,  retention_policy2, database)
+          subject.write_point(series, { values: { t: 63 } }, precision,  retention_policy,  database2)
+
+          Timeout.timeout(worker.sleep_interval) do
+            expect(queue.pop).to eq ["#{series} t=60i", precision,  retention_policy,  database]
+            expect(queue.pop).to eq ["#{series} t=61i", precision2, retention_policy,  database]
+            expect(queue.pop).to eq ["#{series} t=62i", precision,  retention_policy2, database]
+            expect(queue.pop).to eq ["#{series} t=63i", precision,  retention_policy,  database2]
+          end
+        end
+      end
+    end
   end
 
   describe "async options" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: influxdb
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Todd Persen