fluent-plugin-syslog_rfc5424 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7536020d3c795a70e0402cc31a1695065c3c74ab
-  data.tar.gz: b92d9504aa373910b6bb62ac564447de7790ce65
+  metadata.gz: 631caa1e479ab376df1e171eff8c3c9c0b2fbadd
+  data.tar.gz: 78d51e228bb8dafa134a6a3196a8a9f44cc48dd7
 SHA512:
-  metadata.gz: fe78fddd0ad46be56fe4670e40f496b14330dff0bcd4575681226e6d12abf7b0e305d694f655efb3c93370c79a03ae9fafdba3d88b92c81ed90cf800c3070f1e
-  data.tar.gz: 8e55ff9d142252ba5fa53a40c9cac3e52f6574170de92d1fd62c963c0fc9bc8e9afbc5ac5e049dfbb766b75ecdf01b1fe86908a0e705578f2318e5adeb0d3563
+  metadata.gz: 8807cf51fb9c7b5f7a48b4dfce3faa190fb656b5cca210f67cca3306f8c5054e12ac137607398c0e2b6300775cbee542dcd13947292c1214b1f4987b34e194a2
+  data.tar.gz: 28d4801b6e7074f077b12e592258c77800f59edd2bfa7c8696886fe06d2f708dde5585d136c766ba4dd6e1da0a059a4bc122a32550b7e41818d3f54a461a5480

data/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in fluentd_cf_syslog.gemspec
+# Specify your gem's dependencies in the gemspec
 gemspec

data/README.md

@@ -1,5 +1,11 @@
-# SyslogRFC5424
+# FluentD Output & Formatter Plugins: Syslog RFC5424
 
