zlogger 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f2504eea7c5c26ea43263ea56fb570e091779f1
-  data.tar.gz: e75a239379af084d808f81d763ae36a54d91f98b
+  metadata.gz: 97a0841375be659fda8cacff26a52da879e2442b
+  data.tar.gz: 0e61dabb0acc35e546b21bb88b0a4c990dd0c828
 SHA512:
-  metadata.gz: 2ddb23f2c093c9fd1f41f8451b3af68e3433495ba2fc6ed45da12aa36aa0e45d9513464abca13b6ef9102adcef5a28860c24483f5daf7797babac908278dc673
-  data.tar.gz: 1711db539434394f50a9ab89e2ab616f8f58646c3ae3b81f0075dd35c05a7a6946362ad66de0c9635a5c8976ee25d78421e0811f14dab20356961fc7ce06abca
+  metadata.gz: 5e68f79ee55c331ba1acb1c31c60f25cab764e13d7a00b0dd3679b01b8b8cb3411ac42ad04b2f47c6760bc3e8cfa17aa584518bca52061060f0f687c56ad3242
+  data.tar.gz: a592dc5af961c77a30da6d1015a98362f3896f6542e5ea67ae3930cb70a742b55504b224a814e64d7f84c1b466334ede6414d61e6575517c4410b1a99ba24547

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -39,7 +39,23 @@ To use the logging client in a Ruby process:
 
 The `logger` client object behaves like a standard ruby Logger.
 
-
+## Using zlogger client in a Rails application with Phusion Passenger
+
+Phusion passenger uses a forking model. ZeroMQ contexts do not survive a process fork, so it is important to start
+the zlogger client after passenger does the process fork. Using the following code snippet in 
+config/environments/production.rb will allow zlogger to be used as the rails logger correctly:
+
+    # production log to Zlogger
+    if defined?(PhusionPassenger)
+      # inside passenger, only create the zlogger after the app starts (and has been forked)
+      PhusionPassenger.on_event(:starting_worker_process) do |forked|
+        Rails.logger = Zlogger::Client.new({address: ENV['ZLOGGER_ADDRESS'], port: ENV['ZLOGGER_PORT']})
+      end
+    else
+      # rake tasks, irb, etc. Anything not in passenger: use a zlogger immediately.
+      Rails.logger = Zlogger::Client.new({address: ENV['ZLOGGER_ADDRESS'], port: ENV['ZLOGGER_PORT']})
+    end
+  
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/zlogger/fork )

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => [:spec]
+
+desc "Run the specs."
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
 

data/lib/zlogger/client.rb

@@ -17,7 +17,7 @@ module Zlogger
       super(nil)
       @logdev = LogDevice.new(self)
       @logdev.run_socket_thread
-      
+
       @formatter = proc do |severity, time, progname, msg|
         if msg.is_a?(Exception)
           "#{severity}: #{msg.message} (#{msg.class})\n" + (msg.backtrace || []).join("\n")
@@ -47,6 +47,14 @@ module Zlogger
       options[:name] || "#{File.basename($0)}:#{Process.pid}"
     end
 
+    def log_device
+      @logdev
+    end
+
+    def close
+      @logdev.close
+    end
+
     class LogDevice
       attr :client
 
@@ -64,22 +72,24 @@ module Zlogger
 
       # it is not threadsafe to access ZMQ sockets, so we only write to the logging socket from a single thread.
       def run_socket_thread
-        @thread ||= Thread.new do
-          begin
-            socket = client.context.socket :PUB
-            socket.connect("tcp://#{client.connect_address}:#{client.port}")
-            loop do
-              object = client.queue.pop
-              break if object == self
-              message = ZMQ::Message.new
-              message.addstr(client.name)
-              message.addstr(object.to_s)
-              socket.send_message(message)
-            end
-            socket.close
-          rescue StandardError => e
-            puts "Logging socket thread error: #{e}"
+        @thread ||= Thread.new { run_socket_loop }
+      end
+
+      def run_socket_loop
+        begin
+          socket = client.context.socket :PUB
+          socket.connect("tcp://#{client.connect_address}:#{client.port}")
+          loop do
+            object = client.queue.pop
+            break if object == self
+            message = ZMQ::Message.new
+            message.addstr(client.name)
+            message.addstr(object.to_s)
+            socket.send_message(message)
           end
+          socket.close
+        rescue StandardError => e
+          puts "Logging socket thread error: #{e}"
         end
       end
     end

data/lib/zlogger/daemon.rb

@@ -82,14 +82,15 @@ module Zlogger
     end
 
     def rotate_file
-      if log_date < Date.today
-        log_date = Date.today
+      if self.log_date < Date.today
+
+        self.log_date = Date.today
 
         # closes previous day file
-        @output_file.close if @output_file # just a fail safe in case that for some reason the output file is nil
+        self.output_file.close if output_file # just a fail safe in case that for some reason the output file is nil
 
         # assigns file for the new day to output_file attribute
-        @output_file = File.new(output_filepath, 'a+')
+        self.output_file = File.new(output_filepath, 'a+')
       end
     end
 

data/lib/zlogger/version.rb

@@ -1,3 +1,3 @@
 module Zlogger
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/lib/zlogger/client_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'timeout'
+
+describe Zlogger::Client do
+
+  context "Stubbed ZMQ" do
+    let(:socket) { double("zmq socket") }
+    let(:zmq_context) { double("zmq context", :socket => socket) }
+    before do
+      ZMQ.stub(:context => zmq_context)
+      Zlogger::Client::LogDevice.any_instance.stub(:run_socket_thread => nil)
+    end
+    it "logs a message" do
+      subject.info "Hello"
+      subject.close
+      expect(socket).to receive(:connect).with("tcp://127.0.0.1:7000")
+      expect(socket).to receive(:send_message) { |message|
+        expect(message.size).to eq(2)
+        expect(message.popstr).to match(/rspec/)
+        expect(message.popstr).to eq("INFO: Hello")
+      }
+      expect(socket).to receive(:close)
+      Timeout.timeout(2) do
+        subject.log_device.run_socket_loop
+      end
+    end
+    after do
+      subject.close if subject
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'zlogger'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["spec/support/**/*.rb"].each { |file| load file }
+
+require 'timecop'
+
+RSpec.configure do |config|
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  #config.order = "random"
+end

data/zlogger.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "rbczmq", "~> 1.7"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "timecop", "~> 0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zlogger
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Connolly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbczmq
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: 'This gem provides a daemon that reads log messages from a ZeroMQ socket.
   Messages are formatted and output to STDOUT. '
 email:
@@ -63,6 +91,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,6 +103,8 @@ files:
 - lib/zlogger/daemon.rb
 - lib/zlogger/reader.rb
 - lib/zlogger/version.rb
+- spec/lib/zlogger/client_spec.rb
+- spec/spec_helper.rb
 - zlogger.gemspec
 homepage: ''
 licenses:
@@ -99,4 +130,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A distributed logging daemon.
-test_files: []
+test_files:
+- spec/lib/zlogger/client_spec.rb
+- spec/spec_helper.rb