fluent-plugin-syslog_rfc5424 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2c13c193b50ef536bf9db089be1498d1952b514
+  data.tar.gz: 007fe4beed54f91085a36e69b90ac2cd6bbaca8e
+SHA512:
+  metadata.gz: a642c3522f4a24076fcddd50866f7a8d99ed5e8222ca1e363a67bae7748bf27585ecc5c80dcbcc8b3cb9c68bfa0ddfdc8b9f392f19a4f533110911d86855789a
+  data.tar.gz: 3e9d2ba3b2b566175b2ffa760c66ee987780a4501695f5c2298dd923ebcb33fd009b77b292818fefaf4566c9826aa7883f0ac44a2163c8b1d2f6f7a7d12539df

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+
+# rspec failure tracking
+.rspec_status

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+before_install: gem install bundler -v 2.0.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-syslog_rfc5424 (0.1)
+      fluentd (~> 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    cool.io (1.5.4)
+    dig_rb (1.0.1)
+    fluentd (1.8.0)
+      cool.io (>= 1.4.5, < 2.0.0)
+      dig_rb (~> 1.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 1.2.0, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    method_source (0.9.2)
+    msgpack (1.3.1)
+    power_assert (1.1.5)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rr (1.2.1)
+    serverengine (2.2.0)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.3)
+    test-unit (3.3.4)
+      power_assert
+    test-unit-rr (1.0.5)
+      rr (>= 1.1.1)
+      test-unit (>= 2.5.2)
+    tzinfo (2.0.0)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2019.3)
+      tzinfo (>= 1.0.0)
+    yajl-ruby (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fluent-plugin-syslog_rfc5424!
+  pry (~> 0.12)
+  rake (~> 10.0)
+  test-unit (~> 3.3)
+  test-unit-rr (~> 1.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright 2019 Cloud Foundry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+

data/README.md

@@ -0,0 +1,62 @@
+# SyslogRFC5424
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluentd_syslog_rfc5424'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluentd_syslog_rfc5424
+
+## Usage
+
+```
+<match **>
+  @type syslog_rfc5424
+  host SYSLOG-HOST
+  port SYSLOG-PORT
+  # transport tls, udp, tcp (defaults to tls)
+  <buffer>
+    @type memory
+    flush_interval 10s
+  </buffer>
+</match>
+```
+
+## Configuration
+
+| name              | type       | placeholder support | description                               |
+| --------------    | -------    | -----------         | ---------------------------------         |
+| host              | string     |                     | syslog target host                        |
+| port              | integer    |                     | syslog target port                        |
+| transport         | string     |                     | transport protocol (tls, udp, or tcp)     |
+
+### Common Configuration
+
+#### Buffer Section
+
+| name                        |
+| --------------              |
+| flush_mode                  |
+| flush_interval              |
+| flush_thread_interval       |
+| flush_thread_burst_interval |
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `fluentd_syslog_rfc5424.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cloudfoundry/fluentd_syslog_rfc5424.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_spec.rb"
+  test.verbose = true
+end
+
+task default: :test

data/fluent-plugin-syslog_rfc5424.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-syslog_rfc5424"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Pivotal"]
+  spec.email         = %w(cf-loggregator@pivotal.io)
+  spec.homepage      = "https://github.com/cloudfoundry/fluent-plugin-syslog_rfc5424"
+
+  spec.summary       = %q{FluentD output plugin to send messages via rfc5424}
+  spec.description   = %q{FluentD output plugin to send messages via Syslog rfc5424.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.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"
+
+  spec.add_runtime_dependency "fluentd", "~> 1.8"
+end
+

data/lib/fluent/plugin/out_syslog_rfc5424.rb

@@ -0,0 +1,25 @@
+require 'fluent/plugin/output'
+require 'rfc5424/formatter'
+
+module Fluent
+  module Plugin
+    class SyslogRFC5424 < Output
+      Fluent::Plugin.register_output('syslog_rfc5424', self)
+
+      helpers :socket
+
+      config_param :host, :string
+      config_param :port, :integer
+      config_param :transport, :string, default: "tls"
+
+      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
+      end
+    end
+  end
+end

data/lib/rfc5424/formatter.rb

@@ -0,0 +1,45 @@
+require 'date'
+
+module RFC5424
+  class Formatter
+    Format = "<%d>1 %s %s %s %s %s %s %s"
+
+    class << self
+      def format(
+        priority: 14,
+        timestamp: nil,
+        log: "",
+        hostname: "-",
+        app_name: "-",
+        proc_id: "-",
+        msg_id: "-",
+        sd: "-"
+      )
+        Format % [priority, format_time(timestamp), hostname[0..254], app_name[0..47], proc_id[0..127], msg_id[0..31], sd, log]
+      end
+
+      def format_time(timestamp)
+        return "-" if timestamp.nil?
+        return Time.at(timestamp.to_r).utc.to_datetime.rfc3339(6) if timestamp.is_a?(Fluent::EventTime)
+
+        DateTime.strptime(timestamp.to_s, '%s').rfc3339(6)
+      end
+    end
+  end
+
+  class StructuredData
+    attr_reader :sd_id, :sd_elements
+
+    def initialize(sd_id:, sd_elements: {})
+      @sd_id = sd_id
+      @sd_elements = sd_elements
+    end
+
+    def to_s
+      el = @sd_elements.inject("") do |elements, tuple|
+        elements + %{ #{tuple.first}="#{tuple.last}"}
+      end
+      %{[#{sd_id}#{el}]}
+    end
+  end
+end

data/test/plugin/syslog_rfc5424_spec.rb

@@ -0,0 +1,68 @@
+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

data/test/rfc5424/formatter_spec.rb

@@ -0,0 +1,79 @@
+require "test_helper"
+require "rfc5424/formatter"
+
+class RFC5424::FormatterTest < Test::Unit::TestCase
+  def test_only_log
+    log = RFC5424::Formatter.format( log: "test-log")
+    assert_equal log, "<14>1 - - - - - - test-log"
+  end
+
+  # RFC 3339
+  # Adding fractional seconds: https://github.com/fluent/fluentd/issues/1862
+  def test_with_timestamp
+    log = RFC5424::Formatter.format(timestamp: 0, log: "test-log")
+    assert_equal log, "<14>1 1970-01-01T00:00:00.000000+00:00 - - - - - test-log"
+  end
+
+  def test_with_timestamp_nano
+    log = RFC5424::Formatter.format(timestamp: Fluent::EventTime.new(0, 123456000), log: "test-log")
+
+    assert_equal log, "<14>1 1970-01-01T00:00:00.123456+00:00 - - - - - test-log"
+  end
+
+  def test_with_priority
+    log = RFC5424::Formatter.format( priority: 1, log: "test-log")
+    assert_equal log, "<1>1 - - - - - - test-log"
+  end
+
+  def test_with_hostname
+    log = RFC5424::Formatter.format( hostname: "host", log: "test-log")
+    assert_equal log, "<14>1 - host - - - - test-log"
+  end
+
+  def test_with_overly_long_hostname
+    log = RFC5424::Formatter.format( hostname: "a"*300, log: "test-log")
+    assert_equal log, "<14>1 - #{"a"*255} - - - - test-log"
+  end
+
+  def test_with_app_name
+    log = RFC5424::Formatter.format( app_name: "app-name", log: "test-log")
+    assert_equal log, "<14>1 - - app-name - - - test-log"
+  end
+
+  def test_with_overly_long_app_name
+    log = RFC5424::Formatter.format( app_name: "a"*300, log: "test-log")
+    assert_equal log, "<14>1 - - #{"a"*48} - - - test-log"
+  end
+
+  def test_with_proc_id
+    log = RFC5424::Formatter.format( proc_id: "proc-id", log: "test-log")
+    assert_equal log, "<14>1 - - - proc-id - - test-log"
+  end
+
+  def test_with_overly_long_proc_id
+    log = RFC5424::Formatter.format( proc_id: "a"*300, log: "test-log")
+    assert_equal log, "<14>1 - - - #{"a"*128} - - test-log"
+  end
+
+  def test_with_msg_id
+    log = RFC5424::Formatter.format( msg_id: "msg-id", log: "test-log")
+    assert_equal log, "<14>1 - - - - msg-id - test-log"
+  end
+
+  def test_with_overly_long_msg_id
+    log = RFC5424::Formatter.format( msg_id: "a"*300, log: "test-log")
+    assert_equal log, "<14>1 - - - - #{"a"*32} - test-log"
+  end
+
+  def test_structured_data
+    structured_data = RFC5424::StructuredData.new(sd_id: "test@123", sd_elements: {"a" => "a-value", "b" => "b-value"})
+    assert_equal structured_data.to_s, '[test@123 a="a-value" b="b-value"]'
+  end
+
+  def test_with_structured_data
+    structured_data_1 = RFC5424::StructuredData.new(sd_id: "test@123", sd_elements: {"a" => "a-value"})
+    structured_data_2 = RFC5424::StructuredData.new(sd_id: "test2@123", sd_elements: {"b" => "b-value"})
+    log = RFC5424::Formatter.format( sd: structured_data_1.to_s + structured_data_2.to_s, log: "test-log")
+    assert_equal log, '<14>1 - - - - - [test@123 a="a-value"][test2@123 b="b-value"] test-log'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require "bundler/setup"
+require "test/unit"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require "fluent/test"
+require "fluent/test/driver/output"
+
+require 'test/unit/rr'
+require 'pry'

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-syslog_rfc5424
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pivotal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: FluentD output plugin to send messages via Syslog rfc5424.
+email:
+- cf-loggregator@pivotal.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-syslog_rfc5424.gemspec
+- lib/fluent/plugin/out_syslog_rfc5424.rb
+- lib/rfc5424/formatter.rb
+- test/plugin/syslog_rfc5424_spec.rb
+- test/rfc5424/formatter_spec.rb
+- test/test_helper.rb
+homepage: https://github.com/cloudfoundry/fluent-plugin-syslog_rfc5424
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: FluentD output plugin to send messages via rfc5424
+test_files:
+- test/plugin/syslog_rfc5424_spec.rb
+- test/rfc5424/formatter_spec.rb
+- test/test_helper.rb