sherlog-holmes 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7de344c1bb4ad99a2e4cb1369d9781196242f877
-  data.tar.gz: d71b629b448d315815dd00d9fcc27cdc56c3b30c
+  metadata.gz: cfabfad5c19ca3571ca67c3a4aab466b8018cc0c
+  data.tar.gz: a5a3e6f5657835d46abd367894e565e52be653aa
 SHA512:
-  metadata.gz: 5e8d2263e831c1f7cb06ae3101465e448594f8c5aa4e44651733a7dc73cefaae0edf35a8cefa89e8a05689f1215490f5c2bb06dde28405e62f775ef29f2f7df9
-  data.tar.gz: 02a4e999969b868d738056068b52fd67466fa8ed0560c95ce3c1fb0cb6f348fc2469fae1e8be5157eefcf3e7c75475b918de300b3a47ad5b6df1f091571caafe
+  metadata.gz: 29626eaaaa8f34cc6c40ea9a7942ce361f134db9c96ddf7915c7505a0c8fa88ac513982a45f07e9f06d22c9fe8f65f9fab9af0b670de08a9f5dcc13c4d3a7e96
+  data.tar.gz: 527afcbc462f5b0acf2f77cdadc04a55726f9510308533f8f79101a97c18cbcd19a3fe92ccd946ee52c68f0e76cbcdac7c681792750a08b6c1e4977e46b8d7a4

data/README.md

@@ -2,11 +2,19 @@
 
 *Less data containing useful information is way better than lots of data containing a mess.*
 
-Don't you hate thousands of lines in a log blowing up with your troubleshooting? Lots of useless data that you have to filter just to turn that 300 MB of madness into a 30 KB of useful information. If you need something that can rip off useless entries so you can have a clue about what is going on with that application, you should give Sherlog Holmes a try.
+Don't you hate those thousands of lines in a log blowing up with your troubleshooting? Lots of useless data that you have to filter just to turn that 300 MB of madness into a 30 KB of useful information? If you need something that can rip off useless entries so you can have a clue about what is going on with that application, you should give Sherlog Holmes a try.
+
+If you are a log detective, then Sherlog Holmes is your best companion!
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Sherlog can be installed easily through the `gem` command:
+
+```sh
+$ gem install sherlog-holmes
+```
+
+This is the preferable way since Sherlog is basically a console line application. Of course you can add it to your application's Gemfile:
 
 ```ruby
 gem 'sherlog_holmes'
@@ -14,33 +22,28 @@ gem 'sherlog_holmes'
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sherlog-holmes
+```sh
+$ bundle
+```
 
-## Concepts
+## How it works
 
-Sherlog works by grabbing every line of a log and parsing it into a simple structure containing:
+Sherlog works by grabbing every line of an input and applying a Regular Expression to create an `entry`. This `entry` will be filtered based on a set of given rules and, if it is accepted, will be passed to a set of defined processors so they can do something useful (like printing the output so you can redirect it to a sane log file).
 
-- Time
-- Level
-- Category
-- Origin
-- Message
-- Exception
-- Stacktrace
+The attributes are based on the named capture groups:
 
-You need to supply a regular expression that maps those fields in order to match your log entry. Here is an example:
+- Time: `time`
+- Level: `level`
+- Category: `category`
+- Origin: `origin`
+- Message: `message`
 
 ```regexp
 (<?level>\w+)\s(<?category>\s+)\s(<?message>.+)
 ```
+*Any other capture group will be assigned to a set of custom attributes and can be used later.*
 
-Notice that you don't need to define every field, just the ones shown in your log.
-
-Patterns for exception and stacktrace should be defined separately. The exception pattern is used only in the message field. Here is a complete example of a pattern configuration:
+Patterns for exception and stacktrace should be defined separately. The exception pattern is used only in the message field and stacktraces. Here is a complete example of a pattern configuration:
 
 ```yaml
 jboss:
@@ -51,10 +54,6 @@ 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:
@@ -84,7 +83,7 @@ This sets the encode to use while reading the log file.
 
 `-t, --type TYPE`
 
-This will manually set the patterns definitions. If you don't specify this option, Sherlog will try the mapped ones with the first input line.
+This will manually set the patterns definitions. If you don't specify this option, Sherlog will try to guess the pattern by trying the mapped ones until it finds a match.
 
 ### Filter Options
 
@@ -144,7 +143,7 @@ This is equivalent to:
 
     (WARN || ! INFO) && EXCEPTION
 
-*NOTICE: try not to do fuzzy logics with this operators*
+*NOTICE: try not to do fuzzy logics with those operators*
 
 ### Operation Options
 
@@ -167,13 +166,15 @@ Set this and Sherlog will count the number of entries per level, category, origi
 - `levels`: counts the number of entries per level
 - `categories`: counts the number of entries per category
 - `origins`: counts the number of entries per origin
-- `exception`: counts the number of entries per exception
+- `exceptions`: counts the number of entries per exception
 - `all`: counts all groups
 
 ```
 $ sherlog --count levels,categories log-file.log
 ```
 
+*Don't forget to set an operation or `sherlog` will not show anything in your console!*
+
 ## Built-in Patterns
 
 Currently, Sherlog has the following patterns:
@@ -185,4 +186,3 @@ Currently, Sherlog has the following patterns:
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/bin/sherlog

@@ -22,7 +22,7 @@
 # THE SOFTWARE.
 
 require 'yummi'
-require 'optionparser'
+require 'optparse'
 
 require_relative '../lib/sherlog_holmes'
 

data/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.4.1
+
+- Use `optparse` instead of `optionparser`
+
 ## v0.4.0
 
 - Added support for multiple log files

data/lib/sherlog_holmes/version.rb

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

data/sherlog-holmes.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.0'
+
   spec.add_dependency 'yummi', '~> 0.9.5'
 
   spec.add_development_dependency 'bundler', '~> 1.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sherlog-holmes
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ataxexe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-29 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yummi
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="