sysloggly 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 799887c8c66799cf6adecd2b6c4126d5a71e48cb
-  data.tar.gz: 2abb2a85526ee55d9e9c9d855f30fe4dee9e6b0c
+  metadata.gz: b099237d625daa44f15bb246d47057788d2a8098
+  data.tar.gz: 49351d18111a1f4ddd94711b499f7b5efd0c0447
 SHA512:
-  metadata.gz: 1ecdb9ed3e3eb8e12d28137f3f44fca51509592525e5d2c202264f66592076028af3993232cce9e4de026be3261ca335fd45b4fff78a892f912d8774ba914651
-  data.tar.gz: 4b863a3ecd2867461213f74d7d6664853b0d541ec2c782fe14ce7793518aa8b79e05e861d2191abea8567e348a789659feb4293d8b2c3b70133ac4e250632f7f
+  metadata.gz: 36635b1c8513a980a6823240b9de4b27b7d0963bf8d2889117ed3327526f0db3e781e3ee0591ab6228a2ce212bbc4b9167c8b86a01971f2dce59c66e6433c94b
+  data.tar.gz: 21b936e1a842600b077b6b9e58277ce1b74cce45fb327b31780b9f009392ee94dbde7e78ab51d0784a19eb4d179d2197382135944a4122467bed5780881816d0

data/lib/sysloggly.rb

@@ -1,5 +1,37 @@
+require 'logger'
 require 'lograge'
-require 'syslogger'
 
-require 'sysloggly/rails'
+#
+# Sysloggly
+#
+# @config [uri] only supports [udp|tcp|file]
+module Sysloggly
+  class InputURLRequired < ArgumentError; end
+  class UnsupportedScheme < ArgumentError; end
+  class UnknownFacility < ArgumentError; end
+
+  mattr_accessor :progname, :env, :uri, :logger
+
+  def self.configure
+    yield self
+  end
+
+  def self.new(url, opts = {})
+    client = Sysloggly::Client.new(url, opts)
+    logger = Logger.new(client)
+
+    if client.respond_to?(:formatter)
+      logger.formatter = client.formatter
+    elsif client.respond_to?(:datetime_format)
+      logger.datetime_format = client.datetime_format
+    end
+
+    logger
+  end
+end
+
 require 'sysloggly/version'
+require 'sysloggly/client'
+require 'sysloggly/client/filelog'
+require 'sysloggly/client/syslog'
+require 'sysloggly/rails'  if Object.const_defined?(:Rails) && Rails.const_defined?(:Railtie)

data/lib/sysloggly/client.rb

@@ -0,0 +1,113 @@
+require 'multi_json'
+require 'socket'
+require 'uri'
+
+module Sysloggly
+  module Client
+
+    # Creates a new client that conforms to the Logger::LogDevice specification.
+    #
+    # @return [Sysloggly::Client::Syslog, Sysloggly::Client::FileLog] returns an instance of an Sysloggly client class
+    # @api public
+    def self.new(url, opts = {})
+      unless url
+        raise InputURLRequired.new
+      end
+
+      begin
+        input_uri = URI.parse(url)
+      rescue URI::InvalidURIError => e
+        raise InputURLRequired.new("Invalid Input URL: #{url}")
+      end
+
+      case input_uri.scheme
+      when 'file'
+        Sysloggly::Client::Filelog.new(input_uri, opts)
+      when 'udp', 'tcp'
+        Sysloggly::Client::Syslog.new(input_uri, opts)
+      else
+        raise Sysloggly::UnsupportedScheme.new("#{input_uri.scheme} is unsupported")
+      end
+    end
+
+
+    module InstanceMethods
+
+      # Specifies the date/time format for this client
+      def datetime_format
+        "%b %e %H:%M:%S"
+      end
+
+      def setup_options
+        @hostname = opts[:hostname] || Socket.gethostname.split('.').first
+        @progname = opts[:progname]
+        @custom_options = opts.except(:hostname, :progname)
+
+        if ['udp', 'tcp'].include?(@input_uri.scheme) && !@input_uri.path.empty?
+          if @facility = @input_uri.path.split('/')[1]
+            @facility = @facility.to_i
+            unless @facility <= 23 && @facility >= 0
+              raise Sysloggly::UnknownFacility.new(@facility.to_s)
+            end
+          end
+        else
+          @facility = 23
+        end
+      end
+
+      # Syslog specific PRI calculation.
+      # See RFC3164 4.1.1
+      def pri(severity)
+        severity_value = case severity
+                         when "FATAL"
+                           0
+                         when "ERROR"
+                           3
+                         when "WARN"
+                           4
+                         when "INFO"
+                           6
+                         when "DEBUG"
+                           7
+                         end
+        (@facility << 3) + severity_value
+      end
+
+      # Generate a syslog compat message
+      # See RFC3164 4.1.1 - 4.1.3
+      def formatter
+        proc do |severity, datetime, progname, msg|
+          processid = Process.pid
+          message = "<#{pri(severity)}>#{datetime.strftime(datetime_format)} #{@hostname} "
+
+          # Include process ID in progname/log tag - RFC3164 § 5.3
+          message << "#{@progname || progname || $0}[#{processid}]: "
+
+          # Only log JSON to Syslog
+          message << MultiJson.dump(hashify_message(msg).merge(@custom_options))
+
+          if ['file', 'tcp'].include?(@input_uri.scheme )
+            message << "\r\n"
+          end
+          message
+        end
+      end
+
+      def hashify_message(msg)
+        if msg.is_a?(Hash)
+          msg
+        elsif msg.is_a?(Exception)
+          { exception_class: msg.class.name, message: msg.message }
+        elsif msg.is_a?(String)
+          begin
+            JSON.parse(msg)
+          rescue
+            { message: msg }
+          end
+        else
+          { message: msg.inspect }
+        end
+      end
+    end
+  end
+end

