fluent-plugin-f5-beacon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122e12c823083c65edad68dc9d478187601e9ae1b79659097834e55ab142d01e
-  data.tar.gz: de0235a5a604e94af08819f147b962431492684cdb92cf1cbcb41fc4b50c32db
+  metadata.gz: 0bd86674dfa590a76b417a6be99dac3515c158b394190d53884fc344791b6b83
+  data.tar.gz: 821a5864aa6bf080c58381804a93db0ca44e97b2befedb08fcdf1d44e7495fdb
 SHA512:
-  metadata.gz: 5fff45597fbbb9e9647d37166e70de5396c0b30c47550a6215047f2f7258636d36eca0c332795aae1d939132f92391747a0937cf0ae4a04e1d52ac98f4729e43
-  data.tar.gz: 7805ed6fcdbc99d23815f1d0edab6c5337df6fa6289fd5496ce7590ff4a09906939333156530aacb1f3aa5d37eae6c7f4ceaae3f68f18aa1a6299a35699fc12d
+  metadata.gz: d7becbd33d8ee90dc246cc36a511d1fe1209892e52de89b08098146ebbd6becd7931131d46ed40a8456c6a07c0dc9115938a707c452dcaf9ee82d7cbf3a41fdc
+  data.tar.gz: 9b155afff0ad311849ca79e6aeffd88ba09b6ce69016e7f7e5bac32c305c71a9320f73a6202eeaee55ce2a97281adaeac417b85ca79dc402b08bbb6547ba66a9

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,3 +1,5 @@
+![Ruby](https://github.com/f5devcentral/fluent-plugin-f5-beacon/workflows/Ruby/badge.svg) [![Gem Version](https://badge.fury.io/rb/fluent-plugin-f5-beacon.svg)](https://badge.fury.io/rb/fluent-plugin-f5-beacon)
+
 # Fluent::Plugin::Beacon, a plugin for [Fluentd](http://fluentd.org)
 
 fluent-plugin-f5-beacon is a buffered output plugin for Fluentd and F5 Beacon.
@@ -12,6 +14,17 @@ fluent-plugin-f5-beacon is a buffered output plugin for Fluentd and F5 Beacon.
 
     $ fluent-gem install fluent-plugin-f5-beacon
 
+Alternatively, with td-agent:
+
+    $ td-agent-gem install fluent-plugin-f5-beacon
+
+Or via source (swap `td-agent-gem` for `fluent-gem` as needed):
+
+    $ git clone https://github.com/f5devcentral/fluent-plugin-f5-beacon.git
+    $ cd fluent-plugin-f5-beacon/
+    $ fluent-gem build fluent-plugin-f5-beacon.gemspec
+    $ fluent-gem install fluent-plugin-f5-beacon-#.#.#.gem
+
 ## Usage
 
 Just like other regular output plugins, use type `f5-beacon` in your Fluentd configuration under `match` scope:
@@ -73,4 +86,4 @@ Details around buffering can be found [here](https://docs.fluentd.org/buffer).
 
 ```
 bundle exec rake test
-```
+```

data/fluent-plugin-f5-beacon.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = "fluent-plugin-f5-beacon"
-  s.version       = '0.0.1'
+  s.version       = '0.0.2'
   s.authors       = ["Matt Davey"]
   s.email         = ["m.davey@f5.com"]
   s.description   = %q{F5 Beacon output plugin for Fluentd}
@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "fluentd", [">= 1.0", "< 2"]
   s.add_runtime_dependency "influxdb", [">= 0.8.0", "< 1"]
 
-  s.add_development_dependency "rake"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "test-unit"
+  s.add_development_dependency "rake", '~> 13'
+  s.add_development_dependency "pry", '~> 0'
+  s.add_development_dependency "test-unit", '~> 3'
 end

data/lib/fluent/plugin/out_f5_beacon.rb

@@ -68,7 +68,7 @@ events and reset to zero for a new event with the different timestamp.
 
   def start
     super
-    log.info "Starting F5 Beacon plugin..."
+    log.info "starting F5 Beacon plugin..."
   end
 
   FORMATTED_RESULT_FOR_INVALID_RECORD = ''.freeze
@@ -78,7 +78,7 @@ events and reset to zero for a new event with the different timestamp.
     record.delete_if { |k, v| v.nil? || v.to_s.empty? }
 
     if record.empty?
-      log.warn "Skip record '#{record}' in '#{tag}', because record has no values"
+      log.warn "skip record '#{record}' in '#{tag}', because record has no values"
       FORMATTED_RESULT_FOR_INVALID_RECORD
     else
       [precision_time(time), record].to_msgpack
@@ -111,14 +111,16 @@ events and reset to zero for a new event with the different timestamp.
         record.each_pair do |k, v|
           if (@auto_tags && v.is_a?(String)) || @tag_keys.include?(k)
             # If the tag value is not nil, empty, or a space, add the tag
-            if v.to_s.strip != ''
-              tags[k] = v
+            normalized_value = v.to_s.strip
+            if normalized_value != ''
+              tags[k] = normalized_value
             end
           else
             values[k] = v
           end
         end
       end
+
       if @sequence_tag
         if @prev_timestamp == timestamp
           @seq += 1
@@ -129,8 +131,15 @@ events and reset to zero for a new event with the different timestamp.
         @prev_timestamp = timestamp
       end
 
+      values.delete_if do |k, v|
+        if v.is_a?(Array) || v.is_a?(Hash)
+          log.warn "array/hash field '#{k}' discarded; consider using a plugin to map"
+          true
+        end
+      end
+
       if values.empty?
-        log.warn "Skip record '#{record}', because InfluxDB requires at least one value in raw"
+        log.warn "skip record '#{record}', because one value is required"
         next
       end
 
@@ -153,7 +162,9 @@ events and reset to zero for a new event with the different timestamp.
       points << point
     end
 
-    write_points(points)
+    if points.length > 0
+      write_points(points)
+    end
   end
 
   def write_points(points)

data/test/plugin/test_out_f5_beacon.rb

@@ -217,7 +217,7 @@ class BeaconOutputTest < Test::Unit::TestCase
             timestamp: to_ns(time),
             series: 'input.influxdb',
             values: {'a' => 2},
-            tags: {'b' => 1, 'beacon-fluent-source' => 'test-source-name'},
+            tags: {'b' => '1', 'beacon-fluent-source' => 'test-source-name'},
           },
           {
             timestamp: to_ns(time),
@@ -233,7 +233,6 @@ class BeaconOutputTest < Test::Unit::TestCase
   def test_auto_tagging
     config_with_tags = %Q(
       #{CONFIG}
-
       auto_tags true
     )
 
@@ -276,7 +275,6 @@ class BeaconOutputTest < Test::Unit::TestCase
   def test_ignore_empty_values
     config_with_tags = %Q(
       #{CONFIG}
-
       tag_keys ["b"]
     )
 
@@ -296,7 +294,7 @@ class BeaconOutputTest < Test::Unit::TestCase
             :series    => 'input.influxdb',
 
             :values    => {'a' => 2},
-            :tags      => {'b' => 1, 'beacon-fluent-source' => 'test-source-name'},
+            :tags      => {'b' => '1', 'beacon-fluent-source' => 'test-source-name'},
           }
         ]
       ]
@@ -408,6 +406,68 @@ class BeaconOutputTest < Test::Unit::TestCase
     ], driver.instance.points)
   end
 
+  def test_nested_fields
+    driver = create_driver(CONFIG)
+
+    time = event_time("2020-01-02 13:14:15 UTC")
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1, 'b' => []})
+      driver.feed(time, {'a' => 2, 'c' => {'n' => 3}})
+    end
+
+    assert_equal([
+                     [
+                         [
+                             {
+                                 timestamp: to_ns(time),
+                                 series: 'input.influxdb',
+                                 values: {'a' => 1.0},
+                                 tags: {'beacon-fluent-source' => 'test-source-name'},
+                             },
+                             {
+                                 timestamp: to_ns(time),
+                                 series: 'input.influxdb',
+                                 values: {'a' => 2.0},
+                                 tags: {'beacon-fluent-source' => 'test-source-name'},
+                             },
+                         ]
+                     ]
+                 ], driver.instance.points)
+  end
+
+  def test_nested_tags
+    config_with_tags = %Q(
+    #{CONFIG}
+      tag_keys ["b"]
+    )
+    driver = create_driver(config_with_tags)
+
+    time = event_time("2020-01-02 13:14:15 UTC")
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1, 'b' => []})
+      driver.feed(time, {'a' => 2, 'b' => {'n' => 3}})
+    end
+
+    assert_equal([
+                     [
+                         [
+                             {
+                                 timestamp: to_ns(time),
+                                 series: 'input.influxdb',
+                                 values: {'a' => 1.0},
+                                 tags: {'beacon-fluent-source' => 'test-source-name', 'b' => '[]'},
+                             },
+                             {
+                                 timestamp: to_ns(time),
+                                 series: 'input.influxdb',
+                                 values: {'a' => 2.0},
+                                 tags: {'beacon-fluent-source' => 'test-source-name', 'b' => '{"n"=>3}'},
+                             },
+                         ]
+                     ]
+                 ], driver.instance.points)
+  end
+
   def to_ns(time)
     time * 1000000000
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-f5-beacon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Davey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -54,44 +54,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 description: F5 Beacon output plugin for Fluentd
 email:
 - m.davey@f5.com
@@ -99,6 +99,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
 - LICENSE