syslog_ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05ceabc82694c02a9a63e44f0b5106563031f66d
+  data.tar.gz: e331f6898d9bfec6d53ec2c043e1769e50e87be9
+SHA512:
+  metadata.gz: 65d8afee0f7fdaa456c5e067de270e15c688f49bcab28c9ab605916082b11cc329b86acb6e649e8ecdc8d0b86f0053a89e2e8ff7f0827f561487c8648a31df33
+  data.tar.gz: 1ba41b4558889326259bfe17f053720e9a327476e9e37fae06d932ab1cd75002475fdb680a1e759e3e65c818502f1738ef64b51ef87417eee01121c2d0cc0a43

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in syslog_ruby.gemspec
+gemspec
+
+# Used to benchmark
+gem 'syslog-logger'
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009-2015 johnskopis. https://github.com/johnskopis/syslog_ruby
+
+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,40 @@
+# SyslogRuby
+
+This gem implements the syslog protocol in pure ruby. The Syslog module that
+uses the openlog(3) syscall can only have a single facility open. SyslogRuby
+allows you to have as many loggers as you want.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'syslog_ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install syslog_ruby
+
+## Usage
+
+The syslog_ruby gem also implements a pure ruby version of the Syslog module:
+
+    require 'syslog_compat'
+
+To use the pure ruby version
+
+    tcp = SyslogRuby::Logger.new('ruby', :LOCAL3, uri: 'tcp://127.0.0.1:514')
+    udp = SyslogRuby::Logger.new('ruby', :LOCAL4, uri: 'udp://127.0.0.1:514')
+    local = SyslogRuby::Logger.new('ruby', :LOCAL5, uri: '/dev/log')
+    local.info "a message"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/benchmark.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#
+require 'benchmark'
+
+# pass an arg to use the pure ruby Syslog module
+if !!ARGV[0]
+  puts "monkey patching Syslog module..."
+  require 'syslog_compat'
+end
+require 'syslog-logger'
+require 'syslog_ruby'
+
+
+Benchmark.bm(20) do |x|
+  x.report('single syslog') do
+    Syslog.open
+    225.times do
+      Syslog.info "(single syslog) Logged via Syslog"
+    end
+    Syslog.close if Syslog.opened?
+  end
+
+  sleep 1
+
+  x.report('single syslogger') do
+    l1 = Logger::Syslog.new('test', Syslog::LOG_SYSLOG)
+    225.times do
+      l1.info "(single syslogger) Logged via Logger::Syslog (1)"
+    end
+  end
+
+  sleep 1
+
+  x.report('single pure ruby') do
+    rl1 = SyslogRuby::Logger.new('pure-test1', :SYSLOG, uri: '/dev/log')
+    225.times do
+      rl1.info "(single pure ruby) logged via SyslogRuby::Logger (1)"
+    end
+  end
+
+  sleep 1
+
+  x.report('2 sysloggers') do
+    l1 = Logger::Syslog.new('test2-1', Syslog::LOG_SYSLOG)
+    l2 = Logger::Syslog.new('test2-2', Syslog::LOG_SYSLOG)
+    225.times do
+      l1.info "(2 sysloggers) logged via Logger::Syslog (1)"
+      l2.info "(2 sysloggers) logged via Logger::Syslog (2)"
+    end
+  end
+
+  sleep 1
+
+  x.report('2 pure ruby') do
+    rl1 = SyslogRuby::Logger.new('pure-test2-1', :SYSLOG, uri: '/dev/log')
+    rl2 = SyslogRuby::Logger.new('pure-test2-2', :SYSLOG, uri: '/dev/log')
+    225.times do
+      rl1.info "(2 pure ruby) logged via SyslogRuby::Logger (1)"
+      rl2.info "(2 pure ruby) logged via SyslogRuby::Logger (2)"
+    end
+  end
+end

data/lib/syslog_compat.rb

@@ -0,0 +1,104 @@
+require 'syslog_ruby'
+
+module Syslog
+  include SyslogRuby::Severity
+  include SyslogRuby::Facility
+  @@logger = nil
+
+  class << self
+    def setup_severity_methods
+      SyslogRuby::Severity.constants.each do |level_name|
+        level = SyslogRuby::Severity.const_get level_name
+
+        self.class.send :define_method, level_name.downcase do |*args|
+          @@logger.log level, *args
+        end
+        self.class.send :define_method, level_name.downcase.to_sym do |*args|
+          @@logger.log level, *args
+        end
+      end
+    end
+
+    def open(ident = 'ruby', logopt = nil, facility = Syslog::LOG_LOCAL6)
+      open_opt(ident, logopt, facility)
+    end
+
+    def open_opt(ident = 'ruby', logopt = nil, facility = Syslog::LOG_LOCAL6, options = {})
+      options[:uri] = options[:uri] || find_syslog_socket
+      @@logger ||= ::SyslogRuby::Logger.new(ident, facility, options)
+      if block_given?
+        yield @@logger
+        @@logger.close
+      else
+        @@logger
+      end
+    end
+
+    def find_syslog_socket
+      %w[
+        /dev/log
+        /var/run/syslog
+      ].find do |file|
+        file if File.exists?(file)
+      end
+    end
+
+    def info(*args)
+      @@logger.info(*args)
+    end
+
+    def log(*args)
+      @@logger.log(*args)
+    end
+
+    def inspect
+      @@logger.inspect
+    end
+
+    def close
+      raise RuntimeError.new "syslog not open" unless @@logger
+      @@logger.close
+    ensure
+      @@logger = nil
+    end
+
+    def reopen(*args)
+      self.close
+      self.open(*args)
+    end
+
+    def opened?
+      @@logger ? @@logger.opened? : false
+    end
+
+    def mask
+      @@logger.mask if @@logger
+    end
+
+    def mask=(priority_mask)
+      @@logger.mask = priority_mask if @@logger
+    end
+
+    def LOG_MASK(level)
+      @@logger.LOG_MASK(level) if @@logger
+    end
+
+    def LOG_UPTO(level)
+      @@logger.LOG_UPTO(level) if @@logger
+    end
+
+    def instance
+      @@logger if @@logger
+    end
+
+    def ident
+      @@logger.ident if @@logger
+    end
+
+    def options
+      @@logger.options if @@logger
+    end
+  end
+
+  self.setup_severity_methods
+end

data/lib/syslog_ruby.rb

@@ -0,0 +1,4 @@
+require 'syslog_ruby/version'
+require 'syslog_ruby/severity'
+require 'syslog_ruby/facility'
+require 'syslog_ruby/logger'

data/lib/syslog_ruby/facility.rb

@@ -0,0 +1,32 @@
+require 'syslog_ruby/lookup_from_const'
+
+module SyslogRuby
+  module Facility
+    extend LookupFromConst
+    KERN     =  0 << 3
+    USER     =  1 << 3
+    MAIL     =  2 << 3
+    DAEMON   =  3 << 3
+    AUTH     =  4 << 3
+    SYSLOG   =  5 << 3
+    LPR      =  6 << 3
+    NEWS     =  7 << 3
+    UUCP     =  8 << 3
+    CRON     =  9 << 3
+    AUTHPRIV = 10 << 3
+    FTP      = 11 << 3
+    NTP      = 12 << 3
+    SECURITY = 13 << 3
+    CONSOLE  = 14 << 3
+    RAS      = 15 << 3
+    LOCAL0   = 16 << 3
+    LOCAL1   = 17 << 3
+    LOCAL2   = 18 << 3
+    LOCAL3   = 19 << 3
+    LOCAL4   = 20 << 3
+    LOCAL5   = 21 << 3
+    LOCAL6   = 22 << 3
+    LOCAL7   = 23 << 3
+    NONE     = SYSLOG
+  end
+end

data/lib/syslog_ruby/logger.rb

@@ -0,0 +1,169 @@
+require 'socket'
+
+module SyslogRuby
+  class Logger
+    attr_accessor :ident, :facility, :socket, :hostname, :mask, :log_uri
+    class << self
+      def setup_severity_methods
+        SyslogRuby::Severity.constants.each do |level_name|
+          level = SyslogRuby::Severity.const_get level_name
+
+          define_method(level_name.downcase) do |*args|
+            message = args.shift
+            facility = args.shift || send(:facility)
+            _log(facility, level, message)
+          end
+        end
+      end
+    end
+
+    @@facilities = {}
+    @@severities = {}
+    Facility.setup_constants @@facilities
+    Severity.setup_constants @@severities
+    self.setup_severity_methods
+
+    def initialize(ident = 'ruby',
+                   facility = Facility::LOCAL6,
+                   options = {})
+      @ident = "#{ident}[#{$$}]"
+      @facility = _configure_facility(facility)
+      @mask = LOG_UPTO(Severity::DEBUG)
+      @log_uri = options.fetch(:uri, 'testing')
+      @hostname = Socket.gethostname.split('.').first
+      _open
+    end
+
+    def _configure_facility(facility)
+      case facility
+      when Integer || Fixnum
+        facility
+      when Symbol || String
+        Facility[Facility]
+      else
+        Facility::NONE
+      end
+    end
+
+    def log(level, message, *message_args)
+      level = case level
+      when Integer || Fixnum
+        level
+      when Symbol || String
+        Severity[level]
+      else
+        Severity::INFO
+      end
+      _log(facility, level, message, *message_args)
+    end
+
+    def close
+      raise RuntimeError.new "syslog not open" if socket.closed?
+      socket.close
+    end
+
+    def reopen(*args)
+      close && _open
+    end
+
+    def LOG_MASK(level)
+      Severity[level]
+    end
+
+    def LOG_UPTO(level)
+      (0...Severity[level]).inject(Integer(0)) do |mask, i|
+        mask|i
+      end
+    end
+
+    def opened?
+      socket && !socket.closed?
+    end
+
+    def options
+      0
+    end
+
+  private
+
+    def _connect_unix(path)
+      @local = true
+      begin
+        @socket = UNIXSocket.new(path)
+      rescue Errno::EPROTOTYPE => e
+        raise unless e.message =~ /Protocol wrong type for socket/
+        @socket = Socket.new Socket::PF_UNIX, Socket::SOCK_DGRAM
+        @socket.connect Socket.pack_sockaddr_un(path)
+      end
+    end
+
+    def _connect_udp(uri)
+      host, port = uri[6..-1].split(':')
+      @socket = UDPSocket.new
+      @socket.connect(host, port.to_i)
+    end
+
+    def _connect_tcp(uri)
+      host, port = uri[6..-1].split(':')
+      @socket = TCPSocket.new(host, port.to_i)
+    end
+
+    def _connect_test
+      @socket = STDERR.dup.fileno
+    end
+
+    def _open
+      if @log_uri.start_with? '/'
+        _connect_unix(@log_uri)
+      elsif @log_uri.start_with? 'tcp://'
+        _connect_tcp(@log_uri)
+      elsif @log_uri.start_with? 'udp://'
+        _connect_udp(@log_uri)
+      elsif @log_uri == 'testing'
+        _connect_test
+      else
+        raise RuntimeError.new 'unknown :uri ' \
+          'must be one of path, tcp://, or udp://'
+      end
+    rescue => e
+      STDERR.puts "An exception (#{e.message}) occured while connecting to: "\
+        "#{@log_uri}."
+    end
+
+    def _log(facility, level, message, *message_args)
+      return unless level & mask
+      msg = if message_args.length > 0
+              message % message_args
+            else
+              message
+            end
+
+      proto_msg = if @local
+                    "<#{facility + level}> "\
+                      "#{ident}" \
+                      ": " \
+                      "#{msg}\n"
+                  else
+                    "<#{facility + level}> "\
+                      "#{Time.now.strftime('%b %d %H:%M:%S')} " \
+                      "#{hostname} " \
+                      "#{ident}" \
+                      ": " \
+                      "#{msg}\n"
+                  end
+
+      begin
+        !!socket.write(proto_msg)
+      rescue => e
+        retries ||= 0
+        retries += 1
+        if retries < 10
+          _open
+          retry if opened?
+        else
+          STDERR.puts "syslog is down!! tried to log: #{proto_msg}"
+        end
+      end
+    end
+  end
+end

