event-logger 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea2137e6df18f6ec102e72dfa4e764a3c0d08435
-  data.tar.gz: e688dc32cc1b81131dc1627544704cf51b097798
+  metadata.gz: 93809936e32dfda51c067929a84ae6ac1f57a7ee
+  data.tar.gz: 8a13f477f1b83ac42e52f89cba01a629a0d6f933
 SHA512:
-  metadata.gz: 3b52dbfde6ea162128c8a8fd98cb823be1f2f55a7fe61b586fd0ee0890d8c070984e2b71b020958206a6e2c8f20492adba5c169eddbe62a6f95bc6f919312fef
-  data.tar.gz: df0c9a7010a3707a8816ce7903b40955761667c0c19227c5f350c0dfcc0c833e5939364e501932b4ae22bc5fe66852e59db80efd76fd1e96c506db04b648993e
+  metadata.gz: b7858efff3d3c45975f0f2ae4c922a7f0f9e86a25332a0ef2a94c27ee877a6ef461712a462da3992514cfe8dda61f1114abeb244f32724b4173a3c8cedf15997
+  data.tar.gz: 8070c88f5ed60ce2131a9b84cd9e5709e3da832ea4e238355a6237f9710ae8337900e148f51be65a43c5798625f3839dd46b40b4ec52efdadc880e1a8079bd7a

data/lib/event-logger.rb

@@ -0,0 +1 @@
+require 'event_logger'

data/lib/event_logger.rb

@@ -1,18 +1,18 @@
 require 'singleton'
-require 'logger'
-require 'uuidtools'
-require 'json'
+require 'securerandom'
+
+require_relative 'event_logger/config'
 
 # Event logger based on:
 # https://blog.logentries.com/2015/07/ditch-the-debugger-and-use-log-analysis-instead/
 class EventLogger
-  attr_accessor :logger
+  attr_reader :config
   attr_accessor :mapping
 
   include Singleton
 
   def initialize
-    @logger = Logger.new(STDOUT)
+    @config = Config.new
     @mapping = nil
   end
 
@@ -26,13 +26,16 @@ class EventLogger
                elsif @mapping && @mapping.key?(details[:name])
                  @mapping[details[:name]][:severity]
                else
-                 'info'
-               end
-    @logger.send(severity, format_log_entry(details_for(type, details)))
+                 :info
+               end.to_sym
+
+    config.logger_instance.write severity, details_for(type, details)
+
+    nil
   end
 
   def create_correlation_id
-    UUIDTools::UUID.random_create.to_s
+    SecureRandom.uuid
   end
 
   private
@@ -40,8 +43,4 @@ class EventLogger
   def details_for(type, details)
     { type: type }.merge(details)
   end
-
-  def format_log_entry(details = {})
-    JSON.generate(details)
-  end
 end

data/lib/event_logger/config.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+require 'event_logger/output/io'
+require 'event_logger/output/logger'
+
+class EventLogger
+  class Config
+    attr_reader :logger
+
+    def initialize
+      self.logger = ENV.fetch('EVENT_LOGGER_LOGGER', :logger).to_sym
+    end
+
+    def logger=(value)
+      if value.is_a?(Symbol) && !%i[logger stdout].include?(value)
+        raise ArgumentError, "Unknown logger type: #{value}"
+      end
+
+      @logger = value
+    end
+
+    def logger_instance
+      if logger == :logger
+        EventLogger::Output::Logger.new(Logger.new(STDOUT))
+      elsif logger == :stdout
+        EventLogger::Output::IO.new($stdout)
+      elsif logger.respond_to?(:<<)
+        EventLogger::Output::IO.new(logger)
+      else
+        EventLogger::Output::Logger.new(logger)
+      end
+    end
+  end
+end

data/lib/event_logger/output/io.rb

@@ -0,0 +1,23 @@
+require 'json'
+
+# Outputs log entries to an IO stream, one JSON hash per entry.
+#
+# Adds `generated_at` and `severity` fields to the hash with the current
+# timestamp in milliseconds and the entry severity.
+class EventLogger
+  module Output
+    class IO
+      attr_reader :stream
+
+      def initialize(stream)
+        @stream = stream
+      end
+
+      def write(severity, details = {})
+        timestamp = (Time.now.to_f * 1000).to_i
+        line = JSON.generate({ generated_at: timestamp, severity: severity }.merge(details))
+        @stream << "#{line}\n"
+      end
+    end
+  end
+end

data/lib/event_logger/output/logger.rb

@@ -0,0 +1,21 @@
+require 'json'
+
+# Outputs log entries to a Logger object, one JSON hash per entry.
+#
+# Can be used with the Ruby Logger or another that responds to per-severity
+# methods.
+class EventLogger
+  module Output
+    class Logger
+      attr_reader :logger
+
+      def initialize(logger)
+        @logger = logger
+      end
+
+      def write(severity, details = {})
+        @logger.public_send(severity, JSON.generate(details))
+      end
+    end
+  end
+end

metadata

@@ -1,38 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: event-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Honeycomb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: uuidtools
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies: []
 description: Consistent Event Logging
 email: developers@honeycomb.tv
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/event-logger.rb
 - lib/event_logger.rb
-homepage: 
-licenses: []
+- lib/event_logger/config.rb
+- lib/event_logger/output/io.rb
+- lib/event_logger/output/logger.rb
+homepage: https://github.com/honeycomb-tv/event-logger
+licenses:
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []