logger_facade 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23cc1584b5cfa42c103b970633ce4ae8b0a53690
-  data.tar.gz: 2886973542c5e009e047e29c7c4d150e6a77d9b9
+  metadata.gz: 3dc0e14861809751be33ef99cd453eaea0419812
+  data.tar.gz: 83fbb29db67b52a84ee4f91f046a9d3a24d099ad
 SHA512:
-  metadata.gz: 5c9fd2d2e1e416cc28da978ba219c6ff3c4202c8f99a8acb6aa41df8a15d1b1c3e64d007eb78ed18ec2e2846baa3bd037e9ca60c71a8b5bd0d0f7281a54fe616
-  data.tar.gz: a18d4667ceb7cd90e2d9b323ab0c17c4f96299a1018a9f58b1c5ff883f52e9fe47f11fbf70cda146f9626830c54362eb78e445136e68decc53d57454c69f4020
+  metadata.gz: c5631cd425804a69ec3415a1354068007bad120f9ea1825200f0bf8fef2c662d5ec5916e899c59a485c874dacb03d819d87dfbb077d941267e1497f5fd66e603
+  data.tar.gz: 37aaf0c880273988833194e43803c8caa006f73ce5083f3dd3842ce0e8e9fd14ddc927ef92f8420f0a55bbfb79749287cbbfa495a1f0742f6e67b3ba2d1256f6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    logger_facade (0.3.1)
+    logger_facade (0.3.2)
       airbrake (~> 4.0)
       hashie (~> 3.2)
       sucker_punch (~> 1.1)

data/README.md

@@ -174,10 +174,8 @@ LoggerFacade::Manager.use(plugin)
 ### LoggerFacade::Plugins::Logstash
 
 ```ruby
-# this is default config for Console plugin
-config = { level: :debug }
-
-# configuration is optional in Logstash plugin
+# required paramaters config
+config = { level: :debug, filename: '/tmp/log.logstash' }
 plugin = LoggerFacade::Plugins::Logstash.new(config);
 LoggerFacade::Manager.use(plugin)
 
@@ -185,7 +183,8 @@ LoggerFacade::Manager.use(plugin)
 # by default logrotation is disabled and you should consider using a proper tool such logrotate.
 # but you can use some Logger (from stdlib) options.
 config = {
-  level: :debug
+  level: :debug,
+  filename: '/tmp/log.logstash',
   device: {
     shift_age: 'daily', # (optional) daily/weekly/monthly
     shift_size: 1024000 # (optional) bytes
@@ -194,6 +193,8 @@ config = {
 
 ```
 
+**NOTE:** When using with ruby daemons gem, use absolute path for file configuration.
+
 ## LoggerFacade::Plugins
 
 If you wanna use a custom plugin you just need to use an object that responds to the following contract:

data/lib/logger_facade/plugins/logstash.rb

@@ -8,8 +8,12 @@ module LoggerFacade::Plugins
       super("LoggerFacade::Plugins::Logstash", configuration)
 
       fail "Invalid configuration filename: #{config.filename}" unless config.filename
+    end
+
+    private
 
-      @logdevice = if config["device"]
+    def logdevice
+      @logdevice ||= if config["device"]
         shift_age = config.device["shift_age"]
         shift_size = config.device["shift_size"]
         LogDeviceWithRotation.new(config.filename, shift_age, shift_size)
@@ -18,10 +22,6 @@ module LoggerFacade::Plugins
       end
     end
 
-    private
-
-    attr_reader :logdevice
-
     def log(severity, message, logger, metadata)
       return unless is_level_active(severity)
       return unless logdevice
@@ -37,8 +37,8 @@ module LoggerFacade::Plugins
        '@timestamp' => ts.iso8601,
        '@fields'    => metadata
       }
-      
-      @logdevice.write("#{Yajl::Encoder.encode(json)}\n")
+
+      logdevice.write("#{Yajl::Encoder.encode(json)}\n")
     end
 
     class LogDeviceWithRotation < ::Logger::LogDevice

