fluent-plugin-influxdb-v2 1.9.0.pre.1209 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b407d41fb5654f68fb0e20c644516d23ae03d8cd20ee1782d48915d464f21592
-  data.tar.gz: 6e643a4848081996dea34367949a362da8ed96f65ebe82ecd28091f91e148729
+  metadata.gz: 7852d628e84fafe86b1e3e1890a1fd31a87508e89af9f7e86607ddce5e0c5489
+  data.tar.gz: 77981bcfec774bc114c95f80fd9c5e7a921b15d054693f9789d0ce788cfb1e9b
 SHA512:
-  metadata.gz: 5458e096b8c9375095056f367451f4fb681a642776d622bd1e6536674c67bd9f8d823c007330d2806a0dd64be9f970014d9b01c59370ba3b4f3eaaa9e47a725f
-  data.tar.gz: dadf7c323827adaac002f3d8f094150e92e6bb861e33299585d45f2b46704c91622e19ee31163ba6644c5e9d6cd9bacf1e11c50d1d4bd357e1c8d27596341110
+  metadata.gz: c635c6bdbe99637c7baa77e9f078391d148f06c5dac55694f970742f3d14dfe3e3eba3c4289d4cbd6569ded29efbf7753bd095fc9cc1062af8cdf59ef3fa9d4a
+  data.tar.gz: 364704ae7f9958a0965e7af45f1b2bc059644076cabde2ecb6c873c27b54292188b1cd1425935b9d928c9300fcb049ac537919f881d232b9c98a4dcf7bd55cbe

data/.circleci/config.yml

@@ -41,9 +41,9 @@ commands:
       - restore_cache:
           name: Restoring Gem Cache
           keys:
-            - &cache-key gem-cache-v2-{{ checksum "fluent-plugin-influxdb-v2.gemspec" }}-<< parameters.ruby-image >>
-            - gem-cache-v2-{{ checksum "fluent-plugin-influxdb-v2.gemspec" }}
-            - gem-cache-v2-
+            - &cache-key gem-cache-v3-{{ checksum "fluent-plugin-influxdb-v2.gemspec" }}-<< parameters.ruby-image >>
+            - gem-cache-v3-{{ checksum "fluent-plugin-influxdb-v2.gemspec" }}
+            - gem-cache-v3-
       - run:
           name: Install dependencies
           command: |
@@ -120,6 +120,9 @@ workflows:
       - tests-ruby:
           name: ruby-2.7
           ruby-image: "cimg/ruby:2.7"
+      - tests-ruby:
+          name: ruby-3.0
+          ruby-image: "cimg/ruby:3.0"
       - tests-ruby:
           name: ruby-2.6
       - tests-ruby:

data/.github/PULL_REQUEST_TEMPLATE

@@ -13,4 +13,4 @@ _Briefly describe your proposed changes:_
 - [ ] 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)
