fluent-plugin-papertrail 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42c8af52e623ffec4a15ded0e4ae8e9e904b7d79
-  data.tar.gz: 94d4af82a033ca41c2a034ec69f8c536819555f9
+  metadata.gz: 84fddf384c62427d43c934b1665c7c3ec1744829
+  data.tar.gz: 5318b95c3ef4621148087541c0c0c5fa4a88504c
 SHA512:
-  metadata.gz: 4f147daa44061c16cc727d385436e7ed82edefb59e994466140b6d9e0079239c86431e060ceefb6788ba618894e8e223f53781d6e4626430b9726f6a9d0f1a4e
-  data.tar.gz: bc4c1fbbae79595517d6849012113f5b039f01ee5ff93b14957676fde22e4de8cc268cdf0b6c00aa1b4dcbee551f4aca950172ebb44eb570df55c5830b6c4a5c
+  metadata.gz: 22c893fa7c09ded365afe97a06aae47385a23e103f88b061a94bda5f924439e39c7356d54db4cd6dab2f89774afba941825ea00dbf489246fbe48a8c9a6b9630
+  data.tar.gz: d824bdcbe541245b3a2e023f9b5bb38b4f1d37783c25548e5e25238b71f81c46a0de64f0ab956a41981c67a9cd9a8b25fbeac74d1998b1ebd4f00282fda7b9a4

data/LICENSE

@@ -199,3 +199,19 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
+
+------------------------------------------------
+
+This software includes portions of syslog_protocol from https://github.com/eric/syslog_protocol/
+under the following MIT license:
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Jake Douglas and Eric Lindvall
+
+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

