fluent-plugin-logentries_ssl 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44d985f1ae77d78cb91e6494f04300fa62374923
-  data.tar.gz: 5bf25f2d7e7f3b68e34a58da88d83a27241b0a87
+  metadata.gz: c447ff5f9abb188ea46d1a4e0dc80263e555791b
+  data.tar.gz: 82657485f8ec359ae29b6cecffdae7339a2fcbaa
 SHA512:
-  metadata.gz: 81dd42379c529831072d1ff4036c2ea88e0ad23505aae82204b82bb52eaafe679401df5ea014c97d8c48cc64e532549307b56fcc7b01df8df62580e28921d3e7
-  data.tar.gz: df1a8fec907124ac82d6c255cbd202eb296868f53eb2aff482bd8b305fb7431dd4b7f53a70a69009d065c22bf8c45d72836a75f68c311809500486a10c57fa4f
+  metadata.gz: 1daba351d5d12445afae24f6c0d377240e2eddd5e9fb86ac67ab3078405bcb22870f385850731a1a046b86976363d50b1fd2947060b0ce4523d304421a1e041c
+  data.tar.gz: 3656af5f5ab6d40fd344ce6f9ebfb632821d6c35b0fa8dc0e7e49aa6ae9589f8ec1f46b991939bf9de93a200fbeb6e1a9626a62237dc7a6004afdb373737e912

data/.gitignore

