log2sock 0.0.5

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Alex Williams, Unscramble <license@unscramble.jp>
+
+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,48 @@
+# log2sock
+
+log2sock allows you to send logs to a UNIX domain socket. Its usage is similar to the Ruby 'logger' class, except with slightly less features.
+
+## Reading logs on a socket
+
+A small tool is included in this gem to help you read log messages on a UNIX domain socket.
+
+It's called `log2read`. It takes 1 argument which is the path/filename of the socket you want to create and listen on.
+
+Example:
+
+```
+# Let's assume you're using RBENV
+~/.rbenv/shims/log2read /tmp/mylogs.sock
+```
+
+## Writing logs to a socket
+
+Add this to your app and start logging stuff to a UNIX domain socket.
+
+Example:
+
+```
+require 'log2sock'
+
+logger = Log2sock.new("/tmp/mylogs.sock")
+logger.level(Log2sock::INFO)
+logger.debug("This is a debug message")                   # This won't be displayed
+logger.info("This is an info message")                    # This will be displayed
+logger.debug { "This is something really stupid #{5/0}" } # This won't be evaluated
+logger.level(Log2sock::DEBUG)
+logger.debug { "This is something really stupid #{5/0}" } # lulz
+```
+
+## Notes
+
+* If the socket can't be used (ex: if it doesn't exist), the logs will be sent to STDOUT.
+* The default socket is: `/tmp/log2.sock` which also exists in the CONSTANT `Log2sock::DEFAULT_SOCKET`
+* There are 6 log levels: `DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN`
+* Each log level is a constant (ex: `Log2sock::INFO`)
+* The default log level is: `Log2sock::DEBUG`
+* The `log2read` tool creates a socket with file permissions 750
+* Press Ctrl+C to exit the log2read tool
+
+## Requirements
+
+* Ruby 1.9.x or greater