+[![Build Status](https://travis-ci.org/cloudfoundry/fluent-plugin-syslog_rfc5424.svg?branch=master)](https://travis-ci.org/cloudfoundry/fluent-plugin-syslog_rfc5424)
+
+
+Formatter plugin adheres to [RFC5424](https://tools.ietf.org/html/rfc5424). 
+
+Output plugin adheres to [RFC6587](https://tools.ietf.org/html/rfc6587) and [RFC5424](https://tools.ietf.org/html/rfc5424).
 
 ## Installation
 
@@ -17,14 +23,13 @@ Or install it yourself as:
 
     $ gem install fluentd_syslog_rfc5424
 
-## Usage
+## Output Usage
 
 ```
 <match **>
   @type syslog_rfc5424
   host SYSLOG-HOST
   port SYSLOG-PORT
-  # transport tls, udp, tcp (defaults to tls)
   <buffer>
     @type memory
     flush_interval 10s
@@ -32,24 +37,40 @@ Or install it yourself as:
 </match>
 ```
 
-## Configuration
+### Configuration
 
 | name              | type       | placeholder support | description                               |
 | --------------    | -------    | -----------         | ---------------------------------         |
 | host              | string     |                     | syslog target host                        |
 | port              | integer    |                     | syslog target port                        |
-| transport         | string     |                     | transport protocol (tls, udp, or tcp)     |
+| transport         | string     |                     | transport protocol (tls [default], udp, or tcp)     |
+
+#### Format Section
 
-### Common Configuration
+Defaults to `syslog_rfc5424`
 
-#### Buffer Section
+| name                      |type     | description |
+| --------------            | ------- | -------     |
+| rfc6587_message_size      | boolean | prepends message length for syslog transmission (true by default)  |
+
+
+## Formatter Usage
+
+```
+<match **>
+  @type example
+  <format>
+    @type syslog_rfc5424
+  </format>
+</match>
+```
+
+### Configuration
+
+| name                      |type     | description |
+| --------------            | ------- | -------     |
+| rfc6587_message_size      | boolean | prepends message length for syslog transmission (false by default)  |
 
-| name                        |
-| --------------              |
-| flush_mode                  |
-| flush_interval              |
-| flush_thread_interval       |
-| flush_thread_burst_interval |
 
 ## Development
 
@@ -60,3 +81,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cloudfoundry/fluentd_syslog_rfc5424.
+
+## Publishing
+
+1. Run tests `bundle exec rake`
+1. Push changes
+1. Create & push git tag with version
+1. Change version in `.gemspec`
+1. Build gem `gem build fluent-plugin-syslog_rfc5424`
+1. Push `.gem` file to rubygems

data/fluent-plugin-syslog_rfc5424.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-syslog_rfc5424"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.1"
   spec.authors       = ["Pivotal"]
   spec.email         = %w(cf-loggregator@pivotal.io)
   spec.homepage      = "https://github.com/cloudfoundry/fluent-plugin-syslog_rfc5424"
@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "test-unit", "~> 3.3"
   spec.add_development_dependency "test-unit-rr", "~> 1.0"
   spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "minitest"
 
   spec.add_runtime_dependency "fluentd", "~> 1.7"
 end

data/lib/fluent/plugin/formatter_syslog_rfc5424.rb

@@ -0,0 +1,18 @@
+require 'rfc5424/formatter'
+
+module Fluent
+  module Plugin
+    class FormatterSyslogRFC5424 < Formatter
+      Fluent::Plugin.register_formatter("syslog_rfc5424", self)
+
+      config_param :rfc6587_message_size, :bool, default: false
+
+      def format(tag, time, record)
+        msg = RFC5424::Formatter.format(log: record["log"], timestamp: time)
+        return msg unless @rfc6587_message_size
+
+        msg.length.to_s + " " + msg
+      end
+    end
+  end
+end

data/lib/fluent/plugin/out_syslog_rfc5424.rb

@@ -1,24 +1,56 @@
 require 'fluent/plugin/output'
-require 'rfc5424/formatter'
 
 module Fluent
   module Plugin
-    class SyslogRFC5424 < Output
+    class OutSyslogRFC5424 < Output
       Fluent::Plugin.register_output('syslog_rfc5424', self)
 
-      helpers :socket
+      helpers :socket, :formatter
+      DEFAULT_FORMATTER = "syslog_rfc5424"
 
       config_param :host, :string
       config_param :port, :integer
       config_param :transport, :string, default: "tls"
+      config_section :format do
+        config_set_default :@type, DEFAULT_FORMATTER
+        config_set_default :rfc6587_message_size, true
+      end
+
+      def configure(config)
+        super
+        @sockets = {}
+        @formatter = formatter_create
+      end
 
       def write(chunk)
-          self.socket_create(@transport.to_sym, @host, @port) do | socket |
-            chunk.each do |time, record|
-              syslog = RFC5424::Formatter.format(log: record["log"], timestamp: time)
-              socket.puts syslog.size.to_s + " " + syslog
-            end
-          end
+        socket = find_or_create_socket(@transport.to_sym, @host, @port)
+        tag = chunk.metadata.tag
+        chunk.each do |time, record|
+          socket.puts @formatter.format(tag, time, record)
+        end
+      end
+
+      def close
+        super
+        @sockets.each_value { |s| s.close }
+        @sockets = {}
+      end
+
+      private
+
+      def find_or_create_socket(transport, host, port)
+        socket = find_socket(transport, host, port)
+        return socket if socket
+
+        @sockets[socket_key(transport, host, port)] = self.socket_create(transport.to_sym, host, port)
+      end
+
+      def socket_key(transport, host, port)
+        "#{host}:#{port}:#{transport}"
+      end
+
+      def find_socket(transport, host, port)
+        @sockets[socket_key(transport, host, port)]
       end
     end
   end

data/test/plugin/formatter_syslog_rfc5424_spec.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+require "fluent/plugin/formatter_syslog_rfc5424"
+
+class FormatterSyslogRFC5424Test < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Formatter.new(Fluent::Plugin::FormatterSyslogRFC5424).configure(conf)
+  end
+
+  def test_format_default
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log"}
+    assert_equal "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - - test-log",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+
+  def test_format_without_message_size
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size false
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log"}
+    assert_equal "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - - test-log",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+
+  def test_format_with_message_size
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size true
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log"}
+
+    formatted_message = "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - - test-log"
+    message_size = formatted_message.length
+    assert_equal "#{message_size} #{formatted_message}",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+end

data/test/plugin/out_syslog_rfc5424_spec.rb

@@ -0,0 +1,86 @@
+require "test_helper"
+require "fluent/plugin/out_syslog_rfc5424"
+
+class OutSyslogRFC5424Test < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    @time = Fluent::EventTime.new(0, 123456)
+    @formatted_log = "51 <14>1 1970-01-01T00:00:00.000123+00:00 - - - - - hi"
+  end
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::OutSyslogRFC5424).configure(conf)
+  end
+
+  def test_configure
+    output_driver = create_driver %(
+      @type syslog_rfc5424
+      host example.com
+      port 123
+    )
+
+    assert_equal "example.com", output_driver.instance.instance_variable_get(:@host)
+    assert_equal 123, output_driver.instance.instance_variable_get(:@port)
+  end
+
+  def test_sends_a_message
+    output_driver = create_driver %(
+      @type syslog_rfc5424
+      host example.com
+      port 123
+    )
+
+    socket = Minitest::Mock.new
+    mock(socket).puts(@formatted_log)
+    stub(socket).close
+
+    any_instance_of(Fluent::Plugin::OutSyslogRFC5424) do |fluent_plugin|
+      mock(fluent_plugin).socket_create(:tls, "example.com", 123).returns(socket)
+    end
+
+    output_driver.run do
+      output_driver.feed("tag", @time, {"log" => "hi"})
+    end
+  end
+
+  def test_non_tls
+    output_driver = create_driver %(
+      @type syslog_rfc5424
+      host example.com
+      port 123
+      transport tcp
+    )
+
+    socket = Minitest::Mock.new
+    mock(socket).puts(@formatted_log)
+    stub(socket).close
+
+    any_instance_of(Fluent::Plugin::OutSyslogRFC5424) do |fluent_plugin|
+      mock(fluent_plugin).socket_create(:tcp, "example.com", 123).returns(socket)
+    end
+
+    output_driver.run do
+      output_driver.feed("tag", @time, {"log" => "hi"})
+    end
+  end
+
+  def test_close_is_called_on_sockets
+    output_driver = create_driver %(
+      @type syslog_rfc5424
+      host example.com
+      port 123
+    )
+
+    socket = Minitest::Mock.new
+    stub(socket).puts(@formatted_log)
+
+    any_instance_of(Fluent::Plugin::OutSyslogRFC5424) do |fluent_plugin|
+      mock(fluent_plugin).socket_create(:tls, "example.com", 123).returns(socket)
+    end
+
+    mock(socket).close
+    output_driver.run do
+      output_driver.feed("tag", @time , {"log" => "hi"})
+    end
+  end
+end

data/test/rfc5424/formatter_spec.rb

@@ -3,7 +3,7 @@ require "rfc5424/formatter"
 
 class RFC5424::FormatterTest < Test::Unit::TestCase
   def test_only_log
-    log = RFC5424::Formatter.format( log: "test-log")
+    log = RFC5424::Formatter.format(log: "test-log")
     assert_equal log, "<14>1 - - - - - - test-log"
   end
 

data/test/test_helper.rb

@@ -6,6 +6,9 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require "fluent/test"
 require "fluent/test/driver/output"
+require "fluent/test/driver/formatter"
+
+require "test/unit/rr"
+require "minitest/mock"
 
-require 'test/unit/rr'
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-syslog_rfc5424
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Pivotal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2019-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -109,9 +123,11 @@ files:
 - README.md
 - Rakefile
 - fluent-plugin-syslog_rfc5424.gemspec
+- lib/fluent/plugin/formatter_syslog_rfc5424.rb
 - lib/fluent/plugin/out_syslog_rfc5424.rb
 - lib/rfc5424/formatter.rb
-- test/plugin/syslog_rfc5424_spec.rb
+- test/plugin/formatter_syslog_rfc5424_spec.rb
+- test/plugin/out_syslog_rfc5424_spec.rb
 - test/rfc5424/formatter_spec.rb
 - test/test_helper.rb
 homepage: https://github.com/cloudfoundry/fluent-plugin-syslog_rfc5424
@@ -139,6 +155,7 @@ signing_key:
 specification_version: 4
 summary: FluentD output plugin to send messages via rfc5424
 test_files:
-- test/plugin/syslog_rfc5424_spec.rb
+- test/plugin/formatter_syslog_rfc5424_spec.rb
+- test/plugin/out_syslog_rfc5424_spec.rb
 - test/rfc5424/formatter_spec.rb
 - test/test_helper.rb

data/test/plugin/syslog_rfc5424_spec.rb

@@ -1,68 +0,0 @@
-require "test_helper"
-require "fluent/plugin/out_syslog_rfc5424"
-
-class SyslogRFC5424Test < Test::Unit::TestCase
-  def setup
-    Fluent::Test.setup
-  end
-
-  def create_driver(conf = CONFIG)
-    Fluent::Test::Driver::Output.new(Fluent::Plugin::SyslogRFC5424).configure(conf)
-  end
-
-  def test_configure
-    d = create_driver %[
-      @type syslog_rfc5424
-      host example.com
-      port 123
-    ]
-
-    assert_equal "example.com", d.instance.instance_variable_get(:@host)
-    assert_equal 123, d.instance.instance_variable_get(:@port)
-  end
-
-  def test_sends_a_message
-    output_driver = create_driver %[
-      @type syslog_rfc5424
-      host example.com
-      port 123
-    ]
-
-    socket = Object.new
-    mock(socket).puts("1 l")
-    n = Fluent::EventTime.now
-    mock(RFC5424::Formatter).format(timestamp: n, log: "hi") { "l" }
-
-    any_instance_of(Fluent::Plugin::SyslogRFC5424) do |fluent_plugin|
-      mock(fluent_plugin).socket_create(:tls, "example.com", 123).yields(socket)
-    end
-
-    output_driver.run do
-      output_driver.feed("tag", n , {"log" => "hi"})
-    end
-  end
-
-  def test_non_tls
-      output_driver = create_driver %[
-      @type syslog_rfc5424
-      host example.com
-      port 123
-      transport tcp
-    ]
-
-      socket = Object.new
-      mock(socket).puts("1 l")
-      n = Fluent::EventTime.now
-      mock(RFC5424::Formatter).format(timestamp: n, log: "hi") { "l" }
-
-      any_instance_of(Fluent::Plugin::SyslogRFC5424) do |fluent_plugin|
-        mock(fluent_plugin).socket_create(:tcp, "example.com", 123).yields(socket)
-      end
-
-
-      output_driver.run do
-        output_driver.feed("tag", n , {"log" => "hi"})
-      end
-    end
-
-end