@@ -119,4 +119,4 @@ The gem is available as open source under the terms of the [Apache License](LICE
 
 # Questions/Comments?
 
-Please [open an issue](https://github.com/solarwinds/fluent-plugin-papertrail/issues/new), we'd love to hear from you. As a SolarWinds Innovation Project, this adapter is supported in a best-effort fashion.
+Please [open an issue](https://github.com/solarwinds/fluent-plugin-papertrail/issues/new), we'd love to hear from you.

data/fluent-plugin-papertrail.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-papertrail"
-  spec.version       = "0.2.7"
-  spec.authors       = ["Jonathan Lozinski", "Alex Ouzounis", "Chris Rust"]
-  spec.email         = ["jonathan.lozinski@solarwinds.com", "alex.ouzounis@solarwinds.com", "chris.rust@solarwinds.com"]
+  spec.version       = "0.2.8"
+  spec.authors       = ["Jonathan Lozinski", "Alex Ouzounis", "Chris Rust", "Chris Erway"]
+  spec.email         = ["jonathan.lozinski@solarwinds.com", "alex.ouzounis@solarwinds.com", "chris.rust@solarwinds.com", "chris.erway@solarwinds.com"]
 
   spec.summary       = %q{Remote Syslog Output Fluentd plugin for papertrail}
   spec.description   = %q{Remote Syslog Output Fluentd plugin for papertrail}
@@ -22,7 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "fluentd", '>= 0.10', '< 2'
   spec.add_dependency "fluent-mixin-config-placeholders", "~> 0.4.0"
-  spec.add_dependency "syslog_protocol"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/fluent/plugin/out_papertrail.rb

@@ -81,7 +81,7 @@ module Fluent
       packet.facility = record['facility'] || 'local0'
       packet.severity = record['severity'] || 'info'
       packet.tag      = record['program'] || tag
-      packet.content  = record['message']
+      packet.content  = record['message'] || record['log']
       packet.time     = time ? Time.at(time) : Time.now
       packet
     end

data/lib/syslog_protocol.rb

@@ -0,0 +1,8 @@
+require 'syslog_protocol/common'
+require 'syslog_protocol/packet'
+require 'syslog_protocol/logger'
+require 'syslog_protocol/parser'
+
+module SyslogProtocol
+  VERSION = '0.9.2'
+end

data/lib/syslog_protocol/common.rb

@@ -0,0 +1,79 @@
+module SyslogProtocol
+  # These hashes stolen from Syslog.pm
+  
+  FACILITIES = {
+    'kern'     => 0,
+    'user'     => 1,
+    'mail'     => 2,
+    'daemon'   => 3,
+    'auth'     => 4,
+    'syslog'   => 5,
+    'lpr'      => 6,
+    'news'     => 7,
+    'uucp'     => 8,
+    'cron'     => 9,
+    'authpriv' => 10,
+    'ftp'      => 11,
+    'ntp'      => 12,
+    'audit'    => 13,
+    'alert'    => 14,
+    'at'       => 15,
+    'local0'   => 16,
+    'local1'   => 17,
+    'local2'   => 18,
+    'local3'   => 19,
+    'local4'   => 20,
+    'local5'   => 21,
+    'local6'   => 22,
+    'local7'   => 23
+  }
+  
+  FACILITY_INDEX = {
+    0   => 'kern',
+    1   => 'user',
+    2   => 'mail',
+    3   => 'daemon',
+    4   => 'auth',
+    5   => 'syslog',
+    6   => 'lpr',
+    7   => 'news',
+    8   => 'uucp',
+    9   => 'cron',
+    10  => 'authpriv',
+    11  => 'ftp',
+    12  => 'ntp',
+    13  => 'audit',
+    14  => 'alert',
+    15  => 'at',
+    16  => 'local0',
+    17  => 'local1',
+    18  => 'local2',
+    19  => 'local3',
+    20  => 'local4',
+    21  => 'local5',
+    22  => 'local6',
+    23  => 'local7'
+  }
+  
+  SEVERITIES = {
+    'emerg'   => 0,
+    'alert'   => 1,
+    'crit'    => 2,
+    'err'     => 3,
+    'warn'    => 4,
+    'notice'  => 5,
+    'info'    => 6,
+    'debug'   => 7 
+  }
+  
+  SEVERITY_INDEX = {
+    0  => 'emerg',
+    1  => 'alert',
+    2  => 'crit',
+    3  => 'err',
+    4  => 'warn',
+    5  => 'notice',
+    6  => 'info',
+    7  => 'debug'
+  }
+end

data/lib/syslog_protocol/logger.rb

@@ -0,0 +1,21 @@
+module SyslogProtocol
+  class Logger
+    def initialize(hostname, tag, facility)
+      @packet = Packet.new
+      @packet.hostname = hostname
+      @packet.tag      = tag
+      @packet.facility = facility
+    end
+    
+    SEVERITIES.each do |k,v|
+      define_method(k) do |content|
+        raise ArgumentError.new("Message may not be omitted") unless content and content.length > 0
+
+        p = @packet.dup
+        p.severity = k
+        p.content = content
+        p.assemble
+      end
+    end
+  end
+end

data/lib/syslog_protocol/packet.rb

@@ -0,0 +1,135 @@
+module SyslogProtocol
+  class Packet
+    attr_reader :facility, :severity, :hostname, :tag
+    attr_accessor :time, :content
+
+    def to_s
+      assemble
+    end
+
+    def assemble(max_size = 1024)
+      unless @hostname and @facility and @severity and @tag
+        raise "Could not assemble packet without hostname, tag, facility, and severity"
+      end
+      data = "<#{pri}>#{generate_timestamp} #{@hostname} #{@tag}: #{@content}"
+
+      if string_bytesize(data) > max_size
+        data = data.slice(0, max_size)
+        while string_bytesize(data) > max_size
+          data = data.slice(0, data.length - 1)
+        end
+      end
+
+      data
+    end
+
+    def facility=(f)
+      if f.is_a? Integer
+        if (0..23).include?(f)
+          @facility = f
+        else
+          raise ArgumentError.new "Facility must be within 0-23"
+        end
+      elsif f.is_a? String
+        if facility = FACILITIES[f]
+          @facility = facility
+        else
+          raise ArgumentError.new "'#{f}' is not a designated facility"
+        end
+      else
+        raise ArgumentError.new "Facility must be a designated number or string"
+      end
+    end
+
+    def tag=(t)
+      unless t && t.is_a?(String) && t.length > 0
+        raise ArgumentError, "Tag must not be omitted"
+      end
+      if t.length > 1024
+        raise ArgumentError, "Tag must not be longer than 1024 characters"
+      end
+      if t =~ /\s/
+        raise ArgumentError, "Tag may not contain spaces"
+      end
+      if t =~ /[^\x21-\x7E]/
+        raise ArgumentError, "Tag may only contain ASCII characters 33-126"
+      end
+
+      @tag = t
+    end
+
+    def severity=(s)
+      if s.is_a? Integer
+        if (0..7).include?(s)
+          @severity = s
+        else
+          raise ArgumentError.new "Severity must be within 0-7"
+        end
+      elsif s.is_a? String
+        if severity = SEVERITIES[s]
+          @severity = severity
+        else
+          raise ArgumentError.new "'#{s}' is not a designated severity"
+        end
+      else
+        raise ArgumentError.new "Severity must be a designated number or string"
+      end
+    end
+
+    def hostname=(h)
+      unless h and h.is_a? String and h.length > 0
+        raise ArgumentError.new("Hostname may not be omitted")
+      end
+      if h =~ /\s/
+        raise ArgumentError.new("Hostname may not contain spaces")
+      end
+      if h =~ /[^\x21-\x7E]/
+        raise ArgumentError.new("Hostname may only contain ASCII characters 33-126")
+      end
+      @hostname = h
+    end
+
+    def facility_name
+      FACILITY_INDEX[@facility]
+    end
+
+    def severity_name
+      SEVERITY_INDEX[@severity]
+    end
+
+    def pri
+      (@facility * 8) + @severity
+    end
+
+    def pri=(p)
+      unless p.is_a? Integer and (0..191).include?(p)
+        raise ArgumentError.new "PRI must be a number between 0 and 191"
+      end
+      @facility = p / 8
+      @severity = p - (@facility * 8)
+    end
+
+    def generate_timestamp
+      time = @time || Time.now
+      # The timestamp format requires that a day with fewer than 2 digits have
+      # what would normally be a preceding zero, be instead an extra space.
+      day = time.strftime("%d")
+      day = day.sub(/^0/, ' ') if day =~ /^0\d/
+      time.strftime("%b #{day} %H:%M:%S")
+    end
+
+    if "".respond_to?(:bytesize)
+      def string_bytesize(string)
+        string.bytesize
+      end
+    else
+      def string_bytesize(string)
+        string.length
+      end
+    end
+
+    SEVERITIES.each do |k,v|
+      define_method("#{k}?") { SEVERITIES[k] == @severity }
+    end
+  end
+end

data/lib/syslog_protocol/parser.rb

@@ -0,0 +1,57 @@
+require 'time'
+
+module SyslogProtocol
+  
+  def self.parse(msg, origin=nil)
+    packet = Packet.new
+    original_msg = msg.dup
+    pri = parse_pri(msg)
+    if pri and (pri = pri.to_i).is_a? Integer and (0..191).include?(pri)
+      packet.pri = pri
+    else
+      # If there isn't a valid PRI, treat the entire message as content
+      packet.pri = 13
+      packet.time = Time.now
+      packet.hostname = origin || 'unknown'
+      packet.content = original_msg
+      return packet
+    end
+    time = parse_time(msg)
+    if time
+      packet.time = Time.parse(time)
+    else
+      packet.time = Time.now
+    end
+    hostname = parse_hostname(msg)
+    packet.hostname = hostname || origin
+    if m = msg.match(/^(\w+)(: | )(.*)$/)
+      packet.tag = m[1]
+      packet.content = m[3]
+    else
+      packet.tag = 'unknown'
+      packet.content = msg
+    end
+    packet
+  end
+  
+  private
+  
+  def self.parse_pri(msg)
+    pri = msg.slice!(/<(\d\d?\d?)>/)
+    pri = pri.slice(/\d\d?\d?/) if pri
+    if !pri or (pri =~ /^0/ and pri !~ /^0$/)
+      return nil
+    else
+      return pri
+    end
+  end
+  
+  def self.parse_time(msg)
+    msg.slice!(/(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s(\s|[1-9])\d\s\d\d:\d\d:\d\d\s/)
+  end
+  
+  def self.parse_hostname(msg)
+    msg.slice!(/^[\x21-\x7E]+\s/).rstrip
+  end
+  
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-papertrail
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Jonathan Lozinski
 - Alex Ouzounis
 - Chris Rust
+- Chris Erway
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -46,20 +47,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: syslog_protocol
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -121,6 +108,7 @@ email:
 - jonathan.lozinski@solarwinds.com
 - alex.ouzounis@solarwinds.com
 - chris.rust@solarwinds.com
+- chris.erway@solarwinds.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,6 +122,11 @@ files:
 - Rakefile
 - fluent-plugin-papertrail.gemspec
 - lib/fluent/plugin/out_papertrail.rb
+- lib/syslog_protocol.rb
+- lib/syslog_protocol/common.rb
+- lib/syslog_protocol/logger.rb
+- lib/syslog_protocol/packet.rb
+- lib/syslog_protocol/parser.rb
 homepage: https://github.com/solarwinds/fluent-plugin-papertrail
 licenses:
 - Apache-2.0
@@ -154,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Remote Syslog Output Fluentd plugin for papertrail