README.md in semantic_logger-0.6.2 vs README.md in semantic_logger-0.7.0
- old
+ new
@@ -1,10 +1,13 @@
-semantic-logger-ruby
-====================
+semantic_logger
+===============
-* http://github.com/ClarityServices/semantic-logger-ruby
+Ruby and Rails Logger enhanced with semantic capabilities, high performance, standardized
+logging with multiple appenders
+* http://github.com/ClarityServices/semantic_logger
+
### Introduction
SemanticLogger is a Logger that supports logging of meta-data, along with text messages
Machines can understand the logged data without having to use
@@ -120,12 +123,38 @@
The following output will be written to file:
2012-08-30 15:37:29.474 I [48308:ScriptThreadProcess: script/rails] Rails -- Calling external interface (5.2ms)
If an exception is raised during the block the exception is logged
-at the same log level as the benchmark along with the duration and message
+at the same log level as the benchmark along with the duration and message.
+The exception will flow through to the caller unchanged
+```
+Parameters to benchmark_info, benchmark_debug, etc..
+
+message
+ The message for this log entry
+
+params:
+ :log_exception
+ Control whether or how an exception thrown in the block is
+ reported by SemanticLogger. Values:
+ :full
+ Log the exception class, message, and backtrace
+ :partial
+ Log the exception class and messag
+ The backtrace will not be logged
+ :off
+ Any unhandled exception from the block will not be logged
+
+ :min_duration
+ Only log if the block takes longer than this duration in ms
+
+ :payload
+ To log a custom payload along with this log entry
+```
+
#### Logging levels
The following logging levels are available through Semantic Logger
:trace, :debug, :info, :warn, :error, :fatal
@@ -382,11 +411,11 @@
- Optional: Rails 3.0.10 (or above)
- Optional: To log to MongoDB, Mongo Ruby Driver 1.5.2 or above
### Install
- gem install semantic-logger
+ gem install semantic_logger
To log to MongoDB
gem install mongo
@@ -399,34 +428,33 @@
Want to contribute to Semantic Logger?
First clone the repo and run the tests:
- git clone git://github.com/ClarityServices/semantic-logger.git
- cd semantic-logger
- jruby -S rake test
+ git clone git://github.com/ClarityServices/semantic_logger.git
+ cd semantic_logger
+ ruby -S rake test
Feel free to ping the mailing list with any issues and we'll try to resolve it.
Contributing
------------
Once you've made your great commits:
-1. [Fork](http://help.github.com/forking/) semantic-logger
+1. [Fork](http://help.github.com/forking/) semantic_logger
2. Create a topic branch - `git checkout -b my_branch`
3. Push to your branch - `git push origin my_branch`
-4. Create an [Issue](http://github.com/ClarityServices/semantic-logger/issues) with a link to your branch
+4. Create an [Issue](http://github.com/ClarityServices/semantic_logger/issues) with a link to your branch
5. That's it!
Meta
----
-* Code: `git clone git://github.com/ClarityServices/semantic-logger.git`
-* Home: <https://github.com/ClarityServices/semantic-logger>
-* Docs: TODO <http://ClarityServices.github.com/semantic-logger/>
-* Bugs: <http://github.com/reidmorrison/semantic-logger/issues>
-* Gems: <http://rubygems.org/gems/semantic-logger>
+* Code: `git clone git://github.com/ClarityServices/semantic_logger.git`
+* Home: <https://github.com/ClarityServices/semantic_logger>
+* Bugs: <http://github.com/reidmorrison/semantic_logger/issues>
+* Gems: <http://rubygems.org/gems/semantic_logger>
This project uses [Semantic Versioning](http://semver.org/).
Authors
-------