sherlog-holmes 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb0d8afe20c542e87e2b4872e64cceeb72328c38
-  data.tar.gz: 7ed080295dcba9f9f1b201667d324e18793d6b6b
+  metadata.gz: 7de344c1bb4ad99a2e4cb1369d9781196242f877
+  data.tar.gz: d71b629b448d315815dd00d9fcc27cdc56c3b30c
 SHA512:
-  metadata.gz: b937b606eaf4bc1b6f1a00fbe9968caa735c64820cbf4046a812e02a606a06ef897c4a76cb64d019ce88862f25ede73a0c814afbb347bebc3a026d581e0724e3
-  data.tar.gz: 88022af4cfb6e6f40633ac75d0be21c5ea16f36faf83656cebc2e7f0660613c635683400449c2b7259b229a9a98120ba064aa87d54cc934b686694b803f80bb3
+  metadata.gz: 5e8d2263e831c1f7cb06ae3101465e448594f8c5aa4e44651733a7dc73cefaae0edf35a8cefa89e8a05689f1215490f5c2bb06dde28405e62f775ef29f2f7df9
+  data.tar.gz: 02a4e999969b868d738056068b52fd67466fa8ed0560c95ce3c1fb0cb6f348fc2469fae1e8be5157eefcf3e7c75475b918de300b3a47ad5b6df1f091571caafe

data/README.md

@@ -51,6 +51,23 @@ jboss:
 
 The configuration should contain a unique id and at least a pattern for the log **entry**. Place you configuration file in a `*.yml` file inside your `$HOME/.sherlog/patterns` directory and you're ready to go!
 
+### Custom Attributes
+
+Sherlog allows you to define custom attributes by using named capture groups. Any capture group name that differs from the main fields will be stored as a custom attribute in the entry object.
+
+### Configuration Inheritance
+
+You can create a base configuration and then override some values to create another one. In this case, you need to specify the parent configuration with the `from` key:
+
+```yaml
+base.java:
+  exception: (?<exception>\w+(\.\w+)+(Exception|Error))
+  stacktrace: ^(\s+at)|(Caused by\:)|(\s+\.{3}\s\d+\smore)
+jboss:
+  from: base.java
+  entry: (?<time>[0-9,.:]+)\s+(?<level>\w+)\s+\[(?<category>\S+)\]\s\((?<origin>[^)]+)\)?\s?(?<message>.+)
+```
+
 ## Usage
 
 Shelog Holmes provides the command line tool `sherlog`. You can use this to pass a log, the filters you need to apply and the process that needs to be executed (like showing the filtered entries or counting the exceptions):
@@ -97,6 +114,14 @@ This will filter entries using the exception field. You can use the wildcard `*`
 
 This will filter entries with exceptions, regardless the kind.
 
+`-f NAME, --field NAME`
+
+This will filter entries using custom attributes found in named capture groups. This parameter specifies the custom attribute name. Use it with `-v | --value` for defining the expression.
+
+`-v EXPRESSION, --value EXPRESSION`
+
+Specifies the expression to use with the last `-f | --field` parameter. The wildcard `*` is accepted here.
+
 ### Logical Options
 
 `--and`
@@ -153,7 +178,9 @@ $ sherlog --count levels,categories log-file.log
 
 Currently, Sherlog has the following patterns:
 
+- `base.java`: base pattern for Java outputs (contains patterns for exceptions and stacktraces only)
 - `jboss`: matches Wildfly | EAP logs
+- `jboss.fuse`: matches JBoss Fuse logs
 
 ## License
 

data/bin/sherlog

@@ -58,7 +58,7 @@ def print_table(name, data)
   puts
 end
 
-@opts.banner = 'Usage: sherlog [options] <logfile>'
+@opts.banner = 'Usage: sherlog [options] [logfile ...]'
 
 @opts.separator "\n  Config Options\n".bold.white
 
@@ -100,6 +100,14 @@ end
   add_filter Filter::exceptions
 end
 
+@opts.on '-f NAME', '--field NAME', 'Sets the custom attribute filter name' do |name|
+  @field = name
+end
+
+@opts.on '-v EXPRESSION', '--value EXPRESSION', 'Sets the custom attribute filter expression' do |expression|
+  add_filter Filter::custom_attribute(@field, expression)
+end
+
 @opts.separator "\n  Logical Options\n".bold.white
 
 @opts.on '--and', 'Sets the next filter to use the AND operator' do
@@ -147,7 +155,6 @@ end
 
 @listeners[:print].hide_stacktrace if @no_stacktrace and @listeners[:print]
 
-file = ARGV.first
 parser = Sherlog.parser @type if @type
 parser ||= Parser::new
 parser.filter @filter
@@ -155,12 +162,14 @@ parser.filter @filter
   parser.on_new_entry listener
 end
 begin
-  if file
-    parser.parse file
-  else
+  if ARGV.empty?
     ARGF.each_line do |line|
       parser.parse line.chomp
     end
+  else
+    ARGV.each do |file|
+      parser.parse file
+    end
   end
   @groups.each do |group|
     print_table group, @listeners[:count].send(group).sort_by { |name, count| -count }

data/changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.4.0
+
+- Added support for multiple log files
+- Added support for custom attributes using capture groups
+- Added JBoss Fuse pattern
+- Added support for inheritance of patterns
+
+## v0.3.3
+
+- Apply filters before the entire entry was parsed
+
 ## v0.3.2
 
 - Recognize 'Fault' in JBoss exception pattern

data/conf/patterns/java.yml

@@ -0,0 +1,9 @@
+base.java:
+  exception: (?<exception>\w+(\.\w+)+(Exception|Error|Fault))
+  stacktrace: ^(\s+at)|(Caused by\:)|(\s+\.{3}\s\d+\smore)
+jboss:
+  from: base.java
+  entry: (?<time>(?<date>\d{2,4}-\d{2}-\d{2,4}\s)?(\d{2}:\d{2}:\d{2},\d{3}))\s+(?<level>\w+)\s+\[(?<category>\S+)\]\s\((?<origin>[^)]+)\)?\s?(?<message>.+)
+jboss.fuse:
+  from: base.java
+  entry: (?<time>(?<date>\d{2,4}-\d{2}-\d{2,4}\s)?(\d{2}:\d{2}:\d{2},\d{3}))\s+\|\s*(?<level>\w+)\s*\|\s*(?<origin>[^|]+)\s*\|\s*(?<category>[^|]+)\s*\|\s*(?<bundle>(?<bundle_id>\d+) - (?<bundle_name>\S+) - (?<bundle_version>\S+))\s*\|\s*(?<message>.+)

data/lib/sherlog_holmes.rb

@@ -38,11 +38,12 @@ module Sherlog
   def self.load_patterns(file)
     patterns = YAML::load_file file
     patterns.each do |id, config|
-      PATTERNS[id.to_sym] = {
-          entry: Regexp::new(config['entry']),
-          exception: Regexp::new(config['exception']),
-          stacktrace: Regexp::new(config['stacktrace'])
-      }
+      pattern_config = {}
+      pattern_config[:entry] = Regexp::new(config['entry']) if config['entry']
+      pattern_config[:exception] = Regexp::new(config['exception']) if config['exception']
+      pattern_config[:stacktrace] = Regexp::new(config['stacktrace']) if config['stacktrace']
+      pattern_config = PATTERNS[config['from'].to_sym].merge pattern_config if config['from']
+      PATTERNS[id.to_sym] = pattern_config
     end
   end
 

data/lib/sherlog_holmes/entry.rb

@@ -26,15 +26,18 @@ module Sherlog
     attr_accessor :time, :level, :category, :origin, :message, :exceptions, :stacktrace, :raw_content
 
     def initialize(params = {})
-      @time = params[:time]
-      @level = params[:level]
-      @category = params[:category]
-      @origin = params[:origin]
-      @message = params[:message]
-      @exceptions = [params[:exception]] if params[:exception]
-      @exceptions ||= params[:exceptions]
+      params = params.dup
+      @time = params.delete :time if params[:time]
+      @level = params.delete :level if params[:level]
+      @category = params.delete :category if params[:category]
+      @origin = params.delete :origin if params[:origin]
+      @message = params.delete :message if params[:message]
+      @raw_content = params.delete :raw_content if params[:raw_content]
+      @exceptions = [params.delete(:exception)] if params[:exception]
+      @exceptions ||= params.delete(:exceptions) if params[:exceptions]
       @exceptions ||= []
       @stacktrace = []
+      @custom_attributes = params
     end
 
     def exception?
@@ -49,6 +52,10 @@ module Sherlog
       @message << $/ << line
     end
 
+    def [](custom_attribute)
+      @custom_attributes[custom_attribute.to_s] or @custom_attributes[custom_attribute.to_sym]
+    end
+
     def to_s
       format = []
       params = []

data/lib/sherlog_holmes/filter.rb

@@ -57,6 +57,7 @@ module Sherlog
     end
 
     def self.expression(expression)
+      expression = expression.to_s
       Filter::new do |object|
         wildcard_at_start = expression.start_with? '*'
         wildcard_at_end = expression.end_with? '*'
@@ -110,6 +111,12 @@ module Sherlog
       end
     end
 
+    def self.custom_attribute(attribute_name, expression)
+      Filter::new do |entry|
+        expression(expression).accept? entry[attribute_name]
+      end
+    end
+
   end
 
 end

data/lib/sherlog_holmes/parser.rb

@@ -60,12 +60,12 @@ module Sherlog
       foreach input do |line|
         try_guess_pattern line unless @patterns[:entry]
         if @patterns[:entry] =~ line
-          entry_data = Hash[Regexp.last_match.names.map { |k| [k.to_sym, Regexp.last_match[k]] }]
-          notify entry
+          entry_data = Hash[Regexp.last_match.names.map { |k| [k.to_sym, Regexp.last_match[k].to_s.strip] }]
+          # notify the last entry parsed
+          notify entry if entry and @filter.accept? entry
           entry = Entry::new entry_data
           entry.raw_content = line.chomp
           entry.exceptions << Regexp.last_match[:exception] if @patterns[:exception] =~ entry.message
-          entry = nil unless @filter.accept? entry
         else
           if entry
             if entry.exception? and @patterns[:stacktrace] =~ line
@@ -78,7 +78,8 @@ module Sherlog
           end
         end
       end
-      notify entry
+      # notify the last entry parsed
+      notify entry if entry and @filter.accept? entry
     end
 
     private
@@ -100,10 +101,9 @@ module Sherlog
 
     def try_guess_pattern(line)
       key, patterns = Sherlog.loaded_patterns.find do |key, patterns|
-        patterns[:entry].match line
+        patterns[:entry].match line if patterns[:entry]
       end
-      patterns ||= {entry: /(?<message>.+)/}
-      @patterns.merge! patterns
+      @patterns.merge! patterns if patterns
     end
 
   end

data/lib/sherlog_holmes/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module Sherlog
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sherlog-holmes
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ataxexe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yummi
@@ -93,7 +93,7 @@ files:
 - Rakefile
 - bin/sherlog
 - changelog.md
-- conf/patterns/jboss.yml
+- conf/patterns/java.yml
 - lib/sherlog_holmes.rb
 - lib/sherlog_holmes/entry.rb
 - lib/sherlog_holmes/filter.rb

data/conf/patterns/jboss.yml

@@ -1,4 +0,0 @@
-jboss:
-  entry: (?<time>(\d{2}-\d{2}-\d{4}\s)?(\d{2}:\d{2}:\d{2},\d{3}))\s+(?<level>\w+)\s+\[(?<category>\S+)\]\s\((?<origin>[^)]+)\)?\s?(?<message>.+)
-  exception: (?<exception>\w+(\.\w+)+(Exception|Error|Fault))
-  stacktrace: ^(\s+at)|(Caused by\:)|(\s+\.{3}\s\d+\smore)