+- [ ] Sign [CLA](https://www.influxdata.com/legal/cla/) (if not already signed)

data/CHANGELOG.md

@@ -1,7 +1,16 @@
-## 1.9.0 [unreleased]
+## 1.9.0 [2021-11-26]
+
+### Features
+1. [#30](https://github.com/influxdata/influxdb-plugin-fluent/pull/30): Field value for `time_key` can be formatted date (`2021-11-05 09:15:49.487727165 +0000`, `2021-11-05T10:04:43.617216Z`)
+1. [#31](https://github.com/influxdata/influxdb-plugin-fluent/pull/31): Add possibility to use LineProtocol from Fluetd's record.
+
+### Dependencies
+1. [#30](https://github.com/influxdata/influxdb-plugin-fluent/pull/30): Update dependencies:
+    - influxdb-client to 2.1.0
 
 ### CI
 1. [#27](https://github.com/influxdata/influxdb-plugin-fluent/pull/27): Switch to next-gen CircleCI's convenience images
+1. [#30](https://github.com/influxdata/influxdb-plugin-fluent/pull/30): Add Ruby 3.0 into CI
 
 ## 1.8.0 [2021-08-20]
 

data/README.md

@@ -19,7 +19,7 @@ This repository contains the reference Fluentd plugin for the InfluxDB 2.0.
 The plugin is bundled as a gem and is hosted on [Rubygems](https://rubygems.org/gems/fluent-plugin-influxdb-v2).  You can install the gem as follows:
 
 ```
-fluent-gem install fluent-plugin-influxdb-v2 -v 1.8.0
+fluent-gem install fluent-plugin-influxdb-v2 -v 1.9.0
 ```
 
 ## Plugins
@@ -45,6 +45,7 @@ Store Fluentd event to InfluxDB 2 database.
 | field_cast_to_float | Turn on/off auto casting Integer value to Float. Helper to avoid mismatch error: 'series type mismatch: already Integer but got Float'. | bool | false |
 | time_precision | The time precision of timestamp. You should specify either second (s), millisecond (ms), microsecond (us), or nanosecond (ns). | String | ns |
 | time_key | A name of the record key that used as a 'timestamp' instead of event timestamp. If a record key doesn't exists or hasn't value then is used event timestamp. | String | nil |
+| line_protocol_key | A name of the record key that contains [LineProtocol](https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/). The value of this key is used for ingesting data into InfluxDB. If a record key doesn't exists or hasn't value then is used event timestamp. | String | nil |
 
 ##### Minimal configuration
 

data/fluent-plugin-influxdb-v2.gemspec

@@ -47,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_runtime_dependency 'fluentd', '~> 1.8'
-  spec.add_runtime_dependency 'influxdb-client', '1.12.0'
+  spec.add_runtime_dependency 'influxdb-client', '2.1.0'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'codecov', '~> 0.1.16'

data/lib/fluent/plugin/out_influxdb2.rb

@@ -73,6 +73,11 @@ class InfluxDBOutput < Fluent::Plugin::Output
   desc 'A name of the record key that used as a \'timestamp\' instead of event timestamp.' \
       'If a record key doesn\'t exists or hasn\'t value then is used event timestamp.'
 
+  config_param :line_protocol_key, :string, default: nil
+  desc 'A name of the record key that contains \'LineProtocol\'.' \
+      'The value of this key is used for ingesting data into InfluxDB.' \
+      'For more info see - https://docs.influxdata.com/influxdb/v2.0/reference/syntax/line-protocol/.'
+
   config_section :buffer do
     config_set_default :@type, DEFAULT_BUFFER_TYPE
     config_set_default :chunk_keys, ['tag']
@@ -121,28 +126,30 @@ class InfluxDBOutput < Fluent::Plugin::Output
     tag = chunk.metadata.tag
     bucket, measurement = expand_placeholders(chunk)
     chunk.msgpack_each do |time, record|
-      if time.is_a?(Integer)
-        time_formatted = time
+      if @line_protocol_key
+        points << record[@line_protocol_key] if record.include?(@line_protocol_key)
       else
-        nano_seconds = time.sec * 1e9
-        nano_seconds += time.nsec
-        time_formatted = @precision_formatter.call(nano_seconds)
-      end
-      point = InfluxDB2::Point
-              .new(name: measurement)
-      record.each_pair do |k, v|
-        if k.eql?(@time_key)
-          time_formatted = v
-        else
-          _parse_field(k, v, point)
+        time_formatted = _format_time(time)
+        point = InfluxDB2::Point
+                .new(name: measurement)
+        record.each_pair do |k, v|
+          if k.eql?(@time_key)
+            time_formatted = _format_time(v)
+          else
+            _parse_field(k, v, point)
+          end
+          point.add_tag('fluentd', tag) if @tag_fluentd
         end
-        point.add_tag('fluentd', tag) if @tag_fluentd
+        point.time(time_formatted, @precision)
+        points << point
       end
-      point.time(time_formatted, @precision)
-      points << point
     end
-    @write_api.write(data: points, bucket: bucket)
-    log.debug "Written points: #{points}"
+    if points.empty?
+      log.debug "Nothing to write for chunk: #{chunk.metadata}"
+    else
+      @write_api.write(data: points, bucket: bucket)
+      log.debug "Written points: #{points}"
+    end
   end
 
   private
@@ -157,6 +164,27 @@ class InfluxDBOutput < Fluent::Plugin::Output
     [bucket, measurement]
   end
 
+  def _format_time(time)
+    if time.is_a?(Integer)
+      time
+    elsif time.is_a?(Float)
+      time
+    elsif time.is_a?(Fluent::EventTime)
+      nano_seconds = time.sec * 1e9
+      nano_seconds += time.nsec
+      @precision_formatter.call(nano_seconds)
+    elsif time.is_a?(String)
+      begin
+        _format_time(Fluent::EventTime.parse(time))
+      rescue StandardError => e
+        log.debug "Cannot parse timestamp: #{time} due: #{e}"
+        time
+      end
+    else
+      time
+    end
+  end
+
   def _parse_field(key, value, point)
     if @tag_keys.include?(key)
       point.add_tag(key, value)

data/test/.rubocop.yml

@@ -0,0 +1,26 @@
+#
+# 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.
+#
+
+inherit_from: ../.rubocop.yml
+Metrics/ClassLength:
+  Enabled: false
+

data/test/influxdb/plugin/output_test.rb

@@ -381,6 +381,82 @@ class InfluxDBOutputTest < Minitest::Test
                      times: 1, body: 'h2o_tag,version=v.10 level=2i,location="europe" 1544897215000000000')
   end
 
+  def test_time_float
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      tag_keys ["version"]
+      time_key time
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver, 'location' => 'europe', 'level' => 2, 'version' => 'v.10',
+                             'time' => 1_544_897_215_000_000_000.123)
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_tag,version=v.10 level=2i,location="europe" 1544897215000000000')
+  end
+
+  def test_time_key_rfc_3339_format
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      tag_keys ["version"]
+      time_key time
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver, 'location' => 'europe', 'level' => 2, 'version' => 'v.10',
+                             'time' => '2021-11-05T10:04:43.617216Z')
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_tag,version=v.10 level=2i,location="europe" 1636106683617216000')
+  end
+
+  def test_time_key_log_format
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      tag_keys ["version"]
+      time_key time
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver, 'location' => 'europe', 'level' => 2, 'version' => 'v.10',
+                             'time' => '2021-11-05 09:15:49.487727165 +0000')
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_tag,version=v.10 level=2i,location="europe" 1636103749487727104')
+  end
+
+  def test_time_key_not_parseable
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      tag_keys ["version"]
+      time_key time
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver, 'location' => 'europe', 'level' => 2, 'version' => 'v.10',
+                             'time' => '1544897215000000000')
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'h2o_tag,version=v.10 level=2i,location="europe" 1544897215000000000')
+  end
+
   def test_field_cast_to_float
     stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
       .to_return(status: 204)
@@ -510,4 +586,39 @@ class InfluxDBOutputTest < Minitest::Test
     assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
                      times: 1, body: 'placeholder_h2o_tag level=2i,location="europe" 1444897215000000000')
   end
