influxdb-client 1.7.0 → 1.8.0.pre.1289

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b50934b34cc909aeca6a81954008b97c2ef804f55eb2951be7b95a55ed1bf4a7
-  data.tar.gz: 7d577a4244304aa48fe239a26d30386d7c6015b11b16481496a914ed9ec500bf
+  metadata.gz: a455a34d672abc44886ea962bda79e859e60456a3861576b3f342d9ca5feaa6c
+  data.tar.gz: 7528d2af2482bb4f08f494de9aa2bfd6321df632a8f6cc73bce60fd9f55f6e82
 SHA512:
-  metadata.gz: 382f963d82a1aa3ed1ea15721149b7f7f6e3bdccf5f7f00448f266b679c7e7e570122c512a9e56e773149777725faaa5dca18b7f474ef2d1a9baf9dfb20ffe11
-  data.tar.gz: dca83d8dd539549a5b28e56febdb55fb0c5b01c081d5bafe85b24521ef6025133f2778cb3bb0c33f540372f2c08e47794727be83bd6d3adbdab8a6ccbb13e29c
+  metadata.gz: 7fe3874a990d419a02d907298287219e0b89aa7c54d57477e0d9617fae6124560ac459582325342416f3a7a0579daf961c3768e8b19ccc575bdc08e062c8ed97
+  data.tar.gz: f198f24814f717406ce58435554c751b697b66e389d7218d9b63b1c7dc457e4f542bb5320e228e4af86183bcad0a008c16a2d8b18f589e9727a3bc5b2315b150

data/.circleci/config.yml

@@ -78,10 +78,12 @@ jobs:
         default: &default-ruby-image "circleci/ruby:2.6-stretch"
       influxdb-image:
         type: string
-        default: &default-influxdb-image "influxdb:2.0.0-beta"
+        default: &default-influxdb-image "influxdb:2.0.0-rc"
     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/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.8.0 [unreleased]
+
+### Features
+1. [#36](https://github.com/influxdata/influxdb-client-ruby/issues/36): Added support for default tags
+1. [#53](https://github.com/influxdata/influxdb-client-ruby/pull/53): Default strategy for batching worker is best-effort
+
+### 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

data/README.md

@@ -33,7 +33,7 @@ gem install influxdb-client -v 1.7.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)
@@ -128,12 +128,13 @@ The writes are processed in batches which are configurable by `WriteOptions`:
 | 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 |
+| batch_abort_on_exception | the batching worker will be aborted after failed retry strategy | false |
 ```ruby
 write_options = InfluxDB2::WriteOptions.new(write_type: InfluxDB2::WriteType::BATCHING,
                                             batch_size: 10, flush_interval: 5_000, 
                                             max_retries: 3, max_retry_delay: 15_000,
                                             exponential_base: 2)
-client = InfluxDB2::Client.new('http://localhost:9999',
+client = InfluxDB2::Client.new('http://localhost:8086',
                                'my-token',
                                bucket: 'my-bucket',
                                org: 'my-org',
@@ -148,7 +149,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)
@@ -156,7 +157,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')
 
@@ -173,7 +174,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')
 ```
@@ -181,7 +182,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')
@@ -197,7 +198,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)
@@ -214,12 +215,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

@@ -27,7 +27,7 @@ DEFAULT_DOCKER_REGISTRY="quay.io/influxdb/"
 DOCKER_REGISTRY="${DOCKER_REGISTRY:-$DEFAULT_DOCKER_REGISTRY}"
 
 DEFAULT_INFLUXDB_V2_REPOSITORY="influxdb"
-DEFAULT_INFLUXDB_V2_VERSION="2.0.0-beta"
+DEFAULT_INFLUXDB_V2_VERSION="2.0.0-rc"
 INFLUXDB_V2_REPOSITORY="${INFLUXDB_V2_REPOSITORY:-$DEFAULT_INFLUXDB_V2_REPOSITORY}"
 INFLUXDB_V2_VERSION="${INFLUXDB_V2_VERSION:-$DEFAULT_INFLUXDB_V2_VERSION}"
 INFLUXDB_V2_IMAGE=${DOCKER_REGISTRY}${INFLUXDB_V2_REPOSITORY}:${INFLUXDB_V2_VERSION}