data/bin/log2read

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'log2sock'
+
+socketfile = !ARGV.empty? ? ARGV[0] : Log2sock::DEFAULT_SOCKET
+
+begin
+  if File.exist?(socketfile)
+    puts "UNIX domain socket already exists, removing it first: #{socketfile}"
+    File.unlink(socketfile)
+  end
+  server = UNIXServer.new(socketfile)
+
+  %x[chmod 750 #{socketfile}]
+  puts "UNIX domain socket created at: #{socketfile}"
+  puts "========"
+  puts "Press Ctrl+C to terminate the reader"
+  puts "========"
+
+  loop {
+    Thread.start(server.accept) do |client|
+      while line = client.gets
+        puts line
+      end
+      client.close
+    end
+  }
+rescue Interrupt => e
+  puts "Terminating the reader and removing the socket"
+  File.unlink(socketfile)
+  exit
+end

data/lib/log2sock.rb

@@ -0,0 +1,199 @@
+class Log2sock
+  require 'socket'
+  require 'date'
+
+  DEFAULT_SOCKET = "/tmp/log2.sock"
+
+  # Log levels
+  DEBUG   = 'debug'
+  INFO    = 'info'
+  WARN    = 'warn'
+  ERROR   = 'error'
+  FATAL   = 'fatal'
+  UNKNOWN = 'unknown'
+
+  # Public: initializer
+  #
+  # log2sockfile  - The String filename of the UNIX domain socket
+  #                 (default: Log2sock::DEFAULT_SOCKET)
+  #
+  # This method performs the following tasks:
+  # * set the default log severity level
+  # * obtain the process ID number
+  # * set the socket file name
+  # * try to open the socket for writing
+  # * revert to STDOUT if the socket can't be opened
+  #
+  # Examples:
+  #
+  #   logger = Log2sock.new("/tmp/mylogs.sock")
+  #
+  #   logger = Log2sock.new
+  #
+  # Returns nothing useful
+  #
+  def initialize(log2sockfile = DEFAULT_SOCKET)
+    @loglevel = DEBUG
+    @pid = Process.pid
+
+    begin
+      @socketfile = log2sockfile
+      @socket = UNIXSocket.open(@socketfile)
+    rescue Exception => e
+      set_socket_stdout(e)
+    end
+  end
+
+  # Public: send a message to the socket or STDOUT
+  #
+  # msg       - The optional String unescaped message you want to log (default: nil)
+  # severity  - The String or CONSTANT log level severity of the message
+  # &block    - The String reference block which doesn't necessarily get evaluated
+  #
+  # This method performs the following tasks:
+  # * create a timestamp similar to this: 2013-02-07T03:58:09.902243
+  # * create a prefix for each log message with the severity, timestamp and process id
+  # * verifies if a block exists before setting the output message
+  # * tries to output the message to the socket or STDOUT
+  #
+  # Examples:
+  #
+  #   logger.message("This is a debug message", Log2sock::DEBUG)
+  #
+  #   logger.message(Log2sock::INFO) { "This is a debug message" }
+  #
+  # Returns nothing useful
+  #
+  def message(msg = nil, severity, &block)
+    d = DateTime.now
+    timestamp = d.strftime("%Y-%m-%dT%H:%M:%S.%6N")
+    # we use rjust(7) because the longest 'severity' is "unknown" which is 7 chars long
+    prefix = "#{severity[0].upcase}, [#{timestamp} \##{@pid}] #{severity.upcase.rjust(7)} -- :"
+
+    if block_given?
+      message = yield
+    else
+      message = msg
+    end
+
+    begin
+      @socket.puts "#{prefix} #{message}"
+    rescue Exception => e
+      # If the socket generates and exception, set the output
+      # to STDOUT for future calls to message()
+      set_socket_stdout(e)
+      @socket.puts "#{prefix} #{message}"
+    end
+  end
+
+  # Public: set the log severity level
+  #
+  # level - The String or CONSTANT log level severity (default: nil)
+  #
+  # Notes:
+  # * if the log level is not sent as a parameter, it simply returns the current log level
+  # * if the log level is sent as a parameter, the new log level is set
+  #
+  # Examples:
+  #
+  #   puts logger.level
+  #
+  #   logger.level(Log2sock::INFO)
+  #
+  # Returns The String of the current log severity level
+  #
+  def level(level = nil)
+    @loglevel = level unless level == nil
+    return @loglevel
+  end
+
+  # Public: generate a <SEVERITY> log message
+  #
+  # msg     - The String unescaped message you want to log (default: nil)
+  # &block  - The String reference block which doesn't necessarily get evaluated
+  #
+  # Notes:
+  # * calls the message() method only if the log severity level is is equal or higher priority
+  # * if a block is given, it will only be evaluated if the conditions are met
+  # * same functionality for all 6 log severity levels
+  #
+  # Examples:
+  #
+  #   logger.warn("This is a warn message")
+  #
+  #   logger.info { "This is an info message" }
+  #
+  #   logger.level(Log2sock::INFO)
+  #   logger.debug { "This is an unevaluated debug message #{5/0}" } # <-- only evaluated if severity is DEBUG
+  #
+  # Returns true if the message() is called, false if it isn't
+  #
+  def debug(msg = nil, &block)
+    if [DEBUG].include? @loglevel
+      message(msg, DEBUG, &block)
+      return true
+    end
+    return false
+  end
+
+  def info(msg = nil, &block)
+    if [DEBUG, INFO].include? @loglevel
+      message(msg, INFO, &block)
+      return true
+    end
+    return false
+  end
+
+  def warn(msg = nil, &block)
+    if [DEBUG, INFO, WARN].include? @loglevel
+      message(msg, WARN, &block)
+      return true
+    end
+    return false
+  end
+
+  def error(msg = nil, &block)
+    if [DEBUG, INFO, WARN, ERROR].include? @loglevel
+      message(msg, ERROR, &block)
+      return true
+    end
+    return false
+  end
+
+  def fatal(msg = nil, &block)
+    if [DEBUG, INFO, WARN, ERROR, FATAL].include? @loglevel
+      message(msg, FATAL, &block)
+      return true
+    end
+    return false
+  end
+
+  def unknown(msg = nil, &block)
+    if [DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN].include? @loglevel
+      message(msg, UNKNOWN, &block)
+      return true
+    end
+    return false
+  end
+
+  private
+
+  # Private: set the socket log output to STDOUT
+  #
+  # error - The String error message explaining why we're logging to STDOUT instead of a UNIX domain socket
+  #
+  # Notes:
+  # * if this is called, we set the output using the global $stdout variable
+  # * prints the error message to STDOUT, obviously
+  #
+  # Example:
+  #
+  #   set_socket_stdout("Exception error message")
+  #
+  # Returns nothing useful
+  #
+  def set_socket_stdout(error)
+    @socket = $stdout
+    @socket.puts "Error opening socket, logging to STDOUT: #{error}"
+  end
+end

data/log2sock.gemspec

@@ -0,0 +1,27 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+require "base64"
+
+Gem::Specification.new do |s|
+  s.name        = 'log2sock'
+  s.version     = '0.0.5'
+
+  s.date        = Date.today.to_s
+
+  s.summary     = "log2sock allows you to send logs to a UNIX domain socket"
+  s.description = "#{s.summary}. Its usage is similar to the Ruby 'logger' class, except with slightly less features."
+
+  s.author      = 'Alex Williams'
+  s.email       = Base64.decode64("YXdpbGxpYW1zQGFsZXh3aWxsaWFtcy5jYQ==\n")
+
+  s.homepage    = 'http://unscramble.co.jp'
+
+  s.require_paths = ["lib"]
+  s.bindir      = 'bin'
+  s.executables = %w[log2read]
+  s.files       = `git ls-files`.split("\n")
+
+  license = 'MIT'
+  s.required_ruby_version = ::Gem::Requirement.new("~> 1.9")
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: log2sock
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
+platform: ruby
+authors:
+- Alex Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies: []
+description: log2sock allows you to send logs to a UNIX domain socket. Its usage is
+  similar to the Ruby 'logger' class, except with slightly less features.
+email: !binary |-
+  YXdpbGxpYW1zQGFsZXh3aWxsaWFtcy5jYQ==
+executables:
+- log2read
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- bin/log2read
+- lib/log2sock.rb
+- log2sock.gemspec
+homepage: http://unscramble.co.jp
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: log2sock allows you to send logs to a UNIX domain socket
+test_files: []