influxdb-client 1.6.0 → 1.8.0.pre.1218

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20cf81cf2a456afa228493a541328eec06036b33f89f1c55097a8c0fa49369c9
-  data.tar.gz: c810d0079ec382f83f3d8907be4510b48592646f62fc483c791f88494e3b2a3e
+  metadata.gz: 83e17817aa71b99fc2c00c9810031c7a1acbf86e3560b91e1ad277f0213ddd66
+  data.tar.gz: d58024ec56f0766126c06b829a49dce98ff83f85dda23990f0cd05d9f9917fc1
 SHA512:
-  metadata.gz: 0f44b8975945893946b73abd129ec6f2c3da49bb3d8dc45511de53d9b3d7a022fde44396f02da682d404c0778070a703d4c4fdab1e07187763a080d3850dc7d1
-  data.tar.gz: 03d1c1463657348726eb82b8aaa061fe0b96be2a2d3baae6e90717bf090923a6e1823cbe70d0017c0023bf785379088077f6ba2eaf2866dbcd8a2e33f89da275
+  metadata.gz: 40fede72bad180624c088af3ee92f005ff2dfc357e330012f17b06284b939f8017c018b79bb36e3112a646361b57f492c8d7e45bb402b657ece43796657b7fe4
+  data.tar.gz: a1636a76698949e303c749fdcc2936faa31928d140baac04d0449fc1248afbf9c1b4fa2ff427dadd20932ffed512311abad7d682328caf96e39a68f19c096947

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/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+
+<!--
+
+Thank you for reporting a bug. 
+
+* Please add a :+1: or comment on a similar existing bug report instead of opening a new one.
+    * https://github.com/influxdata/influxdb-client-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3Abug+
+* Please check whether the bug can be reproduced with the latest release.
+* The fastest way to fix a bug is to open a Pull Request.
+    * https://github.com/influxdata/influxdb-client-ruby/pulls
+
+-->
+
+__Steps to reproduce:__
+List the minimal actions needed to reproduce the behavior.
+
+1. ...
+2. ...
+3. ...
+
+__Expected behavior:__
+Describe what you expected to happen.
+
+__Actual behavior:__
+Describe What actually happened.
+
+__Specifications:__
+ - Client Version:
+ - InfluxDB Version:
+ - Platform:

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,28 @@
+---
+name: Feature request
+about: Opening a feature request kicks off a discussion
+---
+
+<!--
+
+Thank you for suggesting an idea to improve this client. 
+
+* Please add a :+1: or comment on a similar existing feature request instead of opening a new one.
+    * https://github.com/influxdata/influxdb-client-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+is%3Aclosed+sort%3Aupdated-desc+label%3A%22enhancement%22+
+
+-->
+
+__Proposal:__
+Short summary of the feature.
+
+__Current behavior:__
+Describe what currently happens.
+
+__Desired behavior:__
+Describe what you want.
+
+__Alternatives considered:__
+Describe other solutions or features you considered.
+
+__Use case:__
+Why is this important (helps with prioritizing requests)?

data/.github/PULL_REQUEST_TEMPLATE

@@ -1,8 +1,16 @@
 Closes #
 
+## Proposed Changes
+
 _Briefly describe your proposed changes:_
 
+## Checklist
+
+<!-- Checkboxes below this note can be erased if not applicable to your Pull Request. -->
+
 - [ ] CHANGELOG.md updated
 - [ ] Rebased/mergeable
-- [ ] Tests pass
-- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)
+- [ ] A test has been added if appropriate
+- [ ] `rake test` completes successfully
+- [ ] Commit messages are in [semantic format](https://seesparkbox.com/foundry/semantic_commit_messages)
+- [ ] Sign [CLA](https://influxdata.com/community/cla/) (if not already signed)

data/.github/semantic.yml

@@ -0,0 +1,3 @@
+# docs: https://github.com/probot/semantic-pull-requests#configuration
+# Always validate the PR title AND all the commits
+titleAndCommits: true

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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
+ 
+## 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]
 
 ### Bug Fixes

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.6.0'.freeze
+  VERSION = '1.8.0'.freeze
 end