alephant-logger-json 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 771869cbd5bcad995127e6ef602ec4ae3c1c6177
-  data.tar.gz: 4cd2f63c8aba00076408f9f42ecd33c6dc1a3b48
+  metadata.gz: fb999ad1fdc190e0cf59150933ec5f1e8e4403da
+  data.tar.gz: b48484a0c9c855c2e5f95d79caf8b0173085051b
 SHA512:
-  metadata.gz: bb3f8e8dfaf453a946aff808903601b49881d199740b248db192bf4837a05b8fc47be1e290983baf7a01b91e896f2135b75416ccfd08c5c1cf0182cdc44957f0
-  data.tar.gz: 4c5853cde0064536adb6c03c080acd884470e2b9885c81ec293efd6939453d5ba04fcc58236afa149f2c9f726f43485caadd96f6f286df2abe5dda8f833afba5
+  metadata.gz: 8ddda013e92f5508ec2fdd7ce30caee46ebd01a468a5f14eccecf43fcf69b4398413e26570c5f09a5469f02b4394f7063def31e9f6b32dfe8091ed26b3f12997
+  data.tar.gz: 808cd3d07ceca926a115624d4eab3653b76cda13510c7c632b795b2bd917bd469d2f53677a2a102a20f7e90a89b5a5dd7bce02aa54d648b9966070a50187e253

data/README.md

@@ -30,13 +30,39 @@ logger = Alephant::Logger.setup json_driver
 logger.info({ "some_field" => "some_value", "other_field" => "other_value" })
 ```
 
-By default, nested JSON values are flattened to strings.  To enable nesting,
-provided that your log analysis tooling supports that, create
-`Alephant::Logger::JSON` as follows:
+### Nesting
+
+By default, nested JSON values are flattened to strings.  To enable nesting, provided that your log analysis tooling supports that, create `Alephant::Logger::JSON` as follows:
+
 ```
 Alephant::Logger::JSON.new("path/to/logfile.log", :nesting => true)
 ```
 
+### Distributed Tracing
+
+The logger will set a key of `uuid` to `n/a` by default for each log request.
+
+This value can be changed by providing a lambda function that contains the logic to determine this value.
+
+There are two methods available to help you:
+
+- `Alephant::Logger::JSON.session?`: boolean response checking if `@@session` has been set
+- `Alephant::Logger::JSON.session`: accepts a lambda function (its return value is internally assigned to `@@session`)
+
+When using tracing, you'll need to provide a binding context as the first argument to your log level method calls.
+
+This is to resolve issues with lambda's scope availability. See `Kernal#binding` for more details. 
+
+Example usage:
+
+```
+logger.info(binding, :foo => :bar)
+```
+
+If no `binding` is provided then tracing is ignored and the logger falls back to its default value.
+
+> Note: you can hide the binding necessity behind an abstraction layer if you prefer
+
 ## Contributing
 
 1. Fork it ( https://github.com/BBC-News/alephant-logger-json/fork )

data/lib/alephant/logger/dynamic_binding.rb

@@ -0,0 +1,34 @@
+module DynamicBinding
+  class LookupStack
+    def initialize(bindings = [])
+      @bindings = bindings
+    end
+
+    def method_missing(m, *args)
+      @bindings.reverse_each do |bind|
+        begin
+          method = eval("method(%s)" % m.inspect, bind)
+        rescue NameError
+        else
+          return method.call(*args)
+        end
+        begin
+          value = eval(m.to_s, bind)
+          return value
+        rescue NameError
+        end
+      end
+      raise NoMethodError, "No such variable or method: %s" % m
+    end
+
+    def run_proc(p, *args)
+      instance_exec(*args, &p)
+    end
+  end
+end
+
+class Proc
+  def call_with_binding(bind, *args)
+    DynamicBinding::LookupStack.new([bind]).run_proc(self, *args)
+  end
+end

data/lib/alephant/logger/json/version.rb

@@ -1,7 +1,7 @@
 module Alephant
   module Logger
     class JSON
-      VERSION = "0.3.0"
+      VERSION = "0.3.1"
     end
   end
 end

data/lib/alephant/logger/json.rb

@@ -1,3 +1,4 @@
+require_relative "./dynamic_binding.rb"
 require "json"
 
 module Alephant
@@ -10,12 +11,12 @@ module Alephant
       end
 
       [:debug, :info, :warn, :error].each do |level|
-        define_method(level) do |hash|
+        define_method(level) do |b=nil, hash|
           return if hash.is_a? String
           @@session = -> { "n/a" } unless defined? @@session
           h = {
             :timestamp => Time.now.to_s,
-            :uuid      => @@session.(),
+            :uuid      => b.nil? ? "n/a" : @@session.call_with_binding(b),
             :level     => level.to_s
           }.merge hash
           hash = flatten_values_to_s h unless @nesting

data/spec/alephant/logger/json_spec.rb

@@ -66,7 +66,7 @@ describe Alephant::Logger::JSON do
       end
 
       ::Alephant::Logger::JSON.session fn
-      subject.send(level, log_hash)
+      subject.send(level, binding, log_hash)
       ::Alephant::Logger::JSON.session -> { "n/a" }
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alephant-logger-json
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dan Arnould
@@ -108,6 +108,7 @@ files:
 - README.md
 - Rakefile
 - alephant-logger-json.gemspec
+- lib/alephant/logger/dynamic_binding.rb
 - lib/alephant/logger/json.rb
 - lib/alephant/logger/json/version.rb
 - spec/alephant/logger/json_spec.rb