sysloggly 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa71e8a9aa3a703e22d2697f224e7a9a28eae455
-  data.tar.gz: cb7bcaf874692f0da1d854a36e33399bcc59af05
+SHA256:
+  metadata.gz: cdbef2d70a52185bd9eecc6bbcc28f2ce3b94863a430ab4598151f8cf1db4e2a
+  data.tar.gz: fe673d581bd2ecb232c36555c70e39360bc4e4c7d1f8b6215920f50557fb9d5e
 SHA512:
-  metadata.gz: 1010af1fc3672ac6be8622c63de69d5dbb08f245bf65db15d97509882e0b1ec06c7626b44e169c2c2aa4471dd02cecabee944abd5d8665a5b3b065de6bbc9e08
-  data.tar.gz: 2e29f9c69d8a90699094bd3928cd4ed6e81fb3ad078a2c36435fc8253125ce1b5fc2fbc08c442450213267d14a888e7cab91ba8dd463eade5a75ac0c2fe3367d
+  metadata.gz: 10d5c7d1acef408121a62546122ba551dd5ae379848ef3d60689c34d625371ca9ba418ccb6acecf8be4aab6bb5fef90a1d79270eab2189c6e5d860088577dbc1
+  data.tar.gz: e98f897a90fbaae14d7825ac325b746da61d70cf40ff33c431c5f6b91b8bd2c0bfc73dc71aa9d2a2a85c46eddcd9c99f3b2e4e337f05fc74c20b9de0245e4255

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+#### 0.4.0
+- [break] log +hostname as JSON field
+
 #### 0.3.2
 - [new] option `ignore_user_agents` with default "Pingdom.com_bot"
 

data/lib/sysloggly.rb

@@ -7,13 +7,14 @@ require "sysloggly/clients/filelog"
 require "sysloggly/clients/networklog"
 require "sysloggly/formatters/simple_formatter"
 require "sysloggly/formatters/syslog_formatter"
+require "sysloggly/logger"
 
 #
 # Sysloggly
 #
 # @config [uri] only supports [udp|tcp|file]
 module Sysloggly
-  class InputURLRequired < ArgumentError; end
+  class InvalidInputURL < ArgumentError; end
   class UnsupportedScheme < ArgumentError; end
   class UnknownFacility < ArgumentError; end
 
@@ -24,39 +25,14 @@ module Sysloggly
   def self.configure
     yield self
   end
-
-
-  # Creates a new logger instance
-  #
-  # @return [Logger]
-  # @api public
-  def self.new(url, opts = {})
-    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
-
-    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)
-      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/rails"  if Object.const_defined?(:Rails) && Rails.const_defined?(:Railtie)
+#
+# load extensions
+#
+if Object.const_defined?(:Rails) && Rails.const_defined?(:Railtie)
+  require "sysloggly/rails"
+end
+if defined?(Honeybadger)
+  require 'sysloggly/extensions/honeybadger'
+end

data/lib/sysloggly/formatters/simple_formatter.rb

@@ -1,18 +1,24 @@
 require "multi_json"
 require "socket"
 
+#
+# Simple formatter to output error messages as JSON.
+#
 module Sysloggly
   module Formatters
     class SimpleFormatter
-      attr_reader :input_uri, :opts
+      attr_reader :input_uri, :custom_fields
 
-      def initialize(input_uri, opts)
+      def initialize(input_uri, opts = {})
         @input_uri = input_uri
-        @opts = opts
 
+        @env = opts[:env] || Sysloggly.env
         @hostname = opts[:hostname] || Socket.gethostname.split(".").first
         @progname = opts[:progname]
-        @custom_options = opts.except(:hostname, :progname)
+        @custom_fields = opts.except(:progname).merge({
+          env: @env,
+          hostname: @hostname
+        })
 
         if ["udp", "tcp"].include?(@input_uri.scheme) && !@input_uri.path.empty?
           if @facility = @input_uri.path.split("/")[1]
@@ -35,10 +41,10 @@ module Sysloggly
 
       # @api public
       def call(severity, datetime, progname, payload)
-        message = "#{severity} [#{datetime.strftime(datetime_format)}] #{@hostname} "
+        message = "#{severity} [#{datetime.strftime(datetime_format)}] "
 
-        message << MultiJson.dump(hashify_message(payload).merge(@custom_options))
-        message << "\r\n"  if ["file", "tcp"].include?(@input_uri.scheme)
+        message << MultiJson.dump(hashify_message(payload).merge(custom_fields))
+        message << "\r\n"  if ["file", "tcp"].include?(input_uri.scheme)
 
         message
       end

data/lib/sysloggly/formatters/syslog_formatter.rb

@@ -1,3 +1,6 @@
+#
+# Formatter to output messages as JSON in Rsyslog format.
+#
 module Sysloggly
   module Formatters
     class SyslogFormatter < SimpleFormatter
@@ -29,7 +32,7 @@ module Sysloggly
         # 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 << MultiJson.dump(hashify_message(payload).merge(custom_fields))
         message << "\r\n"  if ["file", "tcp"].include?(@input_uri.scheme)
 
         message

data/lib/sysloggly/logger.rb

@@ -0,0 +1,34 @@
+module Sysloggly
+  module Logger
+    #
+    # Return new Ruby logger instance configured for Sysloggly.
+    #
+    # @return [Logger]
+    # @api public
+    def self.new(url, opts = {})
+      begin
+        input_uri = URI.parse(url)
+      rescue URI::InvalidURIError => e
+        raise InvalidInputURL, "Invalid Input URL `#{url.inspect}`"
+      end
+
+      client, formatter = nil
+
+      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)
+        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
+end

data/lib/sysloggly/rails.rb

@@ -16,8 +16,7 @@ module Sysloggly
         config.uri ||= "file://#{Rails.root.join("log","sysloggly.log")}"
         config.ignore_user_agents ||= ["Pingdom.com_bot"]
 
-        config.logger = Sysloggly.new(config.uri, {
-          env: config.env,
+        config.logger = Sysloggly::Logger.new(config.uri, {
           progname: config.progname
         })
       end
@@ -41,8 +40,6 @@ module Sysloggly
       end
 
       Lograge.setup(app)
-
-      require 'sysloggly/extensions/honeybadger'  if defined?(Honeybadger)
     end
   end
 end

data/lib/sysloggly/version.rb

@@ -1,3 +1,3 @@
 module Sysloggly
-  VERSION = "0.3.2".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sysloggly
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -86,6 +86,7 @@ files:
 - lib/sysloggly/extensions/honeybadger.rb
 - lib/sysloggly/formatters/simple_formatter.rb
 - lib/sysloggly/formatters/syslog_formatter.rb
+- lib/sysloggly/logger.rb
 - lib/sysloggly/rails.rb
 - lib/sysloggly/version.rb
 - sysloggly.gemspec
@@ -109,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sysloggly
-rubygems_version: 2.5.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Lograge and Syslog integration for Rails apps.