fluent-plugin-syslog_rfc5424 0.7.3 → 0.9.0.rc.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 678c7679f9c40aed9163e9a96c81ab956cfb8ddb
-  data.tar.gz: 20ff60bbf06f1780dc17c49e54ec05cc9bdae4b7
+SHA256:
+  metadata.gz: 31bf4f10b1fa38ddf94b55a5ad78af18ba0f36841b70bc27313918a8db0c4f7e
+  data.tar.gz: ee070ebfe99860863df6c327dce8e2e8b00bc302eaee716f27f962bd3e9d8000
 SHA512:
-  metadata.gz: 9bce27bd480431a126c9f493802ff438a25866c259adfa8366168f567e66e301f7a01c64e1409e21923a4c0e7588c7bad911a76a2e9785aa5c0088735b25a154
-  data.tar.gz: 71080495b53c144288b384c20791889287e62d21686f7fd78c1b982d3ce629e07dbdc5749af0dfd48dc3d29365dbe0a928b157abff5cea25401f25ce3ce8c7e3
+  metadata.gz: 1c7fcf1449ec7560e10e214763c3f34032f5ef9482c12bedcfd11964435aa6d8329404e2933d2b818c2b726652831e9c8d9331e2446641ca297b88403f769320
+  data.tar.gz: 6bc6865390d7b6bc8983d002e55350fbfcedfa83d06e2144dec42b2dcf3d9ba53597d1c65cade67c01f49d20dcd35b481147e0ab813be16b93a052b6d556d869

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.5.7

data/README.md

@@ -1,9 +1,8 @@
 # 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)
+[![Build Status](https://travis-ci.org/cloudfoundry/fluent-plugin-syslog_rfc5424.svg?branch=main)](https://travis-ci.org/cloudfoundry/fluent-plugin-syslog_rfc5424)
 
-
-Formatter plugin adheres to [RFC5424](https://tools.ietf.org/html/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).
 
@@ -54,9 +53,12 @@ Defaults to `syslog_rfc5424`
 | name                      |type     | description |
 | --------------            | ------- | -------     |
 | rfc6587_message_size      | boolean | prepends message length for syslog transmission (true by default)  |
+| hostname_field            | string  | sets host name in syslog from field in fluentd, delimited by '.' (default hostname) |
 | app_name_field            | string  | sets app name in syslog from field in fluentd, delimited by '.' (default app_name) |
 | proc_id_field             | string  | sets proc id in syslog from field in fluentd, delimited by '.' (default proc_id) |
-
+| message_id_field          | string  | sets msg id in syslog from field in fluentd, delimited by '.' (default message_id) |
+| structured_data_field     | string  | sets structured data in syslog from field in fluentd, delimited by '.' (default structured_data) |
+| log_field                 | string  | sets log in syslog from field in fluentd, delimited by '.' (default log) |
 
 ## Formatter Usage
 
@@ -71,7 +73,6 @@ Defaults to `syslog_rfc5424`
 </match>
 ```
 
-
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
+require 'fluent-plugin-syslog_rfc5424/version'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << "lib" << "test"
@@ -8,3 +9,7 @@ Rake::TestTask.new(:test) do |test|
 end
 
 task default: :test
+
+task :version do
+  puts FluentSyslog5424OutputPlugin::VERSION
+end

data/fluent-plugin-syslog_rfc5424.gemspec

@@ -1,10 +1,10 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
+require 'fluent-plugin-syslog_rfc5424/version'
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-syslog_rfc5424"
-  spec.version       = "0.7.3"
+  spec.version       = FluentSyslog5424OutputPlugin::VERSION
   spec.authors       = ["Pivotal"]
   spec.email         = %w(cf-loggregator@pivotal.io)
   spec.homepage      = "https://github.com/cloudfoundry/fluent-plugin-syslog_rfc5424"
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "test-unit", "~> 3.3"
   spec.add_development_dependency "test-unit-rr", "~> 1.0"
   spec.add_development_dependency "pry", "~> 0.12"

data/lib/fluent-plugin-syslog_rfc5424/version.rb

@@ -0,0 +1,3 @@
+module FluentSyslog5424OutputPlugin
+  VERSION = "0.9.0.rc.5"
+end

data/lib/fluent/plugin/formatter_syslog_rfc5424.rb

@@ -6,13 +6,21 @@ module Fluent
       Fluent::Plugin.register_formatter('syslog_rfc5424', self)
 
       config_param :rfc6587_message_size, :bool, default: true
+      config_param :hostname_field, :string, default: "hostname"
       config_param :app_name_field, :string, default: "app_name"
       config_param :proc_id_field, :string, default: "proc_id"
+      config_param :message_id_field, :string, default: "message_id"
+      config_param :structured_data_field, :string, default: "structured_data"
+      config_param :log_field, :string, default: "log"
 
       def configure(conf)
         super
+        @hostname_field_array = @hostname_field.split(".")
         @app_name_field_array = @app_name_field.split(".")
         @proc_id_field_array = @proc_id_field.split(".")
+        @message_id_field_array = @message_id_field.split(".")
+        @structured_data_field_array = @structured_data_field.split(".")
+        @log_field_array = @log_field.split(".")
       end
 
       def format(tag, time, record)
@@ -20,10 +28,13 @@ module Fluent
         log.debug(record.map { |k, v| "#{k}=#{v}" }.join('&'))
 
         msg = RFC5424::Formatter.format(
-          log: record['log'],
+          log: record.dig(*@log_field_array) || "-",
           timestamp: time,
+          hostname: record.dig(*@hostname_field_array) || "-",
           app_name: record.dig(*@app_name_field_array) || "-",
-          proc_id: record.dig(*@proc_id_field_array) || "-"
+          proc_id: record.dig(*@proc_id_field_array) || "-",
+          msg_id: record.dig(*@message_id_field_array) || "-",
+          sd: record.dig(*@structured_data_field_array) || "-"
         )
 
         log.debug("RFC 5424 Message")
@@ -35,4 +46,4 @@ module Fluent
       end
     end
   end
-end
+end

data/lib/fluent/plugin/out_syslog_rfc5424.rb

@@ -23,6 +23,10 @@ module Fluent
         @formatter = formatter_create
       end
 
+      def multi_workers_ready?
+        true
+      end
+
       def write(chunk)
         socket = find_or_create_socket(@transport.to_sym, @host, @port)
         tag = chunk.metadata.tag

data/test/plugin/formatter_syslog_rfc5424_spec.rb

@@ -65,6 +65,54 @@ class FormatterSyslogRFC5424Test < Test::Unit::TestCase
                  formatter_driver.instance.format(tag, time, record)
   end
 
+  def test_format_with_log_field
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size false
+      log_field example.custom_field
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log", "example" => {"custom_field" => "custom-value"}}
+
+    formatted_message = "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - - custom-value\n"
+    message_size = formatted_message.length
+    assert_equal "#{formatted_message}",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+
+  def test_format_with_structured_data
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size false
+      structured_data_field example.custom_field
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log", "example" => {"custom_field" => "custom-value"}}
+
+    formatted_message = "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - custom-value test-log\n"
+    message_size = formatted_message.length
+    assert_equal "#{formatted_message}",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+
+  def test_format_with_hostname
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size false
+      hostname_field example.custom_field
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log", "example" => {"custom_field" => "custom-value"}}
+
+    formatted_message = "<14>1 1970-01-01T00:00:00.123456+00:00 custom-value - - - - test-log\n"
+    message_size = formatted_message.length
+    assert_equal "#{formatted_message}",
+                 formatter_driver.instance.format(tag, time, record)
+  end
+
   def test_format_with_proc_id
     formatter_driver = create_driver %(
       @type syslog_rfc5424
@@ -81,5 +129,20 @@ class FormatterSyslogRFC5424Test < Test::Unit::TestCase
                  formatter_driver.instance.format(tag, time, record)
   end
 
+  def test_format_with_message_id
+    formatter_driver = create_driver %(
+      @type syslog_rfc5424
+      rfc6587_message_size false
+      message_id_field example.custom_field
+    )
+    tag = "test-formatter"
+    time = Fluent::EventTime.new(0, 123456000)
+    record = {"log" => "test-log", "example" => {"custom_field" => "custom-value"}}
+
+    formatted_message = "<14>1 1970-01-01T00:00:00.123456+00:00 - - - custom-value - test-log\n"
+    message_size = formatted_message.length
+    assert_equal "#{formatted_message}",
+                 formatter_driver.instance.format(tag, time, record)
+  end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-syslog_rfc5424
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.9.0.rc.5
 platform: ruby
 authors:
 - Pivotal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - README.md
 - Rakefile
 - fluent-plugin-syslog_rfc5424.gemspec
+- lib/fluent-plugin-syslog_rfc5424/version.rb
 - lib/fluent/plugin/formatter_syslog_rfc5424.rb
 - lib/fluent/plugin/out_syslog_rfc5424.rb
 - lib/rfc5424/formatter.rb
@@ -145,12 +146,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: FluentD output plugin to send messages via rfc5424