fluent-plugin-f5-beacon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 122e12c823083c65edad68dc9d478187601e9ae1b79659097834e55ab142d01e
+  data.tar.gz: de0235a5a604e94af08819f147b962431492684cdb92cf1cbcb41fc4b50c32db
+SHA512:
+  metadata.gz: 5fff45597fbbb9e9647d37166e70de5396c0b30c47550a6215047f2f7258636d36eca0c332795aae1d939132f92391747a0937cf0ae4a04e1d52ac98f4729e43
+  data.tar.gz: 7805ed6fcdbc99d23815f1d0edab6c5337df6fa6289fd5496ce7590ff4a09906939333156530aacb1f3aa5d37eae6c7f4ceaae3f68f18aa1a6299a35699fc12d

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.rakeTasks
+*.iml

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-f5-beacon.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 F5 Networks, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,76 @@
+# Fluent::Plugin::Beacon, a plugin for [Fluentd](http://fluentd.org)
+
+fluent-plugin-f5-beacon is a buffered output plugin for Fluentd and F5 Beacon.
+
+## Requirements
+
+| fluent-plugin-f5-beacon | fluentd | ruby |
+|------------------------|---------|------|
+| * | >= v1.0.0  | >= 2.3 |
+
+## Installation
+
+    $ fluent-gem install fluent-plugin-f5-beacon
+
+## Usage
+
+Just like other regular output plugins, use type `f5-beacon` in your Fluentd configuration under `match` scope:
+
+`@type` `f5_beacon`
+
+--------------
+
+**Options:**
+
+`source_name`: The name of the source within Beacon.  This is required.
+
+`token`: The Beacon ingestion token to be used.  This is required.
+
+`measurement`: The measurement/series to use.  The default is nil.  If not specified, Fluentd's tag is used.
+
+`time_key`: Use the value of this tag if it exists in the event instead of the event timestamp.
+
+`auto_tags`: Enable/disable auto-tagging behavior which makes strings tags.  The default is false.
+
+`tag_keys`: The names of the keys to use as tags instead of fields.
+
+`sequence_tag`: The name of the tag whose value is incremented for the consecutive simultaneous events and reset to zero for a new event with the different timestamp.
+
+`cast_number_to_float`: Enable/disable casting numbers to floats.  Within a measurement, a given field must be integer or float.  If your pipeline cannot unify the record value, this parameter may help avoid errors due to type conflicts.
+
+## Configuration Example
+
+```
+<match mylog.*>
+  @type f5_beacon
+  source_name server1
+  token a-123456789#token
+  tag_keys ["key1", "key2"]
+</match>
+```
+
+## Cache and multiprocess
+
+The plugin is a buffered output plugin.  So additional buffer configuration (with default values) looks like:
+
+```
+<buffer>
+  @type memory
+  chunk_limit_size 524288 # 512 * 1024
+  chunk_limit_records 1024
+  flush_interval 60
+  retry_limit 17
+  retry_wait 1.0
+  num_threads 1
+</buffer>
+```
+
+Details around buffering can be found [here](https://docs.fluentd.org/buffer).
+
+---
+
+## Unit tests
+
+```
+bundle exec rake test
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task default: :test

data/SUPPORT.md

@@ -0,0 +1 @@
+Maintenance and F5 Technical Support of the F5 code is provided only if the software (i) is unmodified; and (ii) has been marked as F5 Supported in SOL80012344, (https://support.f5.com/csp/article/K80012344). Support will only be provided to customers who have an existing support contract, purchased separately, subject to F5’s support policies available at http://www.f5.com/about/guidelines-policies/ and http://askf5.com.

data/TERMS OF USE.txt

@@ -0,0 +1 @@
+THIS LICENSE AGREEMENT IS ENTERED INTO BETWEEN THE SUBMITTING PARTY AND F5 NETWORKS, INC. AND THE SUBMITTING PARTY AGREES TO BE BOUND BY THE TERMS OF THIS AGREEMENT BY SUBMITTING, POSTING, DOWNLOADING, COPYING, MODIFYING, INPUTTING, INSTALLATION, UPLOAD OR OTHER USE OF F5 MATERIALS AND THE SUBMISSIONS. IF YOU DO NOT AGREE TO THE FOREGOING, DO NOT POST THE SUBMISSIONS OR USE THE F5 MATERIALS.

data/fluent-plugin-f5-beacon.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "fluent-plugin-f5-beacon"
+  s.version       = '0.0.1'
+  s.authors       = ["Matt Davey"]
+  s.email         = ["m.davey@f5.com"]
+  s.description   = %q{F5 Beacon output plugin for Fluentd}
+  s.summary       = %q{A buffered output plugin for Fluentd and F5 Beacon}
+  s.homepage      = "https://github.com/f5devcentral/fluent-plugin-f5-beacon"
+  s.license       = "Apache-2.0"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  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"
+end

data/lib/fluent/plugin/out_f5_beacon.rb

@@ -0,0 +1,224 @@
+#
+# Copyright 2020 F5 Networks, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# encoding: UTF-8
+require 'date'
+require 'fluent/mixin'
+require 'fluent/plugin/output'
+require 'influxdb'
+require 'net/http'
+require 'openssl'
+require 'uri'
+
+module Fluent::Plugin class BeaconOutput < Output
+  Fluent::Plugin.register_output('f5_beacon', self)
+
+  helpers :compat_parameters
+
+  DEFAULT_BUFFER_TYPE = "memory"
+
+  config_param :endpoint, :string, default: 'https://ingestion.ovr.prd.f5aas.com:50443/beacon/v1/ingest-metrics',
+               desc: "The target endpoint for sending data."
+  config_param :token, :string, desc: "The Beacon access token.  This is a required field."
+  config_param :source_name, :string, desc: "The source name shown in Beacon.  This is a required field."
+  config_param :measurement, :string, default: nil,
+               desc: "The measurement name to insert event.  If not specified, fluentd's tag is used."
+  config_param :time_key, :string, default: 'time',
+               desc: 'Use value of this tag if it exists in event instead of event timestamp.'
+  config_param :auto_tags, :bool, default: false,
+               desc: "Enable/disable auto-tagging behavior which makes strings tags."
+  config_param :tag_keys, :array, default: [],
+               desc: "The names of the keys to use as tags."
+  config_param :sequence_tag, :string, default: nil,
+               desc: <<-DESC
+The name of the tag whose value is incremented for the consecutive simultaneous
+events and reset to zero for a new event with the different timestamp.
+  DESC
+  config_param :cast_number_to_float, :bool, default: false,
+               desc: "Enable/disable casting numbers to float."
+
+  config_section :buffer do
+    config_set_default :@type, DEFAULT_BUFFER_TYPE
+    config_set_default :chunk_keys, ['tag']
+  end
+
+  def initialize
+    super
+    @seq = 0
+    @prev_timestamp = nil
+  end
+
+  def configure(conf)
+    compat_parameters_convert(conf, :buffer)
+    super
+    raise Fluent::ConfigError, "'tag' in chunk_keys is required." if not @chunk_key_tag
+  end
+
+  def start
+    super
+    log.info "Starting F5 Beacon plugin..."
+  end
+
+  FORMATTED_RESULT_FOR_INVALID_RECORD = ''.freeze
+
+  def format(tag, time, record)
+    # Remove nil/empty values
+    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"
+      FORMATTED_RESULT_FOR_INVALID_RECORD
+    else
+      [precision_time(time), record].to_msgpack
+    end
+  end
+
+  def shutdown
+    super
+  end
+
+  def formatted_to_msgpack_binary
+    true
+  end
+
+  def multi_workers_ready?
+    true
+  end
+
+  def write(chunk)
+    points = []
+    tag = chunk.metadata.tag
+    chunk.msgpack_each do |time, record|
+      timestamp = record.delete(@time_key) || time
+      if tag_keys.empty? && !@auto_tags
+        values = record
+        tags = {}
+      else
+        values = {}
+        tags = {}
+        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
+            end
+          else
+            values[k] = v
+          end
+        end
+      end
+      if @sequence_tag
+        if @prev_timestamp == timestamp
+          @seq += 1
+        else
+          @seq = 0
+        end
+        tags[@sequence_tag] = @seq
+        @prev_timestamp = timestamp
+      end
+
+      if values.empty?
+        log.warn "Skip record '#{record}', because InfluxDB requires at least one value in raw"
+        next
+      end
+
+      if @cast_number_to_float
+        values.each do |key, value|
+          if value.is_a?(Integer)
+            values[key] = Float(value)
+          end
+        end
+      end
+
+      tags["beacon-fluent-source"] = @source_name
+
+      point = {
+          timestamp: timestamp,
+          series: @measurement || tag,
+          values: values,
+          tags: tags,
+      }
+      points << point
+    end
+
+    write_points(points)
+  end
+
+  def write_points(points)
+    payload = serialize(points)
+    handle_payload(payload)
+  end
+
+  def serialize(points)
+    points.map do |point|
+      InfluxDB::PointValue.new(point).dump
+    end.join("\n".freeze)
+  end
+
+  def precision_time(time)
+    # nsec is supported from v0.14
+    time * (10 ** 9) + (time.is_a?(Integer) ? 0 : time.nsec)
+  end
+
+  def handle_payload(payload)
+    req, uri = create_request(payload)
+    send_request(req, uri)
+  end
+
+  def create_request(payload)
+    uri = URI.parse(@endpoint)
+
+    req = Net::HTTP.const_get("Post").new(uri.request_uri)
+    req['X-F5-Ingestion-Token'] = @token
+    req['Content-Type'] = 'text/plain'
+    req.body = payload
+
+    return req, uri
+  end
+
+  def send_request(req, uri)
+    res = nil
+
+    begin
+      res = Net::HTTP.start(uri.host, uri.port, **http_opts(uri)) {|http| http.request(req) }
+
+    rescue => e # rescue all StandardErrors
+      # server didn't respond
+      log.warn "Net::HTTP.#{req.method.capitalize} raises exception: #{e.class}, '#{e.message}'"
+      raise e
+    else
+      unless res and res.is_a?(Net::HTTPSuccess)
+        res_summary = if res
+                        "#{res.code} #{res.message} #{res.body}"
+                      else
+                        "res=nil"
+                      end
+        log.warn "failed to #{req.method} #{uri} (#{res_summary})"
+      end #end unless
+    end # end begin
+  end # end send_request
+
+  def http_opts(uri)
+    opts = {
+        :use_ssl => true,
+        :verify_mode => OpenSSL::SSL::VERIFY_PEER,
+        :ssl_version => :TLSv1_2,
+        :ciphers => ['AES128-GCM-SHA256', 'AES128-SHA256', 'AES256-GCM-SHA384', 'AES256-SHA256', 'ECDHE-RSA-AES128-GCM-SHA256', 'ECDHE-RSA-AES128-SHA256', 'ECDHE-RSA-AES256-GCM-SHA384', 'ECDHE-RSA-AES256-SHA384'],
+    }
+    opts
+  end
+
+end
+end

data/test/plugin/test_out_f5_beacon.rb

@@ -0,0 +1,415 @@
+#
+# Copyright 2020 F5 Networks, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'test_helper'
+
+class BeaconOutputTest < Test::Unit::TestCase
+  class TestBeaconOutput < Fluent::Plugin::BeaconOutput
+    attr_reader :points
+    attr_reader :req
+    attr_reader :uri
+
+    def configure(conf)
+      @points = []
+      super
+    end
+
+    def format(tag, time, record)
+      super
+    end
+
+    def formatted_to_msgpack_binary
+      super
+    end
+
+    def write(chunk)
+      super
+    end
+
+    def write_points(points)
+      @points << [points]
+      super
+    end
+
+    def send_request(req, uri)
+      @req = req
+      @uri = uri
+    end
+  end
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    source_name test-source-name
+    token test-token
+  ]
+
+  def create_raw_driver(conf=CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::BeaconOutput).configure(conf)
+  end
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::Driver::Output.new(TestBeaconOutput).configure(conf)
+  end
+
+  def test_configure
+    driver = create_raw_driver %[
+      source_name test-source-name
+      token test-token
+      endpoint https://localhost/beacon/v1/ingest-metrics
+      token a-0123456789#fake-token
+    ]
+    assert_equal('https://localhost/beacon/v1/ingest-metrics', driver.instance.config['endpoint'])
+    assert_equal('a-0123456789#fake-token', driver.instance.config['token'])
+  end
+
+  def test_configure_without_tag_chunk_key
+    assert_raise(Fluent::ConfigError) do
+      create_raw_driver %[
+        source_name test-source-name
+        token test-token
+        <buffer arbitrary_key>
+          @type memory
+        </buffer>
+      ]
+    end
+  end
+
+  def test_configure_without_source
+    assert_raise(Fluent::ConfigError) do
+      create_raw_driver %[
+        token test-token
+      ]
+    end
+  end
+
+  def test_configure_without_token
+    assert_raise(Fluent::ConfigError) do
+      create_raw_driver %[
+        source_name test-source-name
+      ]
+    end
+  end
+
+  def test_format
+    driver = create_driver(CONFIG)
+    time = event_time('2011-01-02 13:14:15 UTC')
+
+    driver.run(default_tag: 'test') do
+      driver.feed(time, {'a' => 1,'b' => nil})
+      driver.feed(time, {'a' => 2})
+    end
+
+    assert_equal [[to_ns(time), {'a' => 1}].to_msgpack,
+                  [to_ns(time), {'a' => 2}].to_msgpack], driver.formatted
+  end
+
+  sub_test_case "#write" do
+    test "buffer" do
+      driver = create_driver(CONFIG)
+
+      time = event_time("2011-01-02 13:14:15 UTC")
+      driver.run(default_tag: 'input.influxdb') do
+        driver.feed(time, {'a' => 1})
+        driver.feed(time, {'a' => 2})
+      end
+
+      assert_equal([
+        [
+          [
+            {
+              timestamp: to_ns(time),
+              series: 'input.influxdb',
+              tags: {'beacon-fluent-source' => 'test-source-name'},
+              values: {'a' => 1}
+            },
+            {
+              timestamp: to_ns(time),
+              series: 'input.influxdb',
+              tags: {'beacon-fluent-source' => 'test-source-name'},
+              values: {'a' => 2}
+            },
+          ]
+        ]
+      ], driver.instance.points)
+    end
+  end
+
+  def test_write_with_measurement
+    config_with_measurement = %Q(
+      #{CONFIG}
+      measurement test
+    )
+
+    driver = create_driver(config_with_measurement)
+
+    time = event_time('2011-01-02 13:14:15 UTC')
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1})
+      driver.feed(time, {'a' => 2})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => to_ns(time),
+            :series    => 'test',
+            :tags      => {'beacon-fluent-source' => 'test-source-name'},
+            :values    => {'a' => 1}
+          },
+          {
+            :timestamp => to_ns(time),
+            :series    => 'test',
+            :tags      => {'beacon-fluent-source' => 'test-source-name'},
+            :values    => {'a' => 2}
+          },
+        ]
+      ]
+    ], driver.instance.points)
+
+    assert_equal('https://ingestion.ovr.prd.f5aas.com:50443/beacon/v1/ingest-metrics', driver.instance.uri.to_s)
+    assert_equal('test-token', driver.instance.req['X-F5-Ingestion-Token'])
+    assert_equal('text/plain', driver.instance.req['Content-Type'])
+    assert_equal("test,beacon-fluent-source=test-source-name a=1i 1293974055000000000\n" +
+                 "test,beacon-fluent-source=test-source-name a=2i 1293974055000000000", driver.instance.req.body)
+  end
+
+  def test_empty_tag_keys
+    config_with_tags = %Q(
+      #{CONFIG}
+      tag_keys ["b"]
+    )
+
+    driver = create_driver(config_with_tags)
+
+    time = event_time("2011-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' => 1})
+      driver.feed(time, {'a' => 3, 'b' => ' '})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 1},
+            tags: {'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 2},
+            tags: {'b' => 1, 'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 3},
+            tags: {'beacon-fluent-source' => 'test-source-name'},
+          },
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def test_auto_tagging
+    config_with_tags = %Q(
+      #{CONFIG}
+
+      auto_tags true
+    )
+
+    driver = create_driver(config_with_tags)
+
+    time = event_time("2011-01-02 13:14:15 UTC")
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1, 'b' => '1'})
+      driver.feed(time, {'a' => 2, 'b' => 1})
+      driver.feed(time, {'a' => 3, 'b' => ' '})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => to_ns(time),
+            :series    => 'input.influxdb',
+
+            :values    => {'a' => 1},
+            :tags      => {'b' => '1', 'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            :timestamp => to_ns(time),
+            :series    => 'input.influxdb',
+            :values    => {'a' => 2, 'b' => 1},
+            :tags      => {'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            :timestamp => to_ns(time),
+            :series    => 'input.influxdb',
+            :values    => {'a' => 3},
+            :tags      => {'beacon-fluent-source' => 'test-source-name'},
+          },
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def test_ignore_empty_values
+    config_with_tags = %Q(
+      #{CONFIG}
+
+      tag_keys ["b"]
+    )
+
+    driver = create_driver(config_with_tags)
+
+    time = event_time('2011-01-02 13:14:15 UTC')
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'b' => '3'})
+      driver.feed(time, {'a' => 2, 'b' => 1})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            :timestamp => to_ns(time),
+            :series    => 'input.influxdb',
+
+            :values    => {'a' => 2},
+            :tags      => {'b' => 1, 'beacon-fluent-source' => 'test-source-name'},
+          }
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def test_seq
+    config = %[
+      type beacon
+      source_name test-source-name
+      token test-token
+      sequence_tag _seq
+    ]
+    driver = create_driver(config)
+
+    time = event_time("2011-01-02 13:14:15 UTC")
+    next_time = Fluent::EventTime.new(time + 1)
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1})
+      driver.feed(time, {'a' => 2})
+
+      driver.feed(next_time, {'a' => 1})
+      driver.feed(next_time, {'a' => 2})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 1},
+            tags: {'_seq' => 0, 'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 2},
+            tags: {'_seq' => 1, 'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            timestamp: to_ns(time + 1),
+            series: 'input.influxdb',
+            values: {'a' => 1},
+            tags: {'_seq' => 0, 'beacon-fluent-source' => 'test-source-name'},
+          },
+          {
+            timestamp: to_ns(time + 1),
+            series: 'input.influxdb',
+            values: {'a' => 2},
+            tags: {'_seq' => 1, 'beacon-fluent-source' => 'test-source-name'},
+          }
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def test_cast_number
+    config = %Q(
+      #{CONFIG}
+      cast_number_to_float true
+    )
+
+    driver = create_driver(config)
+
+    time = event_time("2011-01-02 13:14:15 UTC")
+    driver.run(default_tag: 'input.influxdb') do
+      driver.feed(time, {'a' => 1})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            timestamp: to_ns(time),
+            series: 'input.influxdb',
+            values: {'a' => 1.0},
+            tags: {'beacon-fluent-source' => 'test-source-name'},
+          },
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def test_time_key
+    config = %Q(
+    #{CONFIG}
+      time_key b
+    )
+
+    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' => 1293974055000000000})
+    end
+
+    assert_equal([
+      [
+        [
+          {
+            timestamp: 1293974055000000000,
+            series: 'input.influxdb',
+            values: {'a' => 1.0},
+            tags: {'beacon-fluent-source' => 'test-source-name'},
+          },
+        ]
+      ]
+    ], driver.instance.points)
+  end
+
+  def to_ns(time)
+    time * 1000000000
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+#
+# Copyright 2020 F5 Networks, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler'
+require 'pry'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'fluent/test/driver/output'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/test/helpers'
+require 'fluent/plugin/out_f5_beacon'
+
+include Fluent::Test::Helpers
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-f5-beacon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Davey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: F5 Beacon output plugin for Fluentd
+email:
+- m.davey@f5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- SUPPORT.md
+- TERMS OF USE.txt
+- fluent-plugin-f5-beacon.gemspec
+- lib/fluent/plugin/out_f5_beacon.rb
+- test/plugin/test_out_f5_beacon.rb
+- test/test_helper.rb
+homepage: https://github.com/f5devcentral/fluent-plugin-f5-beacon
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A buffered output plugin for Fluentd and F5 Beacon
+test_files:
+- test/plugin/test_out_f5_beacon.rb
+- test/test_helper.rb