+
+  def test_line_protocol
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      time_precision ns
+      line_protocol_key lp_key
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver, 'location' => 'europe', 'level' => 2, 'lp_key' => 'mem,tag=1 field=10 102030')
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns',
+                     times: 1, body: 'mem,tag=1 field=10 102030')
+  end
+
+  def test_line_protocol_not_defined
+    stub_request(:any, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns')
+      .to_return(status: 204)
+    driver = create_driver(%(
+      @type influxdb2
+      token my-token
+      bucket my-bucket
+      org my-org
+      time_precision ns
+      line_protocol_key lp_key
+    ))
+    driver.run(default_tag: 'h2o_tag') do
+      emit_documents(driver)
+    end
+    assert_requested(:post, 'https://localhost:8086/api/v2/write?bucket=my-bucket&org=my-org&precision=ns', times: 0)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-influxdb-v2
 version: !ruby/object:Gem::Version
-  version: 1.9.0.pre.1209
+  version: 1.9.0
 platform: ruby
 authors:
 - Jakub Bednar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -201,6 +201,7 @@ files:
 - lib/fluent/plugin/fluent.rb
 - lib/fluent/plugin/out_influxdb2.rb
 - lib/fluent/plugin/version.rb
+- test/.rubocop.yml
 - test/influxdb/plugin/output_test.rb
 - test/influxdb/plugin/version_test.rb
 - test/test_helper.rb
@@ -222,15 +223,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: InfluxDB 2 output plugin for Fluentd
 test_files:
+- test/.rubocop.yml
 - test/influxdb/plugin/output_test.rb
 - test/influxdb/plugin/version_test.rb
 - test/test_helper.rb