syslog-parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0122b53ddbdfa55a0d0f82651086678004bdb65a
+  data.tar.gz: 3ae2068c28677f19eacdc2d85735040ec35f8045
+SHA512:
+  metadata.gz: 360e9c187eb3735165e24c1838a88779fbf5897c1e6cc0d1908f649f3c608227db1492b2b74b6d22874f5c2b2a18a1840ebb300196e532b00caac30dbbd2fce0
+  data.tar.gz: e145c75a5f8fb905e920ed56ae14303d0cbc620f149413df3c543ae23be88829cdedf0ce4298bbbdd6d29445ceeb30c0636e0ba9e61708ef1497a1a850f733e0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Calle Erlandsson
+
+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,93 @@
+# Syslog::Parser
+
+Parse RFC5424 Syslog messages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syslog-parser"
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+Or install it using gem(1):
+
+```sh
+gem install syslog-parser
+```
+
+## Usage
+
+```ruby
+require "syslog/parser"
+
+parser = Syslog::Parser.new
+
+line = '<165>1 2003-10-11T22:14:15.003Z mymachine.example.com evntslog - ID47 '\
+  [exampleSDID@32473 iut="3" eventSource="Application" eventID="1011"] '\
+  'An application event log entry...'
+
+message = parser.parse(line)
+
+message.prival          #=> 165
+message.facility        #=> 20
+message.severity        #=> 5
+message.version         #=> 1
+message.timestamp       #=> 2003-10-11 22:14:15 UTC
+message.timestamp.class #=> Time
+message.hostname        #=> "mymachine.example.com"
+message.app_name        #=> "evntslog"
+message.procid          #=> nil
+message.structured_data #=> [#<struct StructuredDataElement
+# id="exampleSDID@32473"@71, params={"iut"=>"3", "eventSource"=>"Application",
+# "eventID"=>"1011"}>]
+message.msg             #=> "An application event log entry..."
+
+parser.parse("malformed") #=> "Syslog::Parser::Error: Failed to match sequence
+# (HEADER SP STRUCTURED_DATA (SP MSG)?) at line 1 char 1."
+```
+
+### Parsing messages received via Heroku HTTPS log drains
+
+The cloud application platform [Heroku][heroku] allows it's users to register
+log drains that receive Syslog formatted application log messages over HTTPS. As
+outlined in [Heroku's documentation on HTTPS Log Drains][drains], these messages
+do not fully conform to RFC5424:
+
+> “application/logplex-1” does not conform to RFC5424. It leaves out
+> STRUCTURED-DATA but does not replace it with a NILVALUE.
+
+RFC5424 requires STRUCTURED-DATA to consist of either one NILVALUE or one or
+more SD-ELEMENTs.
+
+[heroku]: https://heroku.com
+[drains]: https://devcenter.heroku.com/articles/log-drains#https-drains
+
+In order to support parsing log messages received via Heroku HTTPS log drains,
+the parser support an option that can be used to allow missing STRUCTURED-DATA:
+
+```ruby
+parser = Syslog::Parser.new(allow_missing_structured_data: true)
+
+line = "<40>1 2012-11-30T06:45:29+00:00 host app web.3 - State changed from "\
+  "starting to up"
+
+message = parser.parse(line)
+
+message.prival          #=> 40
+message.facility        #=> 5
+message.severity        #=> 0
+message.version         #=> 1
+message.timestamp       #=> 2012-11-30 06:45:29 UTC
+message.hostname        #=> "host"
+message.app_name        #=> "app"
+message.procid          #=> "web.3"
+message.structured_data #=> nil
+message.msg             #=> "State changed from starting to up"
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*.rb']
+end
+
+task :default => :test

data/lib/syslog/parser.rb

@@ -0,0 +1,19 @@
+require "syslog/parser/internal_parser"
+require "syslog/parser/transform"
+
+module Syslog
+  class Parser
+    class Error < StandardError; end
+
+    def initialize(options={})
+      @transform = Transform.new
+      @parser = InternalParser.new(options)
+    end
+
+    def parse(line)
+      @transform.apply @parser.parse(line)
+    rescue Parslet::ParseFailed => parse_failed
+      raise Error, parse_failed.message
+    end
+  end
+end

data/lib/syslog/parser/internal_parser.rb

@@ -0,0 +1,177 @@
+require "parslet"
+
+module Syslog
+  class Parser
+    class InternalParser < Parslet::Parser
+      def initialize(options={})
+        super()
+
+        @allow_missing_structured_data =
+          options.fetch(:allow_missing_structured_data, false)
+      end
+
+      root :syslog_msg
+
+      rule :syslog_msg do
+        if @allow_missing_structured_data
+          (header >> (sp >> structured_data).maybe >> (sp >> msg).maybe)
+            .as(:syslog_msg)
+        else
+          (header >> sp >> structured_data >> (sp >> msg).maybe).as(:syslog_msg)
+        end
+      end
+
+      rule :header do
+        pri >> version >> sp >> timestamp >> sp >> hostname >> sp >>
+          app_name >> sp >> procid >> sp >> msgid
+      end
+
+      rule :pri do
+        str("<") >> prival >> str(">")
+      end
+
+      rule :prival do
+        (digit.repeat(1, 3)).as(:prival) # range 0..191
+      end
+
+      rule :version do
+        (nonzero_digit >> digit.repeat(0, 2)).as(:version)
+      end
+
+      rule :hostname do
+        (nilvalue | printusascii.repeat(1, 255)).as(:hostname)
+      end
+
+      rule :app_name do
+        (nilvalue | printusascii.repeat(1, 48)).as(:app_name)
+      end
+
+      rule :procid do
+        (nilvalue | printusascii.repeat(1, 128)).as(:procid)
+      end
+
+      rule :msgid do
+        (nilvalue | printusascii.repeat(1, 32)).as(:msgid)
+      end
+
+      rule :timestamp do
+        (nilvalue | (full_date >> str("T") >> full_time)).as(:timestamp)
+      end
+
+      rule :full_date do
+        date_fullyear >> str("-") >> date_month >> str("-") >> date_mday
+      end
+
+      rule :date_fullyear do
+        digit.repeat(4, 4)
+      end
+
+      rule :date_month do
+        digit.repeat(2, 2) # 01-12
+      end
+
+      rule :date_mday do
+        digit.repeat(2, 2) # 01-28, 01-29, 01-30, 01-31 based on month/year
+      end
+
+      rule :full_time do
+        partial_time >> time_offset
+      end
+
+      rule :partial_time do
+        time_hour >> str(":") >> time_minute >> str(":") >> time_second >>
+          time_secfrac.maybe
+      end
+
+      rule :time_hour do
+        digit.repeat(2, 2) # 00-23
+      end
+
+      rule :time_minute do
+        digit.repeat(2, 2) # 00-59
+      end
+
+      rule :time_second do
+        digit.repeat(2, 2) # 00-59
+      end
+
+      rule :time_secfrac do
+        str(".") >> digit.repeat(1, 6)
+      end
+
+      rule :time_offset do
+        str("Z") | time_numoffset
+      end
+
+      rule :time_numoffset do
+        (str("+") | str("-")) >> time_hour >> str(":") >> time_minute
+      end
+
+      rule :structured_data do
+        (nilvalue | sd_element.repeat(1)).as(:structured_data)
+      end
+
+      rule :sd_element do
+        str("[") >> sd_id >> sd_params >> str("]")
+      end
+
+      rule :sd_params do
+        (sp >> sd_param).repeat.as(:sd_params)
+      end
+
+      rule :sd_param do
+        param_name >> str("=") >> str('"') >> param_value >> str('"')
+      end
+
+      rule :sd_id do
+        sd_name.as(:sd_id)
+      end
+
+      rule :param_name do
+        sd_name.as(:param_name)
+      end
+
+      rule :param_value do
+        # characters '"', '\' and ']' MUST be escaped
+        (esc_seq | char).repeat.as(:param_value)
+      end
+
+      rule :esc_seq do
+        str("\\") >> match(/[\]"]/).as(:esq_char)
+      end
+
+      rule :char do
+        match(/[\]"]/).absent? >> any.as(:char)
+      end
+
+      rule :sd_name do
+        # except '=', ' ', ']', '"'
+        (match(/[= \]"]/).absent? >> printusascii).repeat(1, 32)
+      end
+
+      rule :msg do
+        (any.repeat).as(:msg)
+      end
+
+      rule :sp do
+        str(" ")
+      end
+
+      rule :printusascii do
+        match(/[!-~]/)
+      end
+
+      rule :nonzero_digit do
+        match(/[1-9]/)
+      end
+
+      rule :digit do
+        str("0") | nonzero_digit
+      end
+
+      rule :nilvalue do
+        str("-").as(:nilvalue)
+      end
+    end
+  end
+end

data/lib/syslog/parser/message.rb

@@ -0,0 +1,19 @@
+Message = Struct.new(
+  :prival,
+  :version,
+  :timestamp,
+  :hostname,
+  :app_name,
+  :procid,
+  :msgid,
+  :structured_data,
+  :msg,
+) do
+  def facility
+    @facility ||= prival / 8
+  end
+
+  def severity
+    @severity ||= prival - facility * 8
+  end
+end

data/lib/syslog/parser/structured_data_element.rb

@@ -0,0 +1 @@
+StructuredDataElement = Struct.new(:id, :params)

data/lib/syslog/parser/transform.rb

@@ -0,0 +1,38 @@
+require "parslet"
+require "syslog/parser/message"
+require "syslog/parser/structured_data_element"
+require "time"
+
+module Syslog
+  class Parser
+    class Transform < Parslet::Transform
+      rule(nilvalue: simple(:nilvalue)) { nil }
+      rule(char: simple(:char)) { char.to_s }
+      rule(esq_char: simple(:esq_char)) { esq_char.to_s }
+
+      rule sd_id: simple(:sd_id), sd_params: subtree(:sd_params) do
+        params = sd_params.inject({}) do |params, sd_param|
+          params.merge!(
+            sd_param.fetch(:param_name).to_s =>
+              sd_param.fetch(:param_value).join,
+          )
+        end
+        StructuredDataElement.new(sd_id.to_s, params)
+      end
+
+      rule syslog_msg: subtree(:syslog_msg) do
+        Message.new(
+          Integer(syslog_msg[:prival]),
+          Integer(syslog_msg[:version]),
+          Time.parse(syslog_msg[:timestamp]),
+          syslog_msg[:hostname] && syslog_msg[:hostname].to_s,
+          syslog_msg[:app_name] && syslog_msg[:app_name].to_s,
+          syslog_msg[:procid] && syslog_msg[:procid].to_s,
+          syslog_msg[:msgid] && syslog_msg[:msgid].to_s,
+          syslog_msg[:structured_data] && syslog_msg[:structured_data],
+          syslog_msg[:msg] && syslog_msg[:msg].to_s,
+        )
+      end
+    end
+  end
+end

data/lib/syslog/parser/version.rb

@@ -0,0 +1,5 @@
+module Syslog
+  class Parser
+    VERSION = "0.1.0"
+  end
+end

data/syslog-parser.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "syslog/parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "syslog-parser"
+  spec.version = Syslog::Parser::VERSION
+  spec.authors = ["Calle Erlandsson"]
+  spec.email = ["calle@calleerlandsson.com"]
+
+  spec.summary = "Parse RFC5424 Syslog messages"
+  spec.homepage = "https://github.com/calleerlandsson/syslog-parser/"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parslet"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: syslog-parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calle Erlandsson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 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'
+description: 
+email:
+- calle@calleerlandsson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/syslog/parser.rb
+- lib/syslog/parser/internal_parser.rb
+- lib/syslog/parser/message.rb
+- lib/syslog/parser/structured_data_element.rb
+- lib/syslog/parser/transform.rb
+- lib/syslog/parser/version.rb
+- syslog-parser.gemspec
+homepage: https://github.com/calleerlandsson/syslog-parser/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Parse RFC5424 Syslog messages
+test_files: []