ocean-rails 1.14.2 → 1.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3915eb13289c59b8d46a29dd86e05135d318677d
-  data.tar.gz: 24fe6384132bc912908873d503c5de870ada8f46
+  metadata.gz: b7f957055559e368f6cb0c7c449f46b957c68076
+  data.tar.gz: 9cb3d11b49d425bc45bd229929d46b43361e7f18
 SHA512:
-  metadata.gz: bceea4c882f79accc91905b0e330ea122e03c282ada6ce7997dffce61dc5d9866df1c33b8e2ce50a98afd7da8d040f22cac03451fe6b47d1c79f263965401648
-  data.tar.gz: 5623d6b9394e554ef888d13675291730cec4bb6de9b372bd5f569a92cd20ac1ba8006af0d7e47a6f2d50511e316c703b5206d0bbc80d968b8d45632d426613f0
+  metadata.gz: 0091f80cdf13da6d98ae0aa052de5eac75946e7569256242b72ad2a59ec442d89c3613e81ccc175fca80390944cdfb598b70f1757e069860772d50bbe4ffcb63
+  data.tar.gz: cb1f8e078078690ee7c88d4e662e3477128a451d84d9b32d5485b56c817b5bdf20d208cd2d2e66973c412aae0b9daf3af5bc40ff120dfcd0b2a0d70dfc4e0236

data/lib/ocean/version.rb

@@ -1,3 +1,3 @@
 module Ocean
-  VERSION = "1.14.2"
+  VERSION = "1.14.3"
 end

data/lib/ocean/zeromq_logger.rb

@@ -1,10 +1,21 @@
 require 'socket'
 
+#
+# This class is a drop-in replacement for the standard Rails logger. It is
+# used in production only and uses ZeroMQ as an intelligent, high-capacity
+# transport. ZeromqLogger implements enough of the Logger interface to allow
+# it to override the standard logger.
+#
 class ZeromqLogger
 
   attr_accessor :level, :log_tags
 
 
+  #
+  # Obtains the IP of the current process, initialises the @logger object
+  # by instantiating a ZeroLog object which then is used to set up the
+  # log data sender.
+  #
   def initialize
     super
     # Get info about our environment
@@ -14,14 +25,50 @@ class ZeromqLogger
     @logger.init_log_data_sender "/tmp/sub_push_#{Process.pid}"
   end
 
-
+  #
+  # Utility function which returns true if the current log level is +DEBUG+ or lower.
+  #
   def debug?() @level <= 0; end
+
+  #
+  # Utility function which returns true if the current log level is +INFO+ or lower.
+  #
   def info?()  @level <= 1; end
+
+  #
+  # Utility function which returns true if the current log level is +WARN+ or lower.
+  #
   def warn?()  @level <= 2; end
+
+  #
+  # Utility function which returns true if the current log level is +ERROR+ or lower.
+  #
   def error?() @level <= 3; end
+
+  #
+  # Utility function which returns true if the current log level is +FATAL+ or lower.
+  #
   def fatal?() @level <= 4; end
 
 
+  #
+  # This is the core method to add new log messages to the Rails log. It does nothing
+  # if the level of the message is lower than the current log level, or if the message
+  # is blank. Otherwise it creates a JSON log message as a hash, with data for the 
+  # following keys:
+  #
+  # +timestamp+: The time in milliseconds since the start of the Unix epoch.
+  #
+  # +ip+:        The IP of the logging entity.
+  #
+  # +pid+:       The Process ID of the logging process.
+  #
+  # +service+:   The name of the service.
+  #
+  # +level+:     The log level of the message (0=debug, 1=info, 2=warn, etc).
+  #
+  # +msg+:       The log message itself. 
+  #
   def add(level, msg, progname)
     return true if level < @level
     msg = progname if msg.blank?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ocean-rails
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.14.3
 platform: ruby
 authors:
 - Peter Bengtson