zlogger 0.0.2

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.idea
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zlogger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Connolly
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Zlogger - A distributed logging daemon.
+
+This gem provides a daemon that reads log messages from a ZeroMQ socket. Messages are formatted and output to STDOUT.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zlogger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zlogger
+
+## Usage
+
+To run the logging daemon:
+
+    $ zlogger
+
+And you when messages are sent to the logger, they will appear in STDOUT formatted with the senders name prefixed to
+each line.
+
+The daemon uses two ZeroMQ sockets:
+
+ * At the bind_address : port => a PULL socket to receive log messages.
+ * At the bind_address : port + 1 => a PUB socket where re-formatted lines of the log are sent to.
+
+To use the logging client in a Ruby process:
+
+    require 'zlogger'
+
+    logger = Zlogger::Client.new
+    logger.debug "log this debug message"
+
+The `logger` client object behaves like a standard ruby Logger.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zlogger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/zloggerd

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'zlogger'
+require 'optparse'
+
+# Process options
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]"
+
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-b", "--bind ADDRESS",
+          "TCP address to bind to, defaults to 0.0.0.0") do |ext|
+    options[:bind_address] = ext
+  end
+
+  opts.on("-p", "--port PORT", Integer, "Port number to bind to") do |n|
+    options[:port] = n
+  end
+
+  opts.on("-f", '--file FILE', String, "File to write the log to. File is stored under /log folder") do |file|
+    options[:output] = file
+  end
+
+  opts.on("-r", '--rotate', String, "Rotate log file daily") do |file|
+    options[:rotate] = true
+  end
+
+  opts.on("-s", "--stdout", "Echo output to STDOUT (only applicable when -f is used)") do
+    options[:stdout] = true
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts "Zlogger version #{Zlogger::VERSION}"
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+# Create Zlogger
+
+logger = Zlogger::Daemon.new(options)
+logger.run

data/bin/zlogtail

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'zlogger'
+require 'optparse'
+
+# Process options
+options = { :address => '127.0.0.1' }
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options]\n\n" +
+      "Tail a Zlogger daemon by subscribing to its broadcast of formatted messages"
+
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-c", "--connect ADDRESS",
+          "TCP address to connect to, defaults to 127.0.0.1") do |ext|
+    options[:address] = ext
+  end
+
+  opts.on("-p", "--port PORT", Integer, "Port number to bind to") do |n|
+    options[:port] = n
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts "Zlogger version #{Zlogger::VERSION}"
+    exit
+  end
+end
+
+opts.parse!(ARGV)
+
+# Create Zlogger Reader
+
+logger = Zlogger::Reader.new(options)
+logger.run

data/lib/zlogger.rb

@@ -0,0 +1,9 @@
+require "zlogger/version"
+
+module Zlogger
+  autoload :Client, "zlogger/client"
+  autoload :Daemon, "zlogger/daemon"
+  autoload :Reader, "zlogger/reader"
+
+  DEFAULT_PORT = 7000
+end

data/lib/zlogger/client.rb

@@ -0,0 +1,87 @@
+require 'logger'
+require 'rbczmq'
+
+module Zlogger
+  class Client < ::Logger
+    attr :options
+
+    # Create a new logger object. This is the client logging object that sends log messages to the remote log
+    # collection daemon. The options hash accepts the following options:
+    #
+    # :context => An existing ZMQ::Context object. Defaults to creating a new one.
+    # :address => The TCP address to connect to.
+    # :port    => The TCP port to connect to.
+    # :name    => The name to use as a prefix for log messages, defaults to the process name and pid, eg "rails:1234"
+    def initialize(options={})
+      @options = options
+      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")
+        else
+          "#{severity}: #{msg}"
+        end
+      end
+    end
+
+    def context
+      @context ||= (ZMQ.context || ZMQ::Context.new)
+    end
+
+    def queue
+      @queue ||= Queue.new
+    end
+
+    def connect_address
+      options[:address] || "127.0.0.1"
+    end
+
+    def port
+      options[:port] || Zlogger::DEFAULT_PORT
+    end
+
+    def name
+      options[:name] || "#{File.basename($0)}:#{Process.pid}"
+    end
+
+    class LogDevice
+      attr :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def write(message)
+        client.queue << message
+      end
+
+      def close()
+        client.queue << self
+      end
+
+      # 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}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zlogger/daemon.rb