@@ -1 +1,2 @@
 pkg/*
+Gemfile.lock

data/README.md

@@ -19,6 +19,14 @@ gem install fluent-plugin-logentries_ssl
 
 ## Configuration
 
+One of parameters *token\_path* or *default\_token* must be given. if token path is not defined, the Logentries token *default\_token* is used for all fluent events. When using *default\_token* with tokens from *token\_path*, it will be used as a fallback after trying to match a tag to a token in *token\_path*.
+
+| *parameter* | *description | *default value* |
+|---|---|---|
+| *token_path* | Path to YAML formatted file containing 'tag: logentries-token' pairs | nil |
+| *default_token* | A token string to be used either for all tags, or as fallback after token_path| nil |
+
+
 ```
 <match pattern>
   @type logentries_ssl
@@ -26,6 +34,16 @@ gem install fluent-plugin-logentries_ssl
 </match>
 ```
 
+or with *default\_token*:
+
+```
+<match pattern>
+  @type logentries_ssl
+  token_path /path/to/tokens.yml
+  default_token 'aaa-bbb-ccc'
+</match>
+```
+
 ```
 <match pattern>
   @type logentries_ssl
@@ -38,16 +56,19 @@ gem install fluent-plugin-logentries_ssl
   </buffer>
 </match>
 
+````
 with tokens.yml
+
 ```
 tag-to-send: [logentries tcp token]
 other-tag: [other token]
 ```
+
 Event tag must match key in tokens file.
 
 other configuration keys:
 
-| *parameter* | *descrtiption | *default value* |
+| *parameter* | *description | *default value* |
 |---|---|---|
 | *le_host* | Logentries hostname to use  | data.logentries.com |
 | *le_port* | Logentries port to use | 443 |
@@ -55,6 +76,12 @@ other configuration keys:
 | *json* | Send record as json | true |
 | *verify_fqdn* | Verify FQDN for SSL | true |
 
+
+## Alternatives
+
+* [fluent-plugin-logentries](https://github.com/Woorank/fluent-plugin-logentries)
+* [fluent-plugin-simple-logentries](https://github.com/sowawa/fluent-plugin-simple-logentries)
+
 ## Copyright
 
 * Copyright(c) 2017- larte

data/fluent-plugin-logentries_ssl.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-logentries_ssl"
-  spec.version = "0.1.0"
+  spec.version = "0.2.0"
   spec.authors = ["larte"]
   spec.email   = ["larte@foodie.fm"]
 

data/lib/fluent/plugin/out_logentries_ssl.rb

@@ -17,100 +17,111 @@ require 'fluent/plugin/output'
 require 'yaml'
 require_relative 'logentries_ssl/message_helper.rb'
 
-module Fluent::Plugin
-  module LogentriesSSL
-    class Output < Fluent::Plugin::Output
-      include Fluent::PluginHelper::Socket
-
-      Fluent::Plugin.register_output('logentries_ssl', self)
-
-      config_param :max_retries, :integer, default: 3
-      config_param :le_host, :string, default: 'data.logentries.com'
-      config_param :le_port, :integer, default: 443
-      config_param :token_path, :string
-      config_param :json, :bool, default: true
-      config_param :verify_fqdn, :bool, default: true
-
-      def configure(conf)
-        super
-        begin
-          @apptokens = YAML.load_file(@token_path)
-        rescue StandardError => e
-          raise Fluent::ConfigError, "Could not load #{@token_path}: #{e.message}"
+module Fluent
+  module Plugin
+    module LogentriesSSL
+      ##
+      # The plugin implementation.
+      class Output < Fluent::Plugin::Output
+        include Fluent::PluginHelper::Socket
+
+        Fluent::Plugin.register_output('logentries_ssl', self)
+
+        config_param :max_retries, :integer, default: 3
+        config_param :le_host, :string, default: 'data.logentries.com'
+        config_param :le_port, :integer, default: 443
+        config_param :token_path, :string, default: nil
+        config_param :default_token, :string, default: nil
+        config_param :json, :bool, default: true
+        config_param :verify_fqdn, :bool, default: true
+
+        def configure(conf)
+          super
+          if @default_token.nil? && @token_path.nil?
+            raise Fluent::ConfigError, 'Define :token_path or :default_token'
+          end
+          @apptokens = @token_path.nil? ? {} : load_tokens
         end
-      end
 
-      def start
-        super
-        log.trace "Creating connection to #{@le_host}"
-        @_client = create_client
-      end
+        def start
+          super
+          log.trace "Creating connection to #{@le_host}"
+          @_client = create_client
+        end
 
-      # apparently needed for msgpack_each in :write fluent Issue-1342
-      def formatted_to_msgpack_binary
-        true
-      end
+        # apparently needed for msgpack_each in :write fluent Issue-1342
+        def formatted_to_msgpack_binary
+          true
+        end
 
-      def format(tag, _time, record)
-        [tag, record].to_msgpack
-      end
+        def load_tokens
+          begin
+            tokens = YAML.load_file(@token_path)
+          rescue StandardError => e
+            raise Fluent::ConfigError,
+                  "Could not load #{@token_path}: #{e.message}"
+          end
+          tokens
+        end
 
-      def tag_token(tag)
-        @apptokens.each do |name, token|
-          return token if tag.casecmp(name).zero?
+        def format(tag, _time, record)
+          [tag, record].to_msgpack
         end
-        nil
-      end
 
-      def write(chunk)
-        log.debug 'Writing records to logentries'
-        chunk.msgpack_each do |tag, record|
-          token = tag_token(tag)
-          next unless token
-          log.trace "Got token #{token} for tag #{tag}"
-          data = @json ? record.to_json : record
-          payloads = MessageHelper.split_record(token, "#{token} #{data} \n")
-          payloads.each do |payload|
-            with_retries do
-              client.write(payload)
+        def tag_token(tag)
+          @apptokens.each do |name, token|
+            return token if tag.casecmp(name).zero?
+          end
+          @default_token.nil? ? nil : @default_token
+        end
+
+        def write(chunk)
+          chunk.msgpack_each do |tag, record|
+            token = tag_token(tag)
+            next unless token
+            data = @json ? record.to_json : record
+            MessageHelper.split_record(token, "#{token} #{data} \n")
+                         .each do |payload|
+              with_retries { client.write(payload) }
             end
           end
         end
-      end
 
-      private
+        private
 
-      def create_client
-        socket_create(:tls, @le_host, @le_port, verify_fqdn: @verify_fqdn)
-      end
+        def create_client
+          socket_create(:tls, @le_host, @le_port, verify_fqdn: @verify_fqdn)
+        end
 
-      def close_client
-        @_client.close if @_client
-        @_client = nil
-      end
+        def close_client
+          @_client.close if @_client
+          @_client = nil
+        end
 
-      def client
-        @_client ||= create_client
-      end
+        def client
+          @_client ||= create_client
+        end
 
-      def retry?(n)
-        n < @max_retries
-      end
+        def retry?(n)
+          n < @max_retries
+        end
 
-      def with_retries
-        tries = 0
-        begin
-          yield
-        rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ECONNABORTED,
-               Errno::ENETUNREACH, Errno::ETIMEDOUT, Errno::EPIPE => e
-          if retry?(tries += 1)
-            log.warn 'Clould not push to logentries, reset and retry'\
-                     "in #{2**tries} seconds. #{e.message}"
-            sleep(2**tries)
-            close_client
-            retry
+        # rubocop:disable Metrics/MethodLength
+        def with_retries
+          tries = 0
+          begin
+            yield
+          rescue Errno::ECONNREFUSED, Errno::ECONNRESET, Errno::ECONNABORTED,
+                 Errno::ENETUNREACH, Errno::ETIMEDOUT, Errno::EPIPE => e
+            if retry?(tries += 1)
+              log.warn 'Clould not push to logentries, reset and retry'\
+                       "in #{2**tries} seconds. #{e.message}"
+              sleep(2**tries)
+              close_client
+              retry
+            end
+            raise 'Could not push logs to Logentries'
           end
-          raise 'Could not push logs to Logentries'
         end
       end
     end

data/test/plugin/test_out_logentries_ssl.rb

@@ -1,7 +1,7 @@
-require "helper"
-require "fluent/plugin/out_logentries_ssl.rb"
-
+require 'helper'
+require 'fluent/plugin/out_logentries_ssl.rb'
 
+# rubocop:disable Metrics/ClassLength
 class LogentriesSSLOutTest < Test::Unit::TestCase
   setup do
     Fluent::Test.setup
@@ -12,20 +12,20 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
   end
 
   def teardown
-    Dir.glob('test/tmp/*').each {|f| File.unlink(f) }
+    Dir.glob('test/tmp/*').each { |f| File.unlink(f) }
     Dir.rmdir('test/tmp')
   end
 
-  CONF = %[
+  CONF = %(
           token_path test/tmp/tokens.yml
           max_retries 2
           verify_fqdn false
-          ]
+          ).freeze
 
-  TOKENS = {"app" => "token", "app2" => "token2"}
+  TOKENS = { 'app' => 'token', 'app2' => 'token2' }.freeze
 
   def write_tokens
-    File.open("test/tmp/tokens.yml","w") do |f|
+    File.open('test/tmp/tokens.yml', 'w') do |f|
       f.write TOKENS.to_yaml.to_s
     end
   end
@@ -35,12 +35,12 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
     socket.stubs(:connect).returns(socket)
     socket.stubs(:sync_close=)
     socket.stubs(:close)
-    OpenSSL::SSL::SSLSocket.expects(:new).at_least_once.with(any_parameters).returns(socket)
-    return socket
+    OpenSSL::SSL::SSLSocket.expects(:new).at_least_once.with(any_parameters)
+                           .returns(socket)
+    socket
   end
 
-
-  test "configuration" do
+  test 'configuration' do
     write_tokens
     d = create_driver(CONF)
     assert_equal 'test/tmp/tokens.yml', d.instance.token_path
@@ -49,7 +49,7 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
     assert_equal 'data.logentries.com', d.instance.le_host
   end
 
-  test "tags-tokens" do
+  test 'tags-tokens' do
     write_tokens
     d = create_driver(CONF)
     assert_equal 'token', d.instance.tag_token('app')
@@ -57,17 +57,49 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
     assert_equal nil, d.instance.tag_token('app3')
   end
 
-  test "unreadable tokens" do
+  test 'using default token' do
+    conf = %(
+         default_token aaa-bbb-ccc
+          max_retries 2
+          verify_fqdn false
+          )
+    d = create_driver(conf)
+    assert_equal 'aaa-bbb-ccc', d.instance.tag_token('app1')
+    assert_equal 'aaa-bbb-ccc', d.instance.tag_token('app2')
+  end
+
+  test 'using default token with token file' do
+    write_tokens
+    conf = %(
+          token_path test/tmp/tokens.yml
+          default_token aaa-bbb-ccc
+          max_retries 2
+          verify_fqdn false
+          )
+    d = create_driver(conf)
+    assert_equal 'token', d.instance.tag_token('app')
+    assert_equal 'token2', d.instance.tag_token('app2')
+    assert_equal 'aaa-bbb-ccc', d.instance.tag_token('app3')
+  end
+
+  test 'no token info' do
+    assert_raise Fluent::ConfigError do
+      create_driver('max_retries 2')
+    end
+  end
+
+  test 'unreadable tokens' do
     assert_raise Fluent::ConfigError do
       create_driver(CONF)
     end
   end
 
-  test "sending to logentries" do
+  test 'sending to logentries' do
     write_tokens
     socket = stub_socket
-    message = {"message" => "Hello"}
-    socket.expects(:write).with(regexp_matches(/^token {.*message.*Hello.*}\s+/i))
+    message = { 'message' => 'Hello' }
+    socket.expects(:write)
+          .with(regexp_matches(/^token {.*message.*Hello.*}\s+/i))
     d = create_driver(CONF)
     time = event_time('2017-01-01 13:37:00 UTC')
     d.run(default_tag: 'app') do
@@ -75,11 +107,12 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
     end
   end
 
-  test "retries on errors" do
+  test 'retries on errors' do
     write_tokens
     socket = stub_socket
-    message = {"message" => "Hello"}
-    socket.expects(:write).with(anything).twice.raises(Errno::ECONNRESET).then.returns("ok")
+    message = { 'message' => 'Hello' }
+    socket.expects(:write).with(anything).twice.raises(Errno::ECONNRESET)
+          .then.returns('ok')
     d = create_driver(CONF)
     time = event_time('2017-01-01 13:37:00 UTC')
     d.run(default_tag: 'app') do
@@ -87,11 +120,12 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
     end
   end
 
-  test "sending too large events to LE" do
+  test 'sending too large events to LE' do
     write_tokens
     socket = stub_socket
-    message = {"hello" =>
-               "a"*(Fluent::Plugin::LogentriesSSL::MessageHelper::MAX_SIZE + 100)}
+    message = { 'hello' =>
+                'a' *
+                (Fluent::Plugin::LogentriesSSL::MessageHelper::MAX_SIZE + 100) }
     socket.expects(:write).with(anything).twice
     d = create_driver(CONF)
     time = event_time('2017-01-01 13:37:00 UTC')
@@ -103,6 +137,7 @@ class LogentriesSSLOutTest < Test::Unit::TestCase
   private
 
   def create_driver(conf)
-    Fluent::Test::Driver::Output.new(Fluent::Plugin::LogentriesSSL::Output).configure(conf)
+    Fluent::Test::Driver::Output
+      .new(Fluent::Plugin::LogentriesSSL::Output).configure(conf)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-logentries_ssl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - larte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,7 +95,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -125,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Plugin to send records to logentries

data/Gemfile.lock

@@ -1,52 +0,0 @@
-PATH
-  remote: .
-  specs:
-    fluent-plugin-logentries_ssl (0.1.0)
-      fluentd (>= 0.14.10, < 2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    cool.io (1.4.6)
-    fluentd (0.14.13)
-      cool.io (~> 1.4.5)
-      http_parser.rb (>= 0.5.1, < 0.7.0)
-      msgpack (>= 0.7.0, < 2.0.0)
-      serverengine (>= 2.0.4, < 3.0.0)
-      sigdump (~> 0.2.2)
-      strptime (~> 0.1.7)
-      tzinfo (~> 1.0)
-      tzinfo-data (~> 1.0)
-      yajl-ruby (~> 1.0)
-    http_parser.rb (0.6.0)
-    metaclass (0.0.4)
-    mocha (1.2.1)
-      metaclass (~> 0.0.1)
-    msgpack (1.1.0)
-    power_assert (1.0.1)
-    rake (12.0.0)
-    serverengine (2.0.5)
-      sigdump (~> 0.2.2)
-    sigdump (0.2.4)
-    strptime (0.1.9)
-    test-unit (3.2.3)
-      power_assert
-    thread_safe (0.3.6)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    tzinfo-data (1.2017.1)
-      tzinfo (>= 1.0.0)
-    yajl-ruby (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.14)
-  fluent-plugin-logentries_ssl!
-  mocha
-  rake (~> 12.0)
-  test-unit (~> 3.0)
-
-BUNDLED WITH
-   1.14.6