vidibus-wowza_log_parser 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2013 punkrats
+
+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,75 @@
+# Vidibus::WowzaLogParser [![Build Status](https://travis-ci.org/vidibus/vidibus-wowza_log_parser.png)](https://travis-ci.org/vidibus/vidibus-wowza_log_parser)
+
+A simple parser for Wowza access logs.
+
+This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications.
+
+
+## Installation
+
+Add `gem 'vidibus-wowza_log_parser'` to the Gemfile of your application. Then call `bundle install` on your console.
+
+
+## Usage
+
+To parse an access log, provide the path to a file or just the log lines:
+
+```ruby
+parser = Vidibus::WowzaLogParser.new
+parser.parse('path/to/access.log')
+# => [{}, {}, ...]
+
+parser.parse('a log line')
+# => [{}, {}, ...]
+```
+
+The parser will use Wowza's default fields to match the logs:
+
+```
+date time  tz  x-event x-category  x-severity  x-status  x-ctx x-comment x-vhost x-app x-appinst x-duration  s-ip  s-port  s-uri c-ip  c-proto c-referrer  c-user-agent  c-client-id cs-bytes  sc-bytes  x-stream-id x-spos  cs-stream-bytes sc-stream-bytes x-sname x-sname-query x-file-name x-file-ext  x-file-size x-file-length x-suri  x-suri-stem x-suri-query  cs-uri-stem cs-uri-query
+```
+
+Thus each result hash will include all fields with values while omitting the blank entries:
+
+```ruby
+  line = '2013-09-17  00:00:04  CEST  comment server  WARN  200 - LiveMediaStreamReceiver.doWatchdog: streamTimeout - - - 382109.883  - - - - - - - - - - - - - - - - - - - - - - - - -'
+  parser = Vidibus::WowzaLogParser.new
+  parser.parse(line)
+  # => {
+  #  'date' => '2013-09-17',
+  #  'time' => '00:00:04',
+  #  'tz' => 'CEST',
+  #  'x-event' => 'comment',
+  #  'x-category' => 'server',
+  #  'x-severity' => 'WARN',
+  #  'x-status' => '200',
+  #  'x-comment' => 'LiveMediaStreamReceiver.doWatchdog: streamTimeout',
+  #  'x-duration' => '382109.883'
+  #}
+```
+
+If you have a different log format or want to group values, you may provide custom fields and matchers:
+
+```ruby
+  line = '2013-09-17  00:00:04  CEST  comment server  WARN  200 - LiveMediaStreamReceiver.doWatchdog: streamTimeout - - - 382109.883  - - - - - - - - - - - - - - - - - - - - - - - - -'
+  parser = Vidibus::WowzaLogParser.new
+  parser.fields = 'datetime content'
+  parser.matchers['datetime'] = '(.+ CEST)'
+  parser.matchers['content'] = '(.+)'
+  parser.parse(line)
+  # => {
+  #  'datetime' => '2013-09-17  00:00:04  CEST',
+  #  'content' => 'comment server  WARN  200 - LiveMediaStreamReceiver.doWatchdog: streamTimeout - - - 382109.883  - - - - - - - - - - - - - - - - - - - - - - - - -',
+  #}
+```
+
+
+## Testing
+
+To test your gem, call `rspec spec` on your console.
+To imitate the way Travis tests your gem, perform `bundle exec rspec spec --format progress`.
+
+
+## Copyright
+
+© 2013 punkrats. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,17 @@
+$:.unshift File.expand_path('../lib/', __FILE__)
+
+require 'bundler'
+require 'rdoc/task'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'vidibus/wowza_log_parser'
+
+Bundler::GemHelper.install_tasks
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vidibus-wowza_log_parser #{Vidibus::WowzaLogParser::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--charset=utf-8'
+end

data/lib/vidibus/wowza_log_parser.rb

@@ -0,0 +1,68 @@
+module Vidibus
+  class WowzaLogParser
+    VERSION = '0.1.0'
+    FIELDS = 'date time  tz  x-event x-category  x-severity  x-status  x-ctx x-comment x-vhost x-app x-appinst x-duration  s-ip  s-port  s-uri c-ip  c-proto c-referrer  c-user-agent  c-client-id cs-bytes  sc-bytes  x-stream-id x-spos  cs-stream-bytes sc-stream-bytes x-sname x-sname-query x-file-name x-file-ext  x-file-size x-file-length x-suri  x-suri-stem x-suri-query  cs-uri-stem cs-uri-query'
+    MATCHERS = {
+      '_field' => '([^\s]+)',
+      '_space' => '\s+',
+      'x-status' => '((?:\d+|-))',
+      'x-comment' => '(.+)',
+      'x-duration' => '(\d+\.\d+)',
+      'c-proto' => '([^\s]+(?:\s\(.+\))?)',
+      'c-user-agent' => '(.+?)',
+      'c-client-id' => '((?:\d+|-))'
+    }
+
+    def fields
+      @fields ||= FIELDS
+    end
+
+    def fields=(input)
+      @fields_list = nil
+      @fields = input
+    end
+
+    def matchers
+      @matchers ||= MATCHERS
+    end
+
+    def matchers=(input)
+      @fields_list = nil
+      @matchers = input
+    end
+
+    def parse(input, options = {})
+      unless input
+        raise(ArgumentError, 'No input given')
+      end
+      if File.file?(input)
+        input = File.read(input)
+      end
+      filter = options[:filter]
+      output = []
+      input.split(/\n+/).each do |line|
+        next if filter && !line.match(filter)
+        if match = line.match(regex)
+          values = match.to_a[1..-1]
+          output << Hash[[keys, values].transpose].reject {|k,v| v == '-'}
+        end
+      end
+      output
+    end
+
+    private
+
+    def regex
+      regex_parts = []
+      keys.each do |field|
+        regex = matchers[field] || matchers['_field']
+        regex_parts << regex
+      end
+      regex = '^' + regex_parts.join(matchers['_space']) + '$'
+    end
+
+    def keys
+      @keys ||= fields.split(Regexp.new(matchers['_space']))
+    end
+  end
+end

data/lib/vidibus-wowza_log_parser.rb

@@ -0,0 +1 @@
+require 'vidibus/wowza_log_parser'

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: vidibus-wowza_log_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- punkrats
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple parser for Wowza access logs
+email: andre@webwarelab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vidibus/wowza_log_parser.rb
+- lib/vidibus-wowza_log_parser.rb
+- LICENSE
+- README.md
+- Rakefile
+homepage: https://github.com/vidibus/vidibus-wowza_log_parser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -672349600621671041
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: vidibus-wowza_log_parser
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple parser for Wowza access logs
+test_files: []