@@ -0,0 +1,123 @@
+require 'rbczmq'
+require 'date'
+require 'pathname'
+
+module Zlogger
+  class Daemon
+
+    FLUSH_TIMER = 0.1 # flush the log to disk after this many seconds.
+
+    attr :options
+    attr_accessor :output_file
+    attr_accessor :log_date
+
+    def initialize(options={})
+      @options = options
+      if options[:output]
+        @log_date = Date.today
+        @output_file = File.new(output_filepath, 'a+')
+      end
+    end
+
+    def run
+      socket = context.socket :SUB
+      socket.subscribe ""
+      socket.bind("tcp://#{bind_address}:#{port}")
+
+      poll_item = ZMQ::Pollitem(socket, ZMQ::POLLIN)
+      poller = ZMQ::Poller.new
+      poller.register(poll_item)
+
+      loop do
+        begin
+          rotate_file if options[:rotate]
+
+          poller.poll(FLUSH_TIMER)
+          if poller.readables.include?(socket)
+            message = socket.recv_message
+            prefix = message.pop.to_s
+            buffer = message.pop.to_s
+            buffer.gsub("\r\n", "\n")
+            buffer.split("\n").each do |line|
+              log(prefix, line)
+            end
+          end
+
+          flush
+
+        rescue Interrupt
+          break
+        rescue StandardError => e
+          log("ZLOGGER::DAEMON", e.to_s)
+        end
+      end
+    end
+
+    def context
+      @context ||= (ZMQ.context || ZMQ::Context.new)
+    end
+
+    def port
+      options[:port] ||= DEFAULT_PORT
+    end
+
+    def bind_address
+      options[:bind_address] ||= "0.0.0.0"
+    end
+
+    def output
+      output_file || $stdout
+    end
+
+    def output_filepath
+      filename = options[:output]
+      file_extension = File.extname(filename)
+      filename = filename.gsub(file_extension, "") unless file_extension == ""
+      if options[:rotate]
+        filename = "#{ filename }_#{ log_date.to_s }.log"
+      else
+        filename = "#{ filename }.log"
+      end
+      Pathname.new(filename).to_s
+    end
+
+    def rotate_file
+      if log_date < Date.today
+        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
+
+        # assigns file for the new day to output_file attribute
+        @output_file = File.new(output_filepath, 'a+')
+      end
+    end
+
+    def pub_socket
+      @pub_socket ||= begin
+        socket = context.socket :PUB
+        socket.bind("tcp://#{bind_address}:#{port.to_i + 1}")
+        socket
+      end
+    end
+
+    def log(prefix, line)
+      formatted = "#{Time.now.strftime("%Y%m%d %I:%M:%S.%L")}\t#{prefix}:\t#{line}"
+      output.puts(formatted)
+      $stdout.puts(formatted) if options[:stdout] && options[:output]
+      pub_socket.send(formatted)
+    end
+
+    # flush the output file only if enough elapsed time has occurred since the last flush. We want the log capture to
+    # be responsive, and reduce the amount of time waiting for synchronous disk i/o.
+    def flush
+      if output
+        now = Time.now
+        if @last_flush.nil? || (now - @last_flush > FLUSH_TIMER)
+          output.flush
+          @last_flush = now
+        end
+      end
+    end
+  end
+end

data/lib/zlogger/reader.rb

@@ -0,0 +1,43 @@
+require 'rbczmq'
+
+module Zlogger
+  class Reader
+    attr :options
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def sub_socket
+      @sub_socket ||=
+          begin
+            socket = context.socket :SUB
+            socket.subscribe ""
+            socket.connect("tcp://#{address}:#{port}")
+            socket
+          end
+    end
+
+    def context
+      @context ||= (ZMQ.context || ZMQ::Context.new)
+    end
+
+    def port
+      options[:port] ||= DEFAULT_PORT + 1
+    end
+
+    def address
+      options[:address] ||= "0.0.0.0"
+    end
+
+    def run
+      begin
+        loop do
+          puts sub_socket.recv
+        end
+      rescue Interrupt
+        # exit nicely
+      end
+    end
+  end
+end

data/lib/zlogger/version.rb

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

data/zlogger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zlogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zlogger"
+  spec.version       = Zlogger::VERSION
+  spec.authors       = ["Matt Connolly"]
+  spec.email         = ["matt.connolly@me.com"]
+  spec.summary       = %q{A distributed logging daemon.}
+  spec.description   = %q{This gem provides a daemon that reads log messages from a ZeroMQ socket. Messages are formatted and output to STDOUT. }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rbczmq", "~> 1.7"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: zlogger
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt Connolly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbczmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This gem provides a daemon that reads log messages from a ZeroMQ socket.
+  Messages are formatted and output to STDOUT. '
+email:
+- matt.connolly@me.com
+executables:
+- zloggerd
+- zlogtail
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/zloggerd
+- bin/zlogtail
+- lib/zlogger.rb
+- lib/zlogger/client.rb
+- lib/zlogger/daemon.rb
+- lib/zlogger/reader.rb
+- lib/zlogger/version.rb
+- zlogger.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A distributed logging daemon.
+test_files: []