fluent-plugin-syslog-tls 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d451a9db525bf51ce92a8fb6ba314e07ef4fde7
-  data.tar.gz: 578fa7e673a40b1a469bb7eb70681f0cfe102878
+  metadata.gz: 324422e8c80df4ca6f7e9f1ad4cf14d96ad189a1
+  data.tar.gz: 69868f4d0613caa60ea5b931991111c1265996c9
 SHA512:
-  metadata.gz: e8f97eb7e0028c5a41735c8c474128b0ec6181aaac527e5772c984a22ee9ba4e5e424cd1aceae806bebe5f42b4768e3647d8d3d07a44e4c0db14b630e7660a55
-  data.tar.gz: d8121c0078122038002ccb99c7888a125656e3728d2a75588408ccbd55e23563d5d5ce1ac6a7945ee68c8933c78549e401af02e2b76d7791360d0bd263123ee9
+  metadata.gz: afb23e11616650e54e81c0053aa144549166f1db125abce497f3c4cf2804d382e2a9b210b9175148b87615eccb2019485b470b29da8d35219279bb24c840c292
+  data.tar.gz: 7e2956875721d149ead943fce796df6dc5ef277a996f8d16b1632b3c095cae3d54c7eeaf606a8f23a7a657575bc217b0dfd6cf18ab49a6fedffa95ed2da54f31

data/.gitignore

@@ -2,7 +2,6 @@
 *.rbc
 /.config
 /coverage/
-/Gemfile.lock
 /InstalledFiles
 /pkg/
 /spec/reports/
@@ -30,8 +29,8 @@ build/
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+#### 1.2.0
+
+* Improve compliance with Fluentd 0.14 API.
+* Eliminate excess Message#header object creation.
+
+
 #### 1.1.0
 
 * Renamed `cert` and `key` to `client_cert` and `client_key` respectively.
@@ -11,7 +17,14 @@
 * Standard fluent formatting plugins are supported. Json output remains the default.
 * `token` (Structured Data in syslog terms) is now optional, for syslog hosts that don't require it.
 * Message payload in the syslog packet no longer duplicates Time or includes Tag by default.
+* Requires Fluent 0.14.
+
+
+#### 0.5.0
+
+Comparable to v1.0.0, but compatible with Fluent 0.12.
+
 
+#### < 0.2.0
 
-#### < 1.0.0
 From [Fluent::Plugin::SumologicCloudSyslog](https://github.com/acquia/fluent-plugin-sumologic-cloud-syslog)

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-syslog-tls (1.2.0)
+      fluentd (~> 0.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    cool.io (1.5.3)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    fluentd (0.14.24)
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 0.7.0, < 2.0.0)
+      ruby_dig (~> 0.0.2)
+      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)
+    hashdiff (0.3.7)
+    http_parser.rb (0.6.0)
+    json (2.1.0)
+    minitest (5.10.3)
+    minitest-stub_any_instance (1.0.1)
+    msgpack (1.1.0)
+    power_assert (1.1.1)
+    public_suffix (3.0.1)
+    rake (12.3.0)
+    ruby_dig (0.0.2)
+    safe_yaml (1.0.4)
+    serverengine (2.0.5)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    strptime (0.1.9)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    test-unit (3.2.6)
+      power_assert
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.16.0)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2017.3)
+      tzinfo (>= 1.0.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yajl-ruby (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  fluent-plugin-syslog-tls!
+  minitest (~> 5.8)
+  minitest-stub_any_instance (~> 1.0.0)
+  rake
+  simplecov (~> 0.11)
+  test-unit (~> 3.1)
+  webmock (~> 2.0)
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -8,7 +8,7 @@ Tested with [Papertrail](https://papertrailapp.com) and should also work with [S
 
 
 ## Installation
----
+
 ```sh
 $ gem install fluent-plugin-syslog-tls
 ```
@@ -17,11 +17,11 @@ or
 $ td-agent-gem install fluent-plugin-syslog-tls
 ```
 
-Note: `fluent-plugin-syslog-tls` is compatible with Fluent 0.14.
+Note: `fluent-plugin-syslog-tls` is compatible with Fluent 0.14. For Fluent 0.12, see the `fluent-0.12` branch.
 
 
 ## Configuration
----
+
 In your Fluentd configuration, use `@type syslog_tls`. Examples:
 
 Sumologic:
@@ -54,7 +54,7 @@ This plugin is derived from [Fluent::Plugin::SumologicCloudSyslog](https://githu
 
 
 ## License
----
+
 Except as otherwise noted this software is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
 
 Licensed under the Apache License, Version 2.0 (the "License");

data/fluent-plugin-syslog-tls.gemspec

@@ -33,11 +33,10 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.3.0'
 
   s.add_runtime_dependency 'fluentd', '~> 0.14.0'
-  s.add_runtime_dependency 'fluent-mixin-config-placeholders', '~> 0.3'
 
   s.add_development_dependency 'minitest', '~> 5.8'
   s.add_development_dependency 'minitest-stub_any_instance', '~> 1.0.0'
-  s.add_development_dependency 'rake', '~> 10.5'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'test-unit', '~> 3.1'
   s.add_development_dependency 'webmock', '~> 2.0'
   s.add_development_dependency 'simplecov', '~> 0.11'

data/lib/fluent/plugin/out_syslog_tls.rb

@@ -13,16 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'fluent/mixin/config_placeholders'
 require 'socket'
+require 'syslog_tls/logger'
+require 'fluent/plugin/output'
 
-module Fluent
-  class SyslogTlsOutput < Fluent::Output
+module Fluent::Plugin
+  class SyslogTlsOutput < Output
     Fluent::Plugin.register_output('syslog_tls', self)
 
-    include Fluent::Mixin::ConfigPlaceholders
-    include Fluent::HandleTagNameMixin
-
     helpers :inject, :formatter, :compat_parameters
 
     DEFAULT_FORMAT_TYPE = 'json'
@@ -55,13 +53,12 @@ module Fluent
 
     def initialize
       super
-      require 'syslog_tls/logger'
       @loggers = {}
     end
 
     def shutdown
-      super
       @loggers.values.each(&:close)
+      super
     end
 
     # This method is called before starting.
@@ -114,8 +111,7 @@ module Fluent
       @formatter.format(tag, time, record)
     end
 
-    def emit(tag, es, chain)
-      chain.next
+    def process(tag, es)
       es.each do |time, record|
         record.each_pair do |_, v|
           v.force_encoding('utf-8') if v.is_a?(String)

data/lib/syslog_tls/protocol.rb

@@ -25,7 +25,8 @@ module SyslogTls
 
   # All headers by specification wrapped in single object
   class Header
-    attr_accessor :facility, :severity, :version, :timestamp, :hostname, :app_name, :procid, :msgid
+    attr_accessor :version, :hostname, :app_name, :procid, :msgid
+    attr_reader :facility, :severity, :timestamp
 
     FACILITIES = {}
     SEVERITIES = {}
@@ -110,12 +111,16 @@ module SyslogTls
 
   # Message represents full message that can be sent to syslog
   class Message
-    attr_accessor :header, :structured_data, :msg
+    attr_accessor :structured_data, :msg
+    attr_writer :header
 
     def initialize
       @msg = ''
       @structured_data = []
-      @header = Header.new
+    end
+
+    def header
+      @header ||= Header.new
     end
 
     def assemble

data/lib/syslog_tls/ssl_transport.rb

@@ -161,7 +161,7 @@ module SyslogTls
     end
 
     def select_with_timeout(tcp, type)
-      o = case type
+      case type
       when :connect_read
         args = [[tcp], nil, nil, CONNECT_TIMEOUT]
       when :connect_write

data/lib/syslog_tls/version.rb

@@ -14,5 +14,5 @@
 # limitations under the License.
 
 module SyslogTls
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/fluent/test_out_syslog_tls.rb

@@ -18,6 +18,7 @@ require 'ssl'
 require 'date'
 require 'minitest/mock'
 require 'fluent/plugin/out_syslog_tls'
+require 'fluent/test/driver/output'
 
 class SyslogTlsOutputTest < Test::Unit::TestCase
   include SSLTestHelper
@@ -27,8 +28,8 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
     @driver = nil
   end
 
-  def driver(tag='test', conf='')
-    @driver ||= Fluent::Test::OutputTestDriver.new(Fluent::SyslogTlsOutput, tag).configure(conf)
+  def driver(conf='')
+    @driver ||= Fluent::Test::Driver::Output.new(Fluent::Plugin::SyslogTlsOutput).configure(conf)
   end
 
   def sample_record
@@ -45,7 +46,7 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
   def mock_logger(token='TOKEN')
     io = StringIO.new
     io.set_encoding('utf-8')
-    logger = ::SyslogTls::Logger.new(io, token)
+    ::SyslogTls::Logger.new(io, token)
   end
 
   def test_configure
@@ -56,7 +57,7 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       client_key
       token  1234567890
     }
-    instance = driver('test', config).instance
+    instance = driver(config).instance
 
     assert_equal 'syslog.collection.us1.sumologic.com', instance.host
     assert_equal '6514', instance.port
@@ -72,16 +73,14 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       client_cert
       client_key
     }
-    instance = driver('test', config).instance
+    instance = driver(config).instance
 
     time = Time.now
     record = sample_record
     logger = mock_logger(instance.token)
 
     instance.stub(:new_logger, logger) do
-      chain = Minitest::Mock.new
-      chain.expect(:next, nil)
-      instance.emit('test', {time.to_i => record}, chain)
+      instance.process('test', {time.to_i => record})
     end
 
     assert_equal "<134>1 #{time.to_datetime.rfc3339} - - - - - #{record.to_json.to_s}\n\n", logger.transport.string
@@ -99,16 +98,14 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       app_name_key app_name
       msgid_key msgid
     }
-    instance = driver('test', config).instance
+    instance = driver(config).instance
 
     time = Time.now
     record = sample_record
     logger = mock_logger
 
     instance.stub(:new_logger, logger) do
-      chain = Minitest::Mock.new
-      chain.expect(:next, nil)
-      instance.emit('test', {time.to_i => record}, chain)
+      instance.process('test', {time.to_i => record})
     end
 
     assert_true logger.transport.string.start_with?("<134>1 #{time.to_datetime.rfc3339} host app #{$$} 1000 [TOKEN]")
@@ -123,16 +120,14 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       token  1234567890
       severity_key severity
     }
-    instance = driver('test', config).instance
+    instance = driver(config).instance
 
     time = Time.now
     record = sample_record
     logger = mock_logger
 
     instance.stub(:new_logger, logger) do
-      chain = Minitest::Mock.new
-      chain.expect(:next, nil)
-      instance.emit('test', {time.to_i => record}, chain)
+      instance.process('test', {time.to_i => record})
     end
 
     assert_true logger.transport.string.start_with?("<128>1")
@@ -148,16 +143,14 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       format out_file
       localtime false
     }
-    instance = driver('test', config).instance
+    instance = driver(config).instance
 
     time = Time.now
     record = sample_record
     logger = mock_logger
 
     instance.stub(:new_logger, logger) do
-      chain = Minitest::Mock.new
-      chain.expect(:next, nil)
-      instance.emit('test', {time.to_i => record}, chain)
+      instance.process('test', {time.to_i => record})
     end
 
     formatted_time = time.dup.utc.strftime("%Y-%m-%dT%H:%M:%SZ")
@@ -186,13 +179,10 @@ class SyslogTlsOutputTest < Test::Unit::TestCase
       app_name_key app_name
       msgid_key msgid
     }
-    instance = driver('test', config).instance
-
-    chain = Minitest::Mock.new
-    chain.expect(:next, nil)
+    instance = driver(config).instance
 
     SyslogTls::SSLTransport.stub_any_instance(:get_ssl_connection, ssl_client) do
-      instance.emit('test', {time.to_i => record}, chain)
+      instance.process('test', {time.to_i => record})
     end
 
     st.join

data/test/helper.rb

@@ -19,12 +19,6 @@ SimpleCov.start
 
 Coveralls.wear! if ENV['TRAVIS']
 
-# Fluentd sets default encoding to ASCII-8BIT, but coverall can load git data which can contain UTF-8 characters
-at_exit do
-  Encoding.default_internal = 'UTF-8' if defined?(Encoding) && Encoding.respond_to?(:default_internal)
-  Encoding.default_external = 'UTF-8' if defined?(Encoding) && Encoding.respond_to?(:default_external)
-end
-
 require 'test/unit'
 require 'fluent/test'
 require 'minitest/pride'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-syslog-tls
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-25 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: fluent-mixin-config-placeholders
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +120,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -173,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Fluent Syslog TLS output plugin