data/lib/sysloggly/client/filelog.rb

@@ -0,0 +1,35 @@
+module Sysloggly
+  module Client
+    class Filelog
+      include Sysloggly::Client::InstanceMethods
+
+      attr_reader :input_uri, :opts
+      attr_reader :filelog
+
+      def initialize(input_uri, opts)
+        @input_uri = input_uri
+        @opts = opts
+
+        @filelog = File.open(@input_uri.path, File::WRONLY | File::APPEND | File::CREAT)
+
+        setup_options
+      end
+
+
+
+      # Required by Logger::LogDevice
+      #
+      # @api public
+      def write(message)
+        @filelog.write(message)
+      end
+
+      # Required by Logger::LogDevice
+      #
+      # @api public
+      def close
+        @filelog.close
+      end
+    end
+  end
+end

data/lib/sysloggly/client/syslog.rb

@@ -0,0 +1,45 @@
+module Sysloggly
+  module Client
+    class Syslog
+      include Sysloggly::Client::InstanceMethods
+
+      attr_reader :input_uri, :opts
+      attr_reader :syslog
+
+      def initialize(input_uri, opts)
+        @input_uri = input_uri
+        @opts = opts
+
+        case @input_uri.scheme
+        when 'udp'
+          @syslog = UDPSocket.new
+          @syslog.connect(@input_uri.host, @input_uri.port)
+        when 'tcp'
+          @syslog = TCPSocket.new(@input_uri.host, @input_uri.port)
+          @syslog.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
+          @syslog.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
+        end
+
+        setup_options
+      end
+
+      # Required by Logger::LogDevice
+      #
+      # @api public
+      def write(message)
+        begin
+          @syslog.send(message, 0)
+        rescue Timeout::Error => e
+          STDOUT.puts "WARNING: Timeout::Error posting message: #{message}"
+        end
+      end
+
+      # Required by Logger::LogDevice
+      #
+      # @api public
+      def close
+        @syslog.close
+      end
+    end
+  end
+end

data/lib/sysloggly/extensions/honeybadger.rb

@@ -0,0 +1,15 @@
+module Sysloggly
+  module Extensions
+    module Honeybadger #:nodoc:
+      def notify(exception_or_opts, opts = {})
+        uuid = super(exception_or_opts, opts)
+
+        if uuid
+          Sysloggly.logger.error(exception_or_opts)
+        end
+      end
+    end
+  end
+end
+
+Honeybadger.singleton_class.send(:prepend, Sysloggly::Extensions::Honeybadger)

data/lib/sysloggly/rails.rb

@@ -1,33 +1,35 @@
+#
+# Sysloggly default configuration:
+#   @config progname: Rails app name
+#   @config env:      Rails env
+#   @config logger:   file log to sysloggly.log in the rails log directory
+#
 module Sysloggly
-  if Object.const_defined?(:Rails) and Rails.const_defined?(:Railtie)
-    # @private
-    class Railtie < Rails::Railtie
-      initializer 'sysloggly.initialize' do |app|
-        config = app.config
+  # @private
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      Sysloggly.configure do |config|
+        config.progname ||= app.class.parent_name
+        config.env ||= Rails.env
+        config.uri ||= "file://#{Rails.root.join('log','sysloggly.log')}"
 
-        # find app name and app environment
-        app_name = Rails.application.class.parent_name
-        environment = Rails.env
-        begin
-          # try to find a honeybadger configuration
-          honeybadger = YAML.load_file(Rails.root.join('config', 'honeybadger.yml'))
-          environment = honeybadger['env'].to_s
-        rescue
-        end
-
-        # add https://github.com/crohr/syslogger
-        syslogger = Syslogger.new(app_name, Syslog::LOG_PID, Syslog::LOG_LOCAL7)
-        config.syslogger = syslogger
+        config.logger = Sysloggly.new(config.uri, {
+          env: config.env,
+          progname: config.progname
+        })
+      end
 
-        # add https://github.com/roidrage/lograge
+      app.configure do
+        # @see https://github.com/roidrage/lograge
         config.lograge.enabled = true
         config.lograge.formatter = Lograge::Formatters::Json.new
         config.lograge.keep_original_rails_log = true
-        config.lograge.logger = config.syslogger
-        config.lograge.custom_options = lambda do |event|
-          { env: environment }
-        end
+        config.lograge.logger = Sysloggly.logger
       end
+      Lograge.setup(app)
+
+      # load extensions
+      require 'sysloggly/extensions/honeybadger'  if defined?(Honeybadger)
     end
   end
 end

data/lib/sysloggly/version.rb

@@ -1,3 +1,3 @@
 module Sysloggly
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: sysloggly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: lograge
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: syslogger
+  name: lograge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,16 +68,21 @@ dependencies:
         version: '0'
 description: Lograge and Syslog integration for Rails apps.
 email:
-- joergen.dahlke@gmail.de
+- joergen.dahlke@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/sysloggly.rb
+- lib/sysloggly/client.rb
+- lib/sysloggly/client/filelog.rb
+- lib/sysloggly/client/syslog.rb
+- lib/sysloggly/extensions/honeybadger.rb
 - lib/sysloggly/rails.rb
 - lib/sysloggly/version.rb
 homepage: https://github.com/jdahlke/sysloggly
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -85,16 +90,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: bima-loggly
+rubyforge_project: sysloggly
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4