data/lib/syslog_ruby/lookup_from_const.rb

@@ -0,0 +1,34 @@
+module SyslogRuby
+  module LookupFromConst
+    def setup_constants(dst)
+      constants.each do |pri|
+        cval = const_get pri
+
+        dst[pri] = cval
+        dst[pri.downcase] = cval
+
+        dst[:"LOG_#{pri.to_s}"] = cval
+        dst[:"LOG_#{pri.downcase.to_s}"] = cval
+        const_set :"LOG_#{pri.to_s}", cval
+
+        dst[pri.to_s] = cval
+        dst[pri.downcase.to_s] = cval
+
+        dst[cval] = cval
+      end
+
+      self.class.send(:define_method, :keys) do
+        dst.keys
+      end
+
+      self.class.send(:define_method, :[]) do |key|
+        value_none = const_get :NONE
+        dst.fetch(key, value_none)
+      end
+
+      self.class.send(:define_method, :[]=) do |key, value|
+        raise RuntimeError.new "#{self.class} is read only"
+      end
+    end
+  end
+end

data/lib/syslog_ruby/severity.rb

@@ -0,0 +1,16 @@
+require 'syslog_ruby/lookup_from_const'
+
+module SyslogRuby
+  module Severity
+    extend LookupFromConst
+    EMERG = PANIC = 0
+    ALERT = 1
+    CRIT = 2
+    ERR = ERROR = 3
+    WARN = WARNING = 4
+    NOTICE = 5
+    INFO = 6
+    DEBUG = 7
+    NONE = 10
+  end
+end

data/lib/syslog_ruby/version.rb

@@ -0,0 +1,3 @@
+module SyslogRuby
+  VERSION = "0.0.1"
+end

data/syslog_ruby.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/syslog_ruby/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Skopis"]
+  gem.email         = ["john.skopis@causes.com"]
+  gem.description   = %q{Ruby Logger that sends directly to a variety of syslog endpoints}
+  gem.summary       = %q{Ruby Logger that sends directly to a variety of syslog endpoints}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "syslog_ruby"
+  gem.require_paths = ["lib"]
+  gem.version       = SyslogRuby::VERSION
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: syslog_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Skopis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies: []
+description: Ruby Logger that sends directly to a variety of syslog endpoints
+email:
+- john.skopis@causes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- benchmark.rb
+- lib/syslog_compat.rb
+- lib/syslog_ruby.rb
+- lib/syslog_ruby/facility.rb
+- lib/syslog_ruby/logger.rb
+- lib/syslog_ruby/lookup_from_const.rb
+- lib/syslog_ruby/severity.rb
+- lib/syslog_ruby/version.rb
+- syslog_ruby.gemspec
+homepage: ''
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Ruby Logger that sends directly to a variety of syslog endpoints
+test_files: []
+has_rdoc: