fluent-plugin-logdna 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: febe9d7b76663bb4b6ac9708469baac099cef66350bb0632a16a8c769d7f6401
-  data.tar.gz: 59ff8adb086da0a1822f3b35aaa546a1c5054138fd0f0066fdfb08559ca26766
+  metadata.gz: 7dc5c3a579927d59c9a9705bd5ceec17d5a6dc3d8964d1639dd51afb23eaca80
+  data.tar.gz: 2519afb42481d5840bd11b5d579637e4ea55008dc89996421013185d76439374
 SHA512:
-  metadata.gz: 1b5bbb8fadaf21d8fcae55fe9796ad654667e91f1d00b82741f26c3d26cb6d0db3163c67aa1ee4a01bad95a5a05cf36e2e35017ce772468c44694507781e9cf2
-  data.tar.gz: 43704cac7be00cbb76cb2caf0c4bc44aeaaf4737468d563ee7c52e169c5f40de39f88f4ac5c7d8b3abc964b521b5c66897fcfddb6f8250ec158ea50e85cc1135
+  metadata.gz: 511d77f656a7584723954052a7f4c0e70b39f8115f88cbfff2369b1d9e7388fac35242ff9b52a5e0b6b2292e73c757a3efb1025833bfd6b9a96dd9ef1437fad5
+  data.tar.gz: c1058ffb07ab69ad383c3b1d8015aaf912ebe3d0632c612c6e63d2ba41b75c6b930fa03f8f4a415c066501bbf4ab38f900f8728b9d630cf41bee002f5b8f6b2c

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rake", "~> 12.3"
+gem "webmock"

data/Gemfile.lock

@@ -1,30 +1,32 @@
 PATH
   remote: .
   specs:
-    fluent-plugin-logdna (0.1.7.1)
+    fluent-plugin-logdna (0.3.1)
       fluentd (>= 0.12.0, < 2)
       http (~> 2.0, >= 2.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    cool.io (1.5.3)
-    dig_rb (1.0.1)
-    domain_name (0.5.20180417)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.6)
+    cool.io (1.6.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    fluentd (1.0.2)
+    fluentd (1.11.1)
       cool.io (>= 1.4.5, < 2.0.0)
-      dig_rb (~> 1.0.0)
       http_parser.rb (>= 0.5.1, < 0.7.0)
-      msgpack (>= 0.7.0, < 2.0.0)
+      msgpack (>= 1.3.1, < 2.0.0)
       serverengine (>= 2.0.4, < 3.0.0)
       sigdump (~> 0.2.2)
-      strptime (~> 0.1)
-      tzinfo (~> 1.0)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
       tzinfo-data (~> 1.0)
       yajl-ruby (~> 1.0)
+    hashdiff (1.0.1)
     http (2.2.2)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -34,22 +36,26 @@ GEM
       domain_name (~> 0.5)
     http-form_data (1.0.3)
     http_parser.rb (0.6.0)
-    msgpack (1.2.0)
-    public_suffix (3.0.1)
-    rake (12.3.1)
-    serverengine (2.0.5)
+    msgpack (1.3.3)
+    public_suffix (4.0.3)
+    rake (12.3.3)
+    safe_yaml (1.0.5)
+    serverengine (2.2.1)
       sigdump (~> 0.2.2)
     sigdump (0.2.4)
-    strptime (0.1.9)
-    thread_safe (0.3.6)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
-    tzinfo-data (1.2017.3)
+    strptime (0.2.4)
+    tzinfo (2.0.2)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2020.1)
       tzinfo (>= 1.0.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    yajl-ruby (1.3.1)
+    unf_ext (0.0.7.7)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yajl-ruby (1.4.1)
 
 PLATFORMS
   ruby
@@ -58,6 +64,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   fluent-plugin-logdna!
   rake (~> 12.3)
+  webmock
 
 BUNDLED WITH
-   1.16.0
+   1.17.2

data/README.md

@@ -9,9 +9,9 @@ Using fluent-plugin-logdna, you can send the logs you collect with Fluentd to Lo
 * Install [Fluentd](http://www.fluentd.org/download)
 * Alternative install if using fluentd package manager (td-agent): `td-agent-gem install fluent-plugin-logdna`
 * Add the contents below to `/etc/fluent/fluent.conf`. For td-agent, use `/etc/td-agent/td-agent.conf`:
-* Alternative install without td-agent is: `gem install fluent-plugin-logdna` 
+* Alternative install without td-agent is: `gem install fluent-plugin-logdna`
 
-~~~~~
+~~~~~configuration
 <match **>
   @type logdna
   api_key xxxxxxxxxxxxxxxxxxxxxxxxxxx        # paste your api key here (required)
@@ -20,10 +20,12 @@ Using fluent-plugin-logdna, you can send the logs you collect with Fluentd to Lo
   #mac C0:FF:EE:C0:FF:EE                     # optional mac address
   #ip 127.0.0.1                              # optional ip address
   #tags web,dev                              # optional tags
+  request_timeout 30000 ms                   # optional timeout for upload request, supports seconds (s, default) and milliseconds (ms) suffixes, default 30 seconds
   buffer_chunk_limit 1m                      # do not increase past 8m (8MB) or your logs will be rejected by our server.
   flush_at_shutdown true                     # only needed with file buffer
 </match>
 ~~~~~
+
 * Restart fluentd to pick up the configuration changes.
 * `sudo /etc/init.d/td-agent stop`
 * `sudo /etc/init.d/td-agent start`
@@ -31,44 +33,45 @@ Using fluent-plugin-logdna, you can send the logs you collect with Fluentd to Lo
 ### Recommended Configuration Parameters
 
 * buffer_type
-  - We recommend setting this to memory for development and file for production (file setting requires a buffer_path).
+  * We recommend setting this to memory for development and file for production (file setting requires a buffer_path).
 * buffer_queue_limit, buffer_chunk_limit
-  - We do not recommend increasing buffer_chunk_limit past 8MB.
+  * We do not recommend increasing buffer_chunk_limit past 8MB.
 * flush_interval
-  - Default is 60s. We recommend keeping this well above 5s.
+  * Default is 60s. We recommend keeping this well above 5s.
 * retry_wait, max_retry_wait, retry_limit, disable_retry_limit
-  - We recommend increasing these values if you are encountering problems.
+  * We recommend increasing these values if you are encountering problems.
 
 ### Options
 
 * App name and log level can also be provided on a line-by-line basis over JSON:
 * `_app` and `level` will override the config
 
-If you don't have a LogDNA account, you can create one on https://logdna.com or if you're on macOS w/[Homebrew](https://brew.sh) installed:
+If you don't have a LogDNA account, you can create one on [https://logdna.com](https://logdna.com) or if you're on macOS w/[Homebrew](https://brew.sh) installed:
 
-```
+~~~~~bash
 brew cask install logdna-cli
 logdna register <email>
 # now paste the api key above
-```
+~~~~~
 
 ### LogDNA Pay-per-gig Pricing
 
 Our [paid plans](https://logdna.com/#pricing) start at $1.25/GB per month, pay for what you use / no fixed data buckets / all paid plans include all features.
 
 ## Building a debian package for td-agent
+
 If you use td-agent you can build a debian package instead of installing via
 td-agent-gem. This requires that td-agent is already installed and that you've
 installed [fpm](http://fpm.readthedocs.io/en/latest/index.html). Then just run
 `make` in your git directory.
 
-```
+~~~~~bash
 gem install --no-ri --no-rdoc fpm
 git clone https://github.com/logdna/fluent-plugin-logdna
 cd fluent-plugin-logdna
 make
 sudo dpkg -i fluent-plugin-logdna*.deb
-```
+~~~~~
 
 ## Additional Options
 

data/fluent-plugin-logdna.gemspec

@@ -3,7 +3,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'fluent-plugin-logdna'
-  s.version     = '0.2.3'
+  s.version     = '0.3.1'
   s.date        = Date.today.to_s
   s.summary     = 'LogDNA plugin for Fluentd'
   s.description = 'Fluentd plugin for supplying output to LogDNA.'

data/lib/fluent/plugin/out_logdna.rb

@@ -14,10 +14,26 @@ module Fluent
     config_param :app, :string, default: nil
     config_param :file, :string, default: nil
     config_param :ingester_domain, :string, default: 'https://logs.logdna.com'
+    config_param :request_timeout, :string, default: '30'
 
     def configure(conf)
       super
       @host = conf['hostname']
+
+      # make these two variables globals
+      timeout_unit_map = { s: 1.0, ms: 0.001  }
+      timeout_regex = Regexp.new("^([0-9]+)\s*(#{timeout_unit_map.keys.join("|")})$")
+
+      # this section goes into this part of the code
+      num_component = 30.0
+      unit_component = 's'
+
+      timeout_regex.match(@request_timeout) do |match|
+        num_component = match[1].to_f
+        unit_component = match[2]
+      end
+
+      @request_timeout = num_component * timeout_unit_map[unit_component.to_sym]
     end
 
     def start
@@ -84,7 +100,8 @@ module Fluent
       url = "/logs/ingest?hostname=#{@host}&mac=#{@mac}&ip=#{@ip}&now=#{now}&tags=#{@tags}"
       @ingester.headers('apikey' => @api_key,
                         'content-type' => 'application/json')
-               .post(url, json: body)
+                .timeout(connect: @request_timeout, write: @request_timeout, read: @request_timeout)
+                .post(url, json: body)
     end
   end
 end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_out_logdna.rb

@@ -0,0 +1,110 @@
+# https://docs.fluentd.org/plugin-development/api-plugin-output#how-to-write-tests
+
+require_relative '../helper'
+require 'fluent/test/driver/output'
+require 'fluent/plugin/out_stdout'
+require 'fluent/plugin/input'
+require 'webmock/test_unit'
+include WebMock::API
+
+require 'lib/fluent/plugin/out_logdna.rb'
+
+class LogdnaOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+
+    stub_request(:post, /logs.logdna.com\/logs\/ingest/)
+  end
+
+  # default configuration for tests
+  CONFIG = %[
+    api_key this-is-my-key
+    hostname "localhost"
+    app my_app
+    mac C0:FF:EE:C0:FF:EE
+    ip 127.0.0.1
+    tags  "my-tag"
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::LogDNAOutput).configure(conf)
+  end
+
+  sub_test_case 'configuration' do
+    test 'instantiate the plugin and check default config values' do
+        d = create_driver
+        time = event_time
+
+        # check defaults
+        assert_equal 'https://logs.logdna.com', d.instance.ingester_domain
+        assert_equal 30, d.instance.request_timeout
+    end
+
+    test 'instantiate the plugin and check setting config values' do
+        conf = %[
+            api_key this-is-my-key
+            hostname "localhost"
+            app my_app
+            mac C0:FF:EE:C0:FF:EE
+            ip 127.0.0.1
+            tags  "my-tag"
+            request_timeout 17s
+        ]
+
+        d = create_driver(conf)
+
+        # check set config values
+        assert_equal 'my-tag', d.instance.tags
+        assert_equal 17, d.instance.request_timeout
+    end
+
+    test 'instantiate the plugin with ms request_timeout value' do
+
+        conf = %[
+            api_key this-is-my-key
+            hostname "localhost"
+            app my_app
+            mac C0:FF:EE:C0:FF:EE
+            ip 127.0.0.1
+            tags  "my-tag"
+            request_timeout 17000 ms
+        ]
+
+        d = create_driver(conf)
+
+        # check set config values
+        assert_equal 17, d.instance.request_timeout
+    end
+
+    test 'instantiate the plugin with nonesense request_timeout value' do
+
+        conf = %[
+            api_key this-is-my-key
+            hostname "localhost"
+            app my_app
+            mac C0:FF:EE:C0:FF:EE
+            ip 127.0.0.1
+            tags  "my-tag"
+            request_timeout "asdf ms"
+        ]
+
+        d = create_driver(conf)
+
+        # check set config values
+        assert_equal 30, d.instance.request_timeout
+    end
+  end
+
+  test 'simple #write' do
+    d = create_driver
+    time = event_time
+
+    d.run do
+        d.feed("output.test", time, {'foo' => 'bar', 'message' => 'myLine'})
+        d.feed("output.test", time, {'foo' => 'bar', 'message' => 'myLine'})
+    end
+
+    assert_equal(2, d.formatted.size)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-logdna
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Edwin Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,8 @@ files:
 - Rakefile
 - fluent-plugin-logdna.gemspec
 - lib/fluent/plugin/out_logdna.rb
+- test/helper.rb
+- test/plugin/test_out_logdna.rb
 homepage: https://github.com/logdna/fluent-plugin-logdna
 licenses:
 - MIT