influxdb-client 1.7.0.pre.1015 → 1.8.0.pre.1240

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f7d3acebd47909037578d03e9c41a563328fc8a112019ef705417f4ce0b5dc7
-  data.tar.gz: f5fd4db9b000fb952eedd3ef7cbdc93fec3b5806101d819fd5c9febc33b95a68
+  metadata.gz: e49b8841c9ce5b13c24595d8fec2b2ed6eb8fe6676b606b9a10ef851d8ea98a9
+  data.tar.gz: 328d60cf43f6d5c1a43e5ac22945a76175c2752b370a5ca155a7236aedbe79be
 SHA512:
-  metadata.gz: 1da2d03a086ad92b8c7d82a29cdff3e228dd9140808df9b3ae1ed961670535ad8125d3345202b5dc6dad0f7d370057f24e8607f9bfc6479d756bbea61e04cebd
-  data.tar.gz: 1fe5947810dff9c7d97ec8eefc4d2d54d8e67db663c42e2ae606747f444bd96b9083beb1439e27fb2d2fd1c1fc6bae055d3ffd9816f0819b85039eb47b37f7a8
+  metadata.gz: 5a20d45c4dad7031e96bedb7ac76c3f146a17d8bec00fad5eba2d6cba062bcef172b5c389dce7db589b8d5481256cc246d652c48019fb6087b4d49f88c45c7d6
+  data.tar.gz: 707f373b6a72790a4e34b40490077b2da5e2bd1b2fd703d48237a1a80a4b5fe1053bb2b4263fb8f586e37c85544ac3b292f22d9c8012f101e0db56f483ba617c

data/.circleci/config.yml

@@ -82,6 +82,8 @@ jobs:
     docker:
       - image: << parameters.ruby-image >>
       - image: &influx-image quay.io/influxdb/<< parameters.influxdb-image >>
+        environment:
+          INFLUXD_HTTP_BIND_ADDRESS: :8086
     steps:
       - prepare
       - test:
@@ -89,13 +91,8 @@ jobs:
       - storing-test-results
 
   deploy-preview:
-    parameters:
-      influxdb-image:
-        type: string
-        default: *default-influxdb-image
     docker:
       - image: *default-ruby-image
-      - image: *influx-image
     steps:
       - run:
           name: Early return if this build is from a forked repository

data/.rubocop.yml

@@ -39,3 +39,5 @@ Metrics/CyclomaticComplexity:
   Max: 15
 Metrics/PerceivedComplexity:
   Max: 15
+Metrics/ParameterLists:
+  Max: 10

data/CHANGELOG.md

@@ -1,4 +1,18 @@
-## 1.7.0 [unreleased]
+## 1.8.0 [unreleased]
+
+### Features
+1. [#36](https://github.com/influxdata/influxdb-client-ruby/issues/36): Added support for default tags
+
+### API
+1. [#50](https://github.com/influxdata/influxdb-client-ruby/pull/50): Default port changed from 9999 -> 8086
+ 
+### Bug Fixes
+1. [#52](https://github.com/influxdata/influxdb-client-ruby/pull/52): Fixed aborting of background threads
+
+## 1.7.0 [2020-08-14]
+
+### Features
+1. [#47](https://github.com/influxdata/influxdb-client-ruby/pull/47): Added max_retries, max_retry_delay and exponential_base to WriteApi
 
 ## 1.6.0 [2020-07-17]
 

data/README.md

@@ -23,7 +23,7 @@ The client can be installed manually or with bundler.
 To install the client gem manually:
 
 ```
-gem install influxdb-client -v 1.6.0
+gem install influxdb-client -v 1.7.0
 ```
 
 ## Usage
@@ -33,7 +33,7 @@ gem install influxdb-client -v 1.6.0
 Use **InfluxDB::Client** to create a client connected to a running InfluxDB 2 instance.
 
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token')
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token')
 ```
 
 #### Client Options
@@ -50,7 +50,7 @@ client = InfluxDB2::Client.new('https://localhost:9999', 'my-token')
 | use_ssl | Turn on/off SSL for HTTP communication | bool | true |
 
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
   bucket: 'my-bucket',
   org: 'my-org',
   precision: InfluxDB2::WritePrecision::NANOSECOND)
@@ -68,7 +68,7 @@ The result retrieved by [QueryApi](https://github.com/influxdata/influxdb-client
 
 Synchronously executes the Flux query and return result as unprocessed String
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org')
 
@@ -78,7 +78,7 @@ result = query_api.query_raw(query: 'from(bucket:"' + bucket + '") |> range(star
 #### Synchronous query
 Synchronously executes the Flux query and return result as a Array of [FluxTables](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org')
 
@@ -89,7 +89,7 @@ result = query_api.query(query: 'from(bucket:"' + bucket + '") |> range(start: 1
 #### Query stream
 Synchronously executes the Flux query and return stream of [FluxRecord](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/flux_table.rb)
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org')
 
@@ -107,7 +107,7 @@ end
 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',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org',
                               precision: InfluxDB2::WritePrecision::NANOSECOND)
@@ -123,13 +123,17 @@ The writes are processed in batches which are configurable by `WriteOptions`:
 | --- | --- | --- |
 | batchSize | the number of data point to collect in batch | 1000 |
 | flush_interval | the number of milliseconds before the batch is written | 1000 |
-| retry_interval | the number of milliseconds to retry unsuccessful write. The retry interval is used when the InfluxDB server does not specify "Retry-After" header. | 1000 |
+| retry_interval | the number of milliseconds to retry unsuccessful write. The retry interval is used when the InfluxDB server does not specify "Retry-After" header. | 5000 |
 | jitter_interval | the number of milliseconds to increase the batch flush interval by a random amount | 0 |
-
+| max_retries | the number of max retries when write fails | 5 |
+| max_retry_delay | maximum delay when retrying write in milliseconds | 180000 |
+| exponential_base | the base for the exponential retry delay, the next delay is computed as `retry_interval * exponential_base^(attempts - 1) + random(jitter_interval)` | 5 |
 ```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',
+                                            batch_size: 10, flush_interval: 5_000, 
+                                            max_retries: 3, max_retry_delay: 15_000,
+                                            exponential_base: 2)
+client = InfluxDB2::Client.new('http://localhost:8086',
                                'my-token',
                                bucket: 'my-bucket',
                                org: 'my-org',
@@ -144,7 +148,7 @@ write_api.write(data: 'h2o,location=west value=33i 15')
 
 Configure default time precision:
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org',
                               precision: InfluxDB2::WritePrecision::NANOSECOND)
@@ -152,7 +156,7 @@ client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
 
 Configure precision per write:
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                                   bucket: 'my-bucket',
                                   org: 'my-org')
 
@@ -169,7 +173,7 @@ Allowed values for precision are:
 
 Default `bucket` and `organization` destination are configured via `InfluxDB::Client`:
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org')
 ```
@@ -177,7 +181,7 @@ client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
 but there is also possibility to override configuration per write:
 
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token')
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token')
 
 write_api = client.create_write_api
 write_api.write(data: 'h2o,location=west value=33i 15', bucket: 'production-data', org: 'customer-1')
@@ -193,7 +197,7 @@ The data could be written as:
 1. `Array` of above items
 
 ```ruby
-client = InfluxDB2::Client.new('https://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('https://localhost:8086', 'my-token',
                               bucket: 'my-bucket',
                               org: 'my-org',
                               precision: InfluxDB2::WritePrecision::NANOSECOND)
@@ -210,12 +214,42 @@ write_api = client.create_write_api
 write_api.write(data: ['h2o,location=west value=33i 15', point, hash])
 ```
 
+#### Default Tags
+
+Sometimes is useful to store same information in every measurement e.g. `hostname`, `location`, `customer`. 
+The client is able to use static value, app settings or env variable as a tag value.
+
+The expressions:
+- `California Miner` - static value
+- `${env.hostname}` - environment property
+
+##### Via API
+
+```ruby
+client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
+                               bucket: 'my-bucket',
+                               org: 'my-org',
+                               precision: InfluxDB2::WritePrecision::NANOSECOND,
+                               use_ssl: false,
+                               tags: { id: '132-987-655' })
+
+point_settings = InfluxDB2::PointSettings.new(default_tags: { customer: 'California Miner' })
+point_settings.add_default_tag('data_center', '${env.data_center}')
+
+write_api = client.create_write_api(write_options: InfluxDB2::SYNCHRONOUS,
+                                    point_settings: point_settings)
+
+write_api.write(data: InfluxDB2::Point.new(name: 'h2o')
+                                      .add_tag('location', 'europe')
+                                      .add_field('level', 2))
+```
+
 ### Delete data
 
 The [DeleteApi](https://github.com/influxdata/influxdb-client-ruby/blob/master/lib/influxdb2/client/delete_api.rb) supports deletes [points](https://v2.docs.influxdata.com/v2.0/reference/glossary/#point) from an InfluxDB bucket.
 
 ```ruby
-client = InfluxDB2::Client.new('http://localhost:9999', 'my-token',
+client = InfluxDB2::Client.new('http://localhost:8086', 'my-token',
                                bucket: 'my-bucket',
                                org: 'my-org',
                                precision: InfluxDB2::WritePrecision::NANOSECOND)

data/bin/influxdb-onboarding.sh

@@ -24,12 +24,12 @@
 set -e
 
 echo "Wait to start InfluxDB 2.0"
-wget -S --spider --tries=20 --retry-connrefused --waitretry=5 http://localhost:9999/metrics
+wget -S --spider --tries=20 --retry-connrefused --waitretry=5 http://localhost:8086/metrics
 
 echo
 echo "Post onBoarding request, to setup initial user (my-user@my-password), org (my-org) and bucketSetup (my-bucket)"
 echo
-curl -i -X POST http://localhost:9999/api/v2/setup -H 'accept: application/json' \
+curl -i -X POST http://localhost:8086/api/v2/setup -H 'accept: application/json' \
     -d '{
             "username": "my-user",
             "password": "my-password",

data/bin/influxdb-restart.sh

@@ -49,9 +49,10 @@ echo
 docker pull "${INFLUXDB_V2_IMAGE}" || true
 docker run \
        --detach \
+       --env INFLUXD_HTTP_BIND_ADDRESS=:8086 \
        --name influxdb_v2 \
        --network influx_network \
-       --publish 9999:9999 \
+       --publish 8086:8086 \
        "${INFLUXDB_V2_IMAGE}"
 
 #

data/lib/influxdb2/client/client.rb

@@ -29,10 +29,10 @@ module InfluxDB2
     # Instantiate a new InfluxDB client.
     #
     # @example Instantiate a client.
-    #   InfluxDBClient::Client.new(url: 'https://localhost:9999', token: 'my-token')
+    #   InfluxDBClient::Client.new(url: 'https://localhost:8086', token: 'my-token')
     #
     # @param [Hash] options The options to be used by the client.
-    # @param [String] url InfluxDB URL to connect to (ex. https://localhost:9999).
+    # @param [String] url InfluxDB URL to connect to (ex. https://localhost:8086).
     # @param [String] token Access Token used for authenticating/authorizing the InfluxDB request sent by client.
     #
     # @option options [String] :bucket the default destination bucket for writes
@@ -43,6 +43,7 @@ module InfluxDB2
     # @option options [Integer] :read_timeout Number of seconds to wait for one block of data to be read
     # @option options [Integer] :max_redirect_count Maximal number of followed HTTP redirects
     # @option options [bool] :use_ssl Turn on/off SSL for HTTP communication
+    # @option options [Hash] :tags Default tags which will be added to each point written by api.
     #   the body line-protocol
     def initialize(url, token, options = nil)
       @auto_closeable = []
@@ -57,8 +58,8 @@ module InfluxDB2
     # Write time series data into InfluxDB thought WriteApi.
     #
     # @return [WriteApi] New instance of WriteApi.
-    def create_write_api(write_options: InfluxDB2::SYNCHRONOUS)
-      write_api = WriteApi.new(options: @options, write_options: write_options)
+    def create_write_api(write_options: InfluxDB2::SYNCHRONOUS, point_settings: InfluxDB2::DEFAULT_POINT_SETTINGS)
+      write_api = WriteApi.new(options: @options, write_options: write_options, point_settings: point_settings)
       @auto_closeable.push(write_api)
       write_api
     end

data/lib/influxdb2/client/default_api.rb

@@ -83,6 +83,8 @@ module InfluxDB2
         else
           raise InfluxError.from_response(response)
         end
+      rescue *InfluxError::HTTP_ERRORS => error
+        raise InfluxError.from_error(error)
       ensure
         http.finish if http.started?
       end

data/lib/influxdb2/client/influx_error.rb

@@ -1,19 +1,33 @@
 module InfluxDB2
   # InfluxError that is raised during HTTP communication.
   class InfluxError < StandardError
+    HTTP_ERRORS = [
+      EOFError,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EINVAL,
+      Net::HTTPBadResponse,
+      Net::HTTPHeaderSyntaxError,
+      Net::ProtocolError,
+      Timeout::Error
+    ].freeze
+
     # HTTP status code
     attr_reader :code
     # Reference code unique to the error type
     attr_reader :reference
     # The Retry-After header describes when to try the request again.
     attr_reader :retry_after
+    # original error
+    attr_reader :original
 
-    def initialize(message:, code:, reference:, retry_after:)
+    def initialize(original = nil, message:, code:, reference:, retry_after:)
       super(message)
 
       @code = code
       @reference = reference
       @retry_after = retry_after
+      @original = original
     end
 
     def self.from_response(response)
@@ -27,5 +41,10 @@ module InfluxDB2
       obj = new(message: message, code: '', reference: '', retry_after: '')
       obj
     end
+
+    def self.from_error(error)
+      obj = new(error, message: error.message, code: '', reference: '', retry_after: '')
+      obj
+    end
   end
 end

data/lib/influxdb2/client/point.rb

@@ -138,7 +138,7 @@ module InfluxDB2
     def _escape_tags
       return if @tags.nil?
 
-      @tags.sort.to_h.map do |k, v|
+      @tags.sort_by { |x, _| x.to_s }.to_h.map do |k, v|
         key = _escape_key(k.to_s)
         value = _escape_key(v.to_s)
         if key.empty? || value.empty?

data/lib/influxdb2/client/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module InfluxDB2
-  VERSION = '1.7.0'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/lib/influxdb2/client/worker.rb

@@ -37,6 +37,7 @@ module InfluxDB2
           _check_background_queue
         end
       end
+      @thread_flush.abort_on_exception = true
 
       @thread_size = Thread.new do
         until api_client.closed
@@ -44,6 +45,7 @@ module InfluxDB2
           sleep 0.01
         end
       end
+      @thread_size.abort_on_exception = true
     end
 
     def push(payload)
@@ -94,22 +96,32 @@ module InfluxDB2
 
     def _write(data)
       data.each do |key, points|
-        _write_raw(key, points)
+        _write_raw(key, points, 1, @write_options.retry_interval)
       end
     end
 
-    def _write_raw(key, points)
+    def _write_raw(key, points, attempts, retry_interval)
       if @write_options.jitter_interval > 0
         jitter_delay = (@write_options.jitter_interval.to_f / 1_000) * rand
         sleep jitter_delay
       end
       @api_client.write_raw(points.join("\n"), precision: key.precision, bucket: key.bucket, org: key.org)
     rescue InfluxError => e
-      raise e if e.code.nil? || !(%w[429 503].include? e.code)
+      raise e if attempts > @write_options.max_retries
+      raise e if (e.code.nil? || e.code.to_i < 429) && !_connection_error(e.original)
+
+      timeout = if e.retry_after.empty?
+                  [retry_interval.to_f, @write_options.max_retry_delay.to_f].min / 1_000
+                else
+                  e.retry_after.to_f
+                end
 
-      timeout = e.retry_after.empty? ? @write_options.retry_interval.to_f / 1_000 : e.retry_after.to_f
       sleep timeout
-      _write_raw(key, points)
+      _write_raw(key, points, attempts + 1, retry_interval * @write_options.exponential_base)
+    end
+
+    def _connection_error(error)
+      InfluxError::HTTP_ERRORS.any? { |c| error.instance_of? c }
     end
   end
 end

data/lib/influxdb2/client/write_api.rb

@@ -34,21 +34,32 @@ module InfluxDB2
     # @param [Integer] retry_interval: number of milliseconds to retry unsuccessful write.
     #   The retry interval is used when the InfluxDB server does not specify "Retry-After" header.
     # @param [Integer] jitter_interval: the number of milliseconds to increase the batch flush interval
+    # @param [Integer] max_retries: max number of retries when write fails
+    # @param [Integer] max_retry_delay: maximum delay when retrying write in milliseconds
     #   by a random amount
-    def initialize(write_type: WriteType::SYNCHRONOUS, batch_size: 1_000, flush_interval: 1_000, retry_interval: 1_000,
-                   jitter_interval: 0)
+    # @param [Integer] exponential_base: base for the exponential retry delay, the next delay is computed as
+    #   "exponential_base^(attempts-1) + random(jitter_interval)"
+    def initialize(write_type: WriteType::SYNCHRONOUS, batch_size: 1_000, flush_interval: 1_000, retry_interval: 5_000,
+                   jitter_interval: 0, max_retries: 5, max_retry_delay: 180_000, exponential_base: 5)
       _check_not_negative('batch_size', batch_size)
       _check_not_negative('flush_interval', flush_interval)
       _check_not_negative('retry_interval', retry_interval)
       _check_positive('jitter_interval', jitter_interval)
+      _check_positive('max_retries', jitter_interval)
+      _check_positive('max_retry_delay', jitter_interval)
+      _check_positive('exponential_base', exponential_base)
       @write_type = write_type
       @batch_size = batch_size
       @flush_interval = flush_interval
       @retry_interval = retry_interval
       @jitter_interval = jitter_interval
+      @max_retries = max_retries
+      @max_retry_delay = max_retry_delay
+      @exponential_base = exponential_base
     end
 
-    attr_reader :write_type, :batch_size, :flush_interval, :retry_interval, :jitter_interval
+    attr_reader :write_type, :batch_size, :flush_interval, :retry_interval, :jitter_interval,
+                :max_retries, :max_retry_delay, :exponential_base
 
     def _check_not_negative(key, value)
       raise ArgumentError, "The '#{key}' should be positive or zero, but is: #{value}" if value <= 0
@@ -61,6 +72,30 @@ module InfluxDB2
 
   SYNCHRONOUS = InfluxDB2::WriteOptions.new(write_type: WriteType::SYNCHRONOUS)
 
+  # Settings to store default tags.
+  #
+  class PointSettings
+    # @param [Hash] default_tags Default tags which will be added to each point written by api.
+    def initialize(default_tags: nil)
+      @default_tags = default_tags || {}
+    end
+    attr_reader :default_tags
+
+    def add_default_tag(key, expression)
+      @default_tags[key] = expression
+    end
+
+    def self.get_value(value)
+      if value.start_with?('${env.')
+        ENV[value[6..-2]]
+      else
+        value
+      end
+    end
+  end
+
+  DEFAULT_POINT_SETTINGS = InfluxDB2::PointSettings.new
+
   # Precision constants.
   #
   class WritePrecision
@@ -82,10 +117,13 @@ module InfluxDB2
   class WriteApi < DefaultApi
     # @param [Hash] options The options to be used by the client.
     # @param [WriteOptions] write_options Write api configuration.
-    def initialize(options:, write_options: SYNCHRONOUS)
+    # @param [PointSettings] point_settings Default tags configuration
+    def initialize(options:, write_options: SYNCHRONOUS, point_settings: InfluxDB2::PointSettings.new)
       super(options: options)
       @write_options = write_options
+      @point_settings = point_settings
       @closed = false
+      @options[:tags].each { |key, value| point_settings.add_default_tag(key, value) } if @options.key?(:tags)
     end
     attr_reader :closed
 
@@ -129,6 +167,8 @@ module InfluxDB2
       _check('bucket', bucket_param)
       _check('org', org_param)
 
+      _add_default_tags(data)
+
       payload = _generate_payload(data, bucket: bucket_param, org: org_param, precision: precision_param)
       return nil if payload.nil?
 
@@ -212,6 +252,27 @@ module InfluxDB2
       end
     end
 
+    def _add_default_tags(data)
+      default_tags = @point_settings.default_tags
+
+      default_tags.each do |key, expression|
+        value = PointSettings.get_value(expression)
+        _add_default_tag(data, key, value)
+      end
+    end
+
+    def _add_default_tag(data, key, value)
+      if data.is_a?(Point)
+        data.add_tag(key, value)
+      elsif data.is_a?(Hash)
+        data[:tags][key] = value
+      elsif data.respond_to? :map
+        data.map do |item|
+          _add_default_tag(item, key, value)
+        end.reject(&:nil?)
+      end
+    end
+
     def _generate_payload(data, precision: nil, bucket: nil, org: nil)
       if data.nil?
         nil