sysloggly 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dae3eb36e9d5eb7a551f1d33e4cc3a696894ab16
-  data.tar.gz: 57d12976b420daac54c5d83e808a55277b7f99c4
+  metadata.gz: 75f81f43322e647a969b2588a304976761ce5572
+  data.tar.gz: 99e90a40755d66b6b234a13f96548fd8ccfc8b8f
 SHA512:
-  metadata.gz: d5a0ad5550b4ad7078b4f5eb6cd9fd8dd03f8e51acdefed905bd3900dc30b436e2b71b57d457cedaa458dbdf338abc03f485e80d9a3573bb4bb808da8e20a3a6
-  data.tar.gz: b97f7605cd0b0f9e67d6ab9a6eeeb46ad99b632cdbf71a6b93e27bd98f718e26f9b8d698cfd9e040c604dda47fd1bce137fc5303ae94c1ad7dc95a59abf880f1
+  metadata.gz: 4b3b0a212295467f075a3e77fae21399c2968a8624f93ba771624d1fc4494838664096c0d25a6428a90db46467380d68e22d9decbee116831adc61dda64a280d
+  data.tar.gz: 6e8f86565cc3c72a2759d385c31a1569f9dc5d24dec83b1c1b72556f7b23d5aa9dc7ebb71ee8a12602890be6fbb0930e270f8257a27ceab2c0caac5de37fde9f

data/lib/sysloggly.rb

@@ -1,5 +1,12 @@
-require 'logger'
-require 'lograge'
+require "logger"
+require "lograge"
+require "uri"
+
+require "sysloggly/version"
+require "sysloggly/clients/filelog"
+require "sysloggly/clients/networklog"
+require "sysloggly/formatters/simple_formatter"
+require "sysloggly/formatters/syslog_formatter"
 
 #
 # Sysloggly
@@ -16,22 +23,38 @@ module Sysloggly
     yield self
   end
 
+
+  # Creates a new logger instance
+  #
+  # @return [Logger]
+  # @api public
   def self.new(url, opts = {})
-    client = Sysloggly::Client.new(url, opts)
-    logger = Logger.new(client)
+    raise InputURLRequired.new  unless url
+
+    begin
+      input_uri = URI.parse(url)
+    rescue URI::InvalidURIError => e
+      raise InputURLRequired.new("Invalid Input URL: #{url}")
+    end
+
+    client, formatter = nil
 
-    if client.respond_to?(:formatter)
-      logger.formatter = client.formatter
-    elsif client.respond_to?(:datetime_format)
-      logger.datetime_format = client.datetime_format
+    case input_uri.scheme
+    when "file"
+      client = Sysloggly::Clients::Filelog.new(input_uri.path)
+      formatter = Sysloggly::Formatters::SimpleFormatter.new(input_uri, opts)
+    when "udp", "tcp"
+      client = Sysloggly::Clients::Networklog.new(input_uri, opts)
+      formatter = Sysloggly::Formatters::SyslogFormatter.new(input_uri, opts)
+    else
+      raise Sysloggly::UnsupportedScheme.new("#{input_uri.scheme} is unsupported")
     end
 
+    logger = Logger.new(client)
+    logger.formatter = formatter
+
     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)
+require "sysloggly/rails"  if Object.const_defined?(:Rails) && Rails.const_defined?(:Railtie)

data/lib/sysloggly/clients/filelog.rb

@@ -0,0 +1,6 @@
+module Sysloggly
+  module Clients
+    class Filelog < Logger::LogDevice
+    end
+  end
+end

data/lib/sysloggly/clients/networklog.rb

@@ -0,0 +1,45 @@
+require "socket"
+
+module Sysloggly
+  module Clients
+    class Networklog
+      attr_reader :input_uri, :socket
+
+      # Creates a new client that conforms to the Logger::LogDevice specification.
+      #
+      # @return [Sysloggly::Client::Networklog]
+      # @api public
+      def initialize(input_uri)
+        @input_uri = input_uri
+
+        case @input_uri.scheme
+        when "udp"
+          @socket = UDPSocket.new
+          @socket.connect(@input_uri.host, @input_uri.port)
+        when "tcp"
+          @socket = TCPSocket.new(@input_uri.host, @input_uri.port)
+          @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1)
+          @socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
+        end
+      end
+
+      # Required by Logger::LogDevice
+      #
+      # @api public
+      def write(message)
+        begin
+          @socket.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
+        @socket.close
+      end
+    end
+  end
+end

data/lib/sysloggly/formatters/simple_formatter.rb

@@ -0,0 +1,65 @@
+require "multi_json"
+require "socket"
+
+module Sysloggly
+  module Formatters
+    class SimpleFormatter
+      attr_reader :input_uri, :opts
+
+      def initialize(input_uri, opts)
+        @input_uri = input_uri
+        @opts = opts
+
+        @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
+
+      # Specifies the date/time format for this client
+      #
+      # @api public
+      def datetime_format
+        "%b %e %H:%M:%S"
+      end
+
+      # @api public
+      def call(severity, datetime, progname, payload)
+        message = "#{severity} [#{datetime.strftime(datetime_format)}] #{@hostname} "
+
+        message << MultiJson.dump(hashify_message(payload).merge(@custom_options))
+        message << "\r\n"  if ["file", "tcp"].include?(@input_uri.scheme)
+
+        message
+      end
+
+      # @api private
+      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/formatters/syslog_formatter.rb

@@ -0,0 +1,39 @@
+module Sysloggly
+  module Formatters
+    class SyslogFormatter < SimpleFormatter
+      # 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
+      #
+      # @api public
+      def call(severity, datetime, progname, payload)
+        message = "<#{pri(severity)}>#{datetime.strftime(datetime_format)} #{@hostname} "
+
+        # Include process ID in progname/log tag - RFC3164 § 5.3
+        message << "#{@progname || progname || $0}[#{Process.pid}]: "
+
+        message << MultiJson.dump(hashify_message(payload).merge(@custom_options))
+        message << "\r\n"  if ["file", "tcp"].include?(@input_uri.scheme)
+
+        message
+      end
+    end
+  end
+end

data/lib/sysloggly/version.rb

@@ -1,3 +1,3 @@
 module Sysloggly
-  VERSION = "0.2.1"
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sysloggly
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -74,10 +74,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sysloggly.rb
-- lib/sysloggly/client.rb
-- lib/sysloggly/client/filelog.rb
-- lib/sysloggly/client/syslog.rb
+- lib/sysloggly/clients/filelog.rb
+- lib/sysloggly/clients/networklog.rb
 - lib/sysloggly/extensions/honeybadger.rb
+- lib/sysloggly/formatters/simple_formatter.rb
+- lib/sysloggly/formatters/syslog_formatter.rb
 - lib/sysloggly/rails.rb
 - lib/sysloggly/version.rb
 homepage: https://github.com/jdahlke/sysloggly

data/lib/sysloggly/client.rb

@@ -1,113 +0,0 @@
-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

@@ -1,35 +0,0 @@
-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

@@ -1,45 +0,0 @@
-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