data/lib/logger_facade/version.rb

@@ -1,3 +1,3 @@
 module LoggerFacade
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/spec/integration/plugins/logstash_spec.rb

@@ -0,0 +1,29 @@
+describe LoggerFacade::Plugins::Logstash do
+
+  let(:filename) { "./spec/log.logstash" }
+  let(:time) { Time.new(1983, 01, 25, 13, 10, 01, '+00:00') }
+
+  before(:each) do
+    FileUtils.rm(filename) rescue nil
+    allow(Time).to receive(:now) { time }
+    LoggerFacade::Manager.clear_plugins
+    config = { level: :debug, filename: filename }
+    plugin = LoggerFacade::Plugins::Logstash.new(config)
+    LoggerFacade::Manager.use(plugin)
+  end
+
+  after(:each) do
+    FileUtils.rm(filename)
+  end
+
+  let(:log) do
+    LoggerFacade::Manager.get_logger 'SPEC_LOGGER'
+  end
+
+  it 'logs to file' do
+    log.debug("message info", { context: true })
+    logline = "{\"@timestamp\":\"1983-01-25T13:10:01Z\",\"@fields\":{\"context\":true,\"pid\":#{Process.pid},\"severity\":\"debug\",\"logger\":\"SPEC_LOGGER\",\"message\":\"message info\"}}\n"
+    expect(File.read(filename)).to eq(logline)
+  end
+
+end

data/spec/spec_helper.rb

@@ -16,14 +16,6 @@ require 'logger_facade'
 
 Dir['spec/support/**/*.rb'].each &method(:require)
 
-RSpec.configure do |c|
-  c.around(:each) do |example|
-    Timeout::timeout(2) {
-      example.run
-    }
-  end
-end
-
 module TimeTestHelper
   def with_mock_time(t = 0)
     mc = class <<Time; self; end

data/spec/unit/plugins/logstash_spec.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 describe LoggerFacade::Plugins::Logstash do
   include LevelTestHelper
 
@@ -21,7 +19,8 @@ describe LoggerFacade::Plugins::Logstash do
     it 'defaults to logdevice without rotation' do
       expect(LoggerFacade::Plugins::Logstash::LogDeviceWithoutRotation)
         .to receive(:new).with(filename)
-      described_class.new(config)
+      subject = described_class.new(config)
+      subject.debug("logger", "message")
     end
 
     it 'uses ruby Logger config' do
@@ -30,7 +29,8 @@ describe LoggerFacade::Plugins::Logstash do
       config[:device] = { shift_age: age, shift_size: size }
       expect(LoggerFacade::Plugins::Logstash::LogDeviceWithRotation)
         .to receive(:new).with(filename, age, size)
-      described_class.new(config)
+      subject = described_class.new(config)
+      subject.debug("logger", "message")
     end
 
     it 'raises an error on invalid filename configuration' do
@@ -76,7 +76,7 @@ describe LoggerFacade::Plugins::Logstash do
           it("writes a valid json") do
             expect(file).to receive(:write) do |msg|
               data = nil
-              expect { data = JSON.parse(msg) }.not_to raise_exception
+              expect { data = Yajl::Parser.new.parse(msg) }.not_to raise_exception
               expect(data).to be
             end
             subject.send(severity, logger, message)
@@ -96,7 +96,7 @@ describe LoggerFacade::Plugins::Logstash do
 
             it("writes logstash timestamp format") do
               expect(file).to receive(:write) do |msg|
-                data = JSON.parse(msg)
+                data = Yajl::Parser.new.parse(msg)
                 expect(data["@timestamp"]).to eq(time.iso8601)
               end
               subject.send(severity, logger, message)
@@ -104,7 +104,7 @@ describe LoggerFacade::Plugins::Logstash do
 
             it("uses metadata timestamp") do
               expect(file).to receive(:write) do |msg|
-                data = JSON.parse(msg)
+                data = Yajl::Parser.new.parse(msg)
                 expect(data["@timestamp"]).to eq(ts.iso8601)
               end
               subject.send(severity, logger, message, metadata: metadata)
