datalogger 0.0.4 → 0.0.5

data/Readme.md

@@ -1,7 +1,10 @@
-# DataLogger (alpha)
-A simple structured data logger.  Pass it a hash, and it takes care of storing it to the data sink of your choice (currently stdout, though plugins are on the way).
+# DataLogger (alpha - API should be considered unstable)
+A simple structured data logger.  Pass it a hash, and it takes care of emitting to stdout.
+
+Inspiration largely comes from ["The Twelve-Factor App"](http://www.12factor.net/logs) by Adam Wiggins, Mark McGranaghan's ["Logs as Data"](https://github.com/relevance/clojure-conj/blob/master/2011-slides/mark-mcgranaghan-logs-as-data.pdf) talk, and various experiments at [Heroku](http://heroku.com).
 
 ## Usage
+### The most obvious way:
 ```ruby
 require 'datalogger'
 
@@ -32,3 +35,48 @@ This will generate a message that looks something like so:
 myapp action=create_user at=start
 myapp action=create_user at=finish elapsed=0.003116
 ```
+
+###As a singleton:
+
+```ruby
+require 'datalogger'
+
+DataLogger::Logger.component = 'myapp'
+DataLogger::Logger.log a: 1, b: 2, c: 3
+```
+
+### Mixing in instance methods
+
+```ruby
+require 'datalogger'
+
+DataLogger::Logger.component = 'myapp'
+
+class MyThing
+  include DataLogger
+  
+  def do_something
+    log(action: 'do_something') do
+	  # code goes here
+	end  
+  end
+end
+```
+
+### Mixing in class methods
+```ruby
+require 'datalogger'
+
+DataLogger::Logger.component = 'myapp'
+
+class MyThing
+  extend DataLogger
+  
+  def self.do_something
+    log(action: 'do_something') do
+	  # code goes here
+	end  
+  end
+end
+```
+

data/lib/datalogger.rb

@@ -3,11 +3,7 @@ require "datalogger/logger"
 require "datalogger/sinks/stdout"
 
 module DataLogger
-  def datalogger
-    Logger.global_logger
-  end
-  
   def log(data, &blk)
-    datalogger.log(data, &blk)          
+    Logger.global_logger.log(data, &blk)          
   end
-end
+end

data/lib/datalogger/version.rb

@@ -1,3 +1,3 @@
 module DataLogger
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datalogger
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors: