alephant-logger-json 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3968d465458c83d5311c94efbca73fc9d51573cf
-  data.tar.gz: a132988fc00b3aafc4e504be158512de6e903f5f
+  metadata.gz: 84eb3ae131800ea10978a1bef31ae0a51bde66c4
+  data.tar.gz: d7eda923aa0c8a7fb348840675f040185b6f295a
 SHA512:
-  metadata.gz: 22d2e4a1564a559732dd57b738944b969b3cc73c3341c0fd1c69dc364acfb0bd7e3b9eaff853b7049cba1aa6e136e98a53139eb8538265dd4c237d0b23c32cfd
-  data.tar.gz: f7485a3235e148c99eeefb6b5116886b6840bb9e9121e15dd2cb876b33428deaaa83fa61645fe34f8a9ce678e2df90340b8d2557a6509d287f32f5eae0c98bb1
+  metadata.gz: 1941155f17fc7b8d0795a98550ed9ce743eaea9c84799cd78c00d8588b747a3ed241247c070390469be85148c276df0e6936391e18d91343287287a6c6174eac
+  data.tar.gz: 16962fa4fc1344968f6ed9546d921e38effe01a6fb375bdbdfa17ed40ffd13c4a406fa4075d66c7cf4ddffbe965f2a9346537d79d583f3c919d066f66beb9637

data/README.md

@@ -30,6 +30,13 @@ 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:
+```
+Alephant::Logger::JSON.new("path/to/logfile.log", :nesting => true)
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/BBC-News/alephant-logger-json/fork )

data/lib/alephant/logger/json.rb

@@ -3,14 +3,26 @@ require "json"
 module Alephant
   module Logger
     class JSON
-      def initialize(log_path)
+      def initialize(log_path, options = {})
         @log_file = File.open(log_path, "a+")
         @log_file.sync = true
+        @nesting = options.fetch(:nesting, false)
       end
 
+      private
+
+      def flatten_values_to_s(hash)
+        Hash[hash.map { |k, v| [k, v.to_s] }]
+      end
+
+      public
+
       [:debug, :info, :warn, :error].each do |level|
         define_method(level) do |hash|
           hash["level"] = level.to_s
+
+          hash = flatten_values_to_s hash if not @nesting
+
           @log_file.write(::JSON.generate(hash) + "\n")
         end
       end

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

@@ -1,7 +1,7 @@
 module Alephant
   module Logger
     class JSON
-      VERSION = "0.0.2"
+      VERSION = "0.1.0"
     end
   end
 end

data/spec/alephant/logger/json_spec.rb

@@ -29,10 +29,52 @@ describe Alephant::Logger::JSON do
     end
   end
 
-  describe "log levels" do
-    %w[debug info warn error].each do |level|
-      it_behaves_like "JSON logging" do
-        let(:level) { level }
+  shared_context "nested log hash" do
+    let(:log_hash) do
+      { "nest" => nest }
+    end
+
+    let(:nest) { { "bird" => "eggs" } }
+  end
+
+  shared_examples "nests flattened to strings" do
+    include_context "nested log hash"
+
+    specify do
+      expect(log_file).to receive(:write) do |json_dump|
+        expect(JSON.parse(json_dump)["nest"]).to eq nest.to_s
+      end
+
+      subject.send(level, log_hash)
+    end
+  end
+
+  shared_examples "nesting allowed" do
+    include_context "nested log hash"
+
+    specify do
+      expect(log_file).to receive(:write) do |json_dump|
+        expect(JSON.parse json_dump).to eq log_hash
+      end
+
+      subject.send(level, log_hash)
+    end
+  end
+
+  %w[debug info warn error].each do |level|
+    describe "##{level}" do
+      let(:level) { level }
+
+      it_behaves_like "JSON logging"
+
+      it_behaves_like "nests flattened to strings"
+
+      context "with nesting allowed" do
+        subject do
+          described_class.new(log_path, :nesting => true)
+        end
+
+        it_behaves_like "nesting allowed"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-logger-json
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Dan Arnould
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement