influxdb-client 1.1.0.pre.380 → 1.1.0.pre.459

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac72d5aebd28ce183dfff99beb7e258c3aaa4948f582b0b9616ec2cb0e780321
-  data.tar.gz: d2cc1d8a74144cd95b17b6d9d1596cba76c1d65b9d561305f271e57eb3837295
+  metadata.gz: 8e48f3342f7073bb62a53a8665fb07e2ec1ce83d35badca54004db480b85eb5d
+  data.tar.gz: 4eda6f75500868cbb32cb7cb46abdf63e20cc3332952d5504d8d9e3e520860e7
 SHA512:
-  metadata.gz: f17c6a9611e9528d38d32213d0c94fae2735fddd0a538fa35710f9d24fce84acac98457e2687007df94aa035669ae4d01770ec053482be23f6bbd57570901649
-  data.tar.gz: 3d1b49817267f41d88f1c5d6704e45955bd059d4a807b9a3a3eb2f82a4d88f243cfe7106ea97924ab8561c41c9eb0880a3ed4e088bfea1dcfdfb8ae3d6462191
+  metadata.gz: 6fb77e117b116a87d58d3d8cc2bfb27c3557eeea523a4518892a6d6821653eea41bb0bf0c115a11039ef9bf6ec110deca808247c0d2bfc2cc7f73f04cebe72eb
+  data.tar.gz: 7ec5e8619def15d7e67d09c6ee068761aee2c902fc9be753ebba3cb173371f824717d778186a7ede2baf4db1a899f9df20ce0092920fb737035b44aa6d878030

data/CHANGELOG.md

@@ -3,6 +3,7 @@
 ### Features
 1. [#14](https://github.com/influxdata/influxdb-client-ruby/issues/14): Added QueryApi
 2. [#17](https://github.com/influxdata/influxdb-client-ruby/issues/17): Added possibility to stream query result
+3. [#19](https://github.com/influxdata/influxdb-client-ruby/issues/19): Added WriteOptions and possibility to batch write
  
 ## 1.0.0.beta [2020-01-17]
 

data/README.md

@@ -105,6 +105,7 @@ end
 ```
 
 ### Writing data
+The [WriteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/write_api.rb) supports synchronous and batching writes into InfluxDB 2.0. In default api uses synchronous write. To enable batching you can use WriteOption.
 
 ```ruby
 client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
@@ -116,6 +117,28 @@ write_api = client.create_write_api
 write_api.write(data: 'h2o,location=west value=33i 15')
 ```
 
+#### Batching
+The writes are processed in batches which are configurable by `WriteOptions`:
+
+| Property | Description | Default Value |
+| --- | --- | --- |
+| **batchSize** | the number of data point to collect in batch | 1000 |
+| **flushInterval** | the number of milliseconds before the batch is written | 1000 |
+
+```ruby
+write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                            batch_size: 10, flush_interval: 5_000)
+client = InfluxDB2::Client.new('http://localhost:9999',
+                               'my-token',
+                               bucket: 'my-bucket',
+                               org: 'my-org',
+                               precision: InfluxDB2::WritePrecision::NANOSECOND,
+                               use_ssl: false)
+
+write_api = client.create_write_api(write_options: write_options)
+write_api.write(data: 'h2o,location=west value=33i 15')
+```
+
 #### Time precision
 
 Configure default time precision:
@@ -135,7 +158,6 @@ client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
 write_api = client.create_write_api
 write_api.write(data: 'h2o,location=west value=33i 15', precision: InfluxDB2::WritePrecision::SECOND)
 ```
-
 Allowed values for precision are:
 - `InfluxDB::WritePrecision::NANOSECOND` for nanosecond
 - `InfluxDB::WritePrecision::MICROSECOND` for microsecond

data/lib/influxdb2/client/client.rb

@@ -45,6 +45,7 @@ module InfluxDB2
     # @option options [bool] :use_ssl Turn on/off SSL for HTTP communication
     #   the body line-protocol
     def initialize(url, token, options = nil)
+      @auto_closeable = []
       @options = options ? options.dup : {}
       @options[:url] = url if url.is_a? String
       @options[:token] = token if token.is_a? String
@@ -56,8 +57,10 @@ module InfluxDB2
     # Write time series data into InfluxDB thought WriteApi.
     #
     # @return [WriteApi] New instance of WriteApi.
-    def create_write_api
-      WriteApi.new(options: @options)
+    def create_write_api(write_options: InfluxDB2::SYNCHRONOUS)
+      write_api = WriteApi.new(options: @options, write_options: write_options)
+      @auto_closeable.push(write_api)
+      write_api
     end
 
     # Get the Query client.
@@ -72,6 +75,7 @@ module InfluxDB2
     # @return [ true ] Always true.
     def close!
       @closed = true
+      @auto_closeable.each(&:close!)
       true
     end
   end

data/lib/influxdb2/client/point.rb

@@ -45,6 +45,7 @@ module InfluxDB2
       @time = time
       @precision = precision
     end
+    attr_reader :precision
 
     # Create DataPoint instance from specified data.
     #

data/lib/influxdb2/client/worker.rb

@@ -0,0 +1,89 @@
+# The 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.
+
+module InfluxDB2
+  # Worker for handling write batching queue
+  #
+  class Worker
+    def initialize(api_client, write_options)
+      @api_client = api_client
+      @write_options = write_options
+
+      @queue = Queue.new
+      @queue_event = Queue.new
+
+      @queue_event.push(true)
+
+      @thread_flush = Thread.new do
+        until api_client.closed
+          sleep @write_options.flush_interval / 1_000
+          check_background_queue
+        end
+      end
+
+      @thread_size = Thread.new do
+        until api_client.closed
+          check_background_queue(size: true) if @queue.length >= @write_options.batch_size
+          sleep 0.01
+        end
+      end
+    end
+
+    def push(payload)
+      @queue.push(payload)
+    end
+
+    def check_background_queue(size: false, flush_all: false)
+      @queue_event.pop
+      data = {}
+      points = 0
+
+      if size && @queue.length < @write_options.batch_size
+        @queue_event.push(true)
+        return
+      end
+
+      while (flush_all || points < @write_options.batch_size) && !@queue.empty?
+        begin
+          item = @queue.pop(true)
+          key = item.key
+          data[key] = [] unless data.key?(key)
+          data[key] << item.data
+          points += 1
+        rescue ThreadError
+          return
+        end
+      end
+
+      write(data) unless data.values.flatten.empty?
+      @queue_event.push(true)
+    end
+
+    def flush_all
+      check_background_queue(flush_all: true) unless @queue.empty?
+    end
+
+    def write(data)
+      data.each do |key, points|
+        @api_client.write_raw(points.join("\n"), precision: key.precision, bucket: key.bucket, org: key.org)
+      end
+    end
+  end
+end

data/lib/influxdb2/client/write_api.rb

@@ -17,8 +17,31 @@
 # 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.
+require_relative 'worker'
 
 module InfluxDB2
+  module WriteType
+    SYNCHRONOUS = 1
+    BATCHING = 2
+  end
+
+  # Creates write api configuration.
+  #
+  # @param write_type: methods of write (batching, asynchronous, synchronous)
+  # @param batch_size: the number of data point to collect in batch
+  # @param flush_interval: flush data at least in this interval
+  class WriteOptions
+    def initialize(write_type: WriteType::SYNCHRONOUS, batch_size: 1_000, flush_interval: 1_000)
+      @write_type = write_type
+      @batch_size = batch_size
+      @flush_interval = flush_interval
+    end
+
+    attr_reader :write_type, :batch_size, :flush_interval
+  end
+
+  SYNCHRONOUS = InfluxDB2::WriteOptions.new(write_type: WriteType::SYNCHRONOUS)
+
   # Precision constants.
   #
   class WritePrecision
@@ -39,9 +62,13 @@ module InfluxDB2
   #
   class WriteApi < DefaultApi
     # @param [Hash] options The options to be used by the client.
-    def initialize(options:)
+    # @param [WriteOptions] write_options Write api configuration.
+    def initialize(options:, write_options: SYNCHRONOUS)
       super(options: options)
+      @write_options = write_options
+      @closed = false
     end
+    attr_reader :closed
 
     # Write data into specified Bucket.
     #
@@ -83,33 +110,108 @@ module InfluxDB2
       _check('bucket', bucket_param)
       _check('org', org_param)
 
-      payload = _generate_payload(data)
+      payload = _generate_payload(data, bucket: bucket_param, org: org_param, precision: precision_param)
       return nil if payload.nil?
 
+      if WriteType::BATCHING == @write_options.write_type
+        _worker.push(payload)
+      else
+        write_raw(payload, precision: precision_param, bucket: bucket_param, org: org_param)
+      end
+    end
+
+    # @return [ true ] Always true.
+    def close!
+      _worker.flush_all unless _worker.nil?
+      @closed = true
+      true
+    end
+
+    # @param [String] payload data as String
+    # @param [WritePrecision] precision The precision for the unix timestamps within the body line-protocol
+    # @param [String] bucket specifies the destination bucket for writes
+    # @param [String] org specifies the destination organization for writes
+    def write_raw(payload, precision: nil, bucket: nil, org: nil)
+      precision_param = precision || @options[:precision]
+      bucket_param = bucket || @options[:bucket]
+      org_param = org || @options[:org]
+      _check('precision', precision_param)
+      _check('bucket', bucket_param)
+      _check('org', org_param)
+
+      return nil unless payload.instance_of?(String) || payload.empty?
+
       uri = URI.parse(File.join(@options[:url], '/api/v2/write'))
       uri.query = URI.encode_www_form(bucket: bucket_param, org: org_param, precision: precision_param.to_s)
 
       _post(payload, uri)
     end
 
+    # Item for batching queue
+    class BatchItem
+      def initialize(key, data)
+        @key = key
+        @data = data
+      end
+      attr_reader :key, :data
+    end
+
+    # Key for batch item
+    class BatchItemKey
+      def initialize(bucket, org, precision = DEFAULT_WRITE_PRECISION)
+        @bucket = bucket
+        @org = org
+        @precision = precision
+      end
+      attr_reader :bucket, :org, :precision
+
+      def ==(other)
+        @bucket == other.bucket && @org == other.org && @precision == other.precision
+      end
+
+      alias eql? ==
+
+      def hash
+        @bucket.hash ^ @org.hash ^ @precision.hash # XOR
+      end
+    end
+
     private
 
-    def _generate_payload(data)
+    WORKER_MUTEX = Mutex.new
+    def _worker
+      return nil unless @write_options.write_type == WriteType::BATCHING
+
+      return @worker if @worker
+
+      WORKER_MUTEX.synchronize do
+        # this return is necessary because the previous mutex holder
+        # might have already assigned the @worker
+        return @worker if @worker
+
+        @worker = Worker.new(self, @write_options)
+      end
+    end
+
+    def _generate_payload(data, precision: nil, bucket: nil, org: nil)
       if data.nil?
         nil
       elsif data.is_a?(Point)
-        data.to_line_protocol
+        _generate_payload(data.to_line_protocol, bucket: bucket, org: org, precision: data.precision ||
+            DEFAULT_WRITE_PRECISION)
       elsif data.is_a?(String)
         if data.empty?
           nil
+        elsif @write_options.write_type == WriteType::BATCHING
+          BatchItem.new(BatchItemKey.new(bucket, org, precision), data)
         else
           data
         end
       elsif data.is_a?(Hash)
-        _generate_payload(Point.from_hash(data))
+        _generate_payload(Point.from_hash(data), bucket: bucket, org: org, precision: precision)
       elsif data.respond_to? :map
         data.map do |item|
-          _generate_payload(item)
+          _generate_payload(item, bucket: bucket, org: org, precision: precision)
         end.reject(&:nil?).join("\n".freeze)
       end
     end

data/test/influxdb/write_api_batching_test.rb

@@ -0,0 +1,153 @@
+# The 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.
+
+require 'test_helper'
+
+class WriteApiBatchingTest < MiniTest::Test
+  def setup
+    WebMock.disable_net_connect!
+
+    @write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
+                                                 batch_size: 2, flush_interval: 5_000)
+    @client = InfluxDB2::Client.new('http://localhost:9999',
+                                    'my-token',
+                                    bucket: 'my-bucket',
+                                    org: 'my-org',
+                                    precision: InfluxDB2::WritePrecision::NANOSECOND,
+                                    use_ssl: false)
+
+    @write_client = @client.create_write_api(write_options: @write_options)
+  end
+
+  def teardown
+    @client.close!
+
+    assert_equal true, @write_client.closed
+
+    WebMock.reset!
+  end
+
+  def test_batch_size
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=4.0 4')
+
+    sleep(1)
+
+    request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=2.0 2'
+    request2 = "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=4.0 4'
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request1)
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request2)
+  end
+
+  def test_batch_size_group_by
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=s')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns')
+      .to_return(status: 204)
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket2&org=my-org-a&precision=ns')
+      .to_return(status: 204)
+
+    bucket = 'my-bucket'
+    bucket2 = 'my-bucket2'
+    org_a = 'my-org-a'
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1', bucket: bucket, org: 'my-org')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2', bucket: bucket, org: 'my-org',
+                        precision: InfluxDB2::WritePrecision::SECOND)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3', bucket: bucket, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=4.0 4', bucket: bucket, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=5.0 5', bucket: bucket2, org: org_a)
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=6.0 6', bucket: bucket, org: org_a)
+
+    sleep(1)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=s',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns',
+                     times: 1, body: "h2o_feet,location=coyote_creek level\\ water_level=3.0 3\n" \
+                    'h2o_feet,location=coyote_creek level\\ water_level=4.0 4')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket2&org=my-org-a&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=5.0 5')
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org-a&precision=ns',
+                     times: 1, body: 'h2o_feet,location=coyote_creek level\\ water_level=6.0 6')
+  end
+
+  def test_flush_interval
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    request1 = "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+               'h2o_feet,location=coyote_creek level\\ water_level=2.0 2'
+    request2 = 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3'
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+
+    sleep(1)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request1)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    sleep(2)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 0, body: request2)
+
+    sleep(3)
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: request2)
+  end
+
+  def test_flush_all_by_close_client
+    stub_request(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=1.0 1')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=2.0 2')
+    @write_client.write(data: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 0, body: 'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+
+    @client.close!
+
+    assert_requested(:post, 'http://localhost:9999/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: "h2o_feet,location=coyote_creek level\\ water_level=1.0 1\n" \
+                     "h2o_feet,location=coyote_creek level\\ water_level=2.0 2\n" \
+                     'h2o_feet,location=coyote_creek level\\ water_level=3.0 3')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxdb-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.380
+  version: 1.1.0.pre.459
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,6 +157,7 @@ files:
 - lib/influxdb2/client/point.rb
 - lib/influxdb2/client/query_api.rb
 - lib/influxdb2/client/version.rb
+- lib/influxdb2/client/worker.rb
 - lib/influxdb2/client/write_api.rb
 - test/influxdb/client_test.rb
 - test/influxdb/flux_csv_parser_test.rb
@@ -164,6 +165,7 @@ files:
 - test/influxdb/query_api_integration_test.rb
 - test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
+- test/influxdb/write_api_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
 - test/test_helper.rb
@@ -200,6 +202,7 @@ test_files:
 - test/influxdb/query_api_integration_test.rb
 - test/influxdb/query_api_stream_test.rb
 - test/influxdb/query_api_test.rb
+- test/influxdb/write_api_batching_test.rb
 - test/influxdb/write_api_integration_test.rb
 - test/influxdb/write_api_test.rb
 - test/test_helper.rb