@@ -112,7 +112,7 @@ describe LoggerFacade::Plugins::Logstash do
 
             it("doesn't write field timestamp") do
               expect(file).to receive(:write) do |msg|
-                data = JSON.parse(msg)["@fields"]
+                data = Yajl::Parser.new.parse(msg)["@fields"]
                 expect(data["timestamp"]).to be_nil
               end
               subject.send(severity, logger, message, metadata: metadata)
@@ -121,7 +121,7 @@ describe LoggerFacade::Plugins::Logstash do
 
           it("writes fields") do
             expect(file).to receive(:write) do |msg|
-              data = JSON.parse(msg)
+              data = Yajl::Parser.new.parse(msg)
               expect(data["@fields"]).to be
             end
             subject.send(severity, logger, message)
@@ -129,7 +129,7 @@ describe LoggerFacade::Plugins::Logstash do
 
           it("writes severity") do
             expect(file).to receive(:write) do |msg|
-              data = JSON.parse(msg)["@fields"]
+              data = Yajl::Parser.new.parse(msg)["@fields"]
               expect(data["severity"]).to eq(severity.to_s)
             end
             subject.send(severity, logger, message)
@@ -137,7 +137,7 @@ describe LoggerFacade::Plugins::Logstash do
 
           it("writes logger") do
             expect(file).to receive(:write) do |msg|
-              data = JSON.parse(msg)["@fields"]
+              data = Yajl::Parser.new.parse(msg)["@fields"]
               expect(data["logger"]).to eq(logger)
             end
             subject.send(severity, logger, message)
@@ -145,7 +145,7 @@ describe LoggerFacade::Plugins::Logstash do
 
           it("writes message") do
             expect(file).to receive(:write) do |msg|
-              data = JSON.parse(msg)["@fields"]
+              data = Yajl::Parser.new.parse(msg)["@fields"]
               expect(data["message"]).to eq(message)
             end
             subject.send(severity, logger, message)
@@ -154,7 +154,7 @@ describe LoggerFacade::Plugins::Logstash do
           it("writes other metadata fields") do
             metadata = { context: true }
             expect(file).to receive(:write) do |msg|
-              data = JSON.parse(msg)["@fields"]
+              data = Yajl::Parser.new.parse(msg)["@fields"]
               expect(data["context"]).to eq(true)
             end
             subject.send(severity, logger, message, metadata: metadata)
@@ -165,7 +165,7 @@ describe LoggerFacade::Plugins::Logstash do
             it('writes the exception message') do
               error = Exception.new('test log')
               expect(file).to receive(:write) do |msg|
-                data = JSON.parse(msg)["@fields"]
+                data = Yajl::Parser.new.parse(msg)["@fields"]
                 expect(data["message"]).to eq("test log")
               end
               subject.send(severity, logger, error)
@@ -175,7 +175,7 @@ describe LoggerFacade::Plugins::Logstash do
               error = Exception.new('test log')
               error.set_backtrace "stacktrace"
               expect(file).to receive(:write) do |msg|
-                data = JSON.parse(msg)["@fields"]
+                data = Yajl::Parser.new.parse(msg)["@fields"]
                 expect(data["backtrace"]).to eq(error.backtrace)
               end
               subject.send(severity, logger, error)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logger_facade
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Pedro Januário
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -208,6 +208,7 @@ files:
 - lib/logger_facade/plugins/logstash.rb
 - lib/logger_facade/version.rb
 - logger_facade.gemspec
+- spec/integration/plugins/logstash_spec.rb
 - spec/spec_helper.rb
 - spec/unit/log_spec.rb
 - spec/unit/loggable_spec.rb
@@ -243,6 +244,7 @@ signing_key:
 specification_version: 4
 summary: Logger Facade library
 test_files:
+- spec/integration/plugins/logstash_spec.rb
 - spec/spec_helper.rb
 - spec/unit/log_spec.rb
 - spec/unit/loggable_spec.rb