@@ -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/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

@@ -31,14 +31,13 @@ module InfluxDB2
 
       @queue_event.push(true)
 
-      Thread.abort_on_exception = true
-
       @thread_flush = Thread.new do
         until api_client.closed
           sleep @write_options.flush_interval.to_f / 1_000
           _check_background_queue
         end
       end
+      @thread_flush.abort_on_exception = @write_options.batch_abort_on_exception
 
       @thread_size = Thread.new do
         until api_client.closed
@@ -46,6 +45,7 @@ module InfluxDB2
           sleep 0.01
         end
       end
+      @thread_size.abort_on_exception = @write_options.batch_abort_on_exception
     end
 
     def push(payload)

data/lib/influxdb2/client/write_api.rb

@@ -39,8 +39,10 @@ module InfluxDB2
     #   by a random amount
     # @param [Integer] exponential_base: base for the exponential retry delay, the next delay is computed as
     #   "exponential_base^(attempts-1) + random(jitter_interval)"
+    # @param [Boolean] batch_abort_on_exception: batching worker will be aborted after failed retry strategy
     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)
+                   jitter_interval: 0, max_retries: 5, max_retry_delay: 180_000, exponential_base: 5,
+                   batch_abort_on_exception: false)
       _check_not_negative('batch_size', batch_size)
       _check_not_negative('flush_interval', flush_interval)
       _check_not_negative('retry_interval', retry_interval)
@@ -56,10 +58,11 @@ module InfluxDB2
       @max_retries = max_retries
       @max_retry_delay = max_retry_delay
       @exponential_base = exponential_base
+      @batch_abort_on_exception = batch_abort_on_exception
     end
 
     attr_reader :write_type, :batch_size, :flush_interval, :retry_interval, :jitter_interval,
-                :max_retries, :max_retry_delay, :exponential_base
+                :max_retries, :max_retry_delay, :exponential_base, :batch_abort_on_exception
 
     def _check_not_negative(key, value)
       raise ArgumentError, "The '#{key}' should be positive or zero, but is: #{value}" if value <= 0
@@ -72,6 +75,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
@@ -93,10 +120,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
 
@@ -140,6 +170,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?
 
@@ -223,6 +255,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

data/test/influxdb/client_test.rb

@@ -30,41 +30,41 @@ class ClientTest < Minitest::Test
   end
 
   def test_client_new
-    refute_nil InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    refute_nil InfluxDB2::Client.new('http://localhost:8086', 'my-token')
   end
 
   def test_client_hash
-    client1 = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
-    client2 = InfluxDB2::Client.new('http://localhost:9999', 'my-token-diff')
+    client1 = InfluxDB2::Client.new('http://localhost:8086', 'my-token')
+    client2 = InfluxDB2::Client.new('http://localhost:8086', 'my-token-diff')
 
     refute_equal client1.hash, client2.hash
     assert_equal client1.hash, client1.hash
   end
 
   def test_client_eq
-    client1 = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
-    client2 = InfluxDB2::Client.new('http://localhost:9999', 'my-token-diff')
+    client1 = InfluxDB2::Client.new('http://localhost:8086', 'my-token')
+    client2 = InfluxDB2::Client.new('http://localhost:8086', 'my-token-diff')
 
     refute_equal client1, client2
     assert_equal client1, client1
   end
 
   def test_client_options
-    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token')
 
-    assert_equal 'http://localhost:9999', client.options[:url]
+    assert_equal 'http://localhost:8086', client.options[:url]
     assert_equal 'my-token', client.options[:token]
   end
 
   def test_close
-    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token')
 
     assert_equal true, client.close!
     assert_equal true, client.close!
   end
 
   def test_get_write_api
-    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token')
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token')
 
     write_api = client.create_write_api
 
@@ -73,7 +73,7 @@ class ClientTest < Minitest::Test
   end
 
   def test_health
-    client = InfluxDB2::Client.new('http://localhost:9999', 'my-token', use_ssl: false)
+    client = InfluxDB2::Client.new('http://localhost:8086', 'my-token', use_ssl: false)
 
     health = client.health
     assert_equal 'ready for queries and writes', health.message