bmc-daemon-lib 0.3.18 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e5609f9590972c691a3756c1af6bd9ad1ee0282
-  data.tar.gz: 6a3ee2207696ebc991abb0992a8334f5db0e0856
+  metadata.gz: 6003c5c0de9402b624030ffc916167fe5d220286
+  data.tar.gz: 98df2f514f440a1a8ef06915cfb0aaddbd172a7c
 SHA512:
-  metadata.gz: 94186c5a6810b5c363bc6991ed5a8fc4d83cda7db8a3bcdb36442a2793efb411aa47e1dc2c957a90d6d810318556baf9f07dae00e81861c568f9115ce22ac1e9
-  data.tar.gz: 2c04229dd313885efd3b7cebc8202f8074d4fc46f6e01fe6e86b75445452ac17859f41397fc43a70d36754945c2f7fbad71a1b169a66584f89b787f268b3cb76
+  metadata.gz: 4c583268f6fb0e802a5ff8c4ea47ec8fa4ef34534cc14b92be74cda70bcc892cab263f35898d0efef32809a6694a891b18008142ede3d29fee09c470192ab994
+  data.tar.gz: 595ad7d343c8880c992e2b4701f079e841205ebe0ae792ecac836a8c5b368dd13501ed0ca508b8821298f9d4f5230654b0d198e0545943c7a035007303a53236

data/.gitignore

@@ -9,6 +9,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/.idea
 
 # Used by dotenv library to load environment variables.
 # .env

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bmc-daemon-lib (0.3.18)
+    bmc-daemon-lib (0.4.0)
       chamber (~> 2.9)
 
 GEM
@@ -12,7 +12,7 @@ GEM
       thor (~> 0.19.1)
     diff-lcs (1.2.5)
     hashie (3.4.6)
-    rake (11.2.2)
+    rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)

data/bmc-daemon-lib.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   # Project version
-  spec.version                      = "0.3.18"
+  spec.version                      = "0.4.0"
 
   # Project description
   spec.name                         = "bmc-daemon-lib"

data/lib/bmc-daemon-lib/logger.rb

@@ -0,0 +1,97 @@
+require "logger"
+module BmcDaemonLib
+  class Logger < Logger
+
+    DEFAULT_FORMAT = {
+      # header: "%s ‡ %d\t%-8s %-12s ",
+      header: "%{time} %7{pid} %-6{severity} %-10{pipe} | %{context}",
+      # header: "%{time} %7{pid} %-6{severity} %-10{pipe}(-‡-)%{context}",
+      time:   "%Y-%m-%d %H:%M:%S",
+      context: "[%s]",
+      text:   "%s",
+      array:  "     ·%s",
+      hash:   "     ·%-15s %s",
+      trim:   400,
+      }
+
+    def initialize filename, rotation
+      # Initialize
+      super
+      @format = DEFAULT_FORMAT
+
+      # Import LOGGER_FORMAT if defined
+      if (defined?'LOGGER_FORMAT') && (LOGGER_FORMAT.is_a? Hash)
+        @format.merge! LOGGER_FORMAT
+      end
+
+      # Define formatter
+      self.formatter = proc do |severity, datetime, progname, messages|
+        formatter(severity, datetime, progname, messages)
+      end
+    end
+
+    def add severity, message, context = nil, details = nil
+      # Start from an empty messages list with the main message
+      messages = []
+      messages << sprintf(@format[:text], message) if message
+
+      # Add details from array
+      details.each do |line|
+        messages << sprintf(@format[:array], line)
+      end if details.is_a? Array
+
+      # Add details from hash
+      details.each do |key, value|
+        messages << sprintf(@format[:hash], key, value)
+      end if details.is_a? Hash
+
+      # Pass all that stuff to my parent
+      super severity, messages, context
+    end
+
+  protected
+
+    def trimmed line
+      line.to_s.rstrip[0..@format[:trim].to_i].force_encoding(Encoding::UTF_8)
+    end
+
+    def formatter severity, datetime, context, messages
+      # Build header with time and context
+      header = @format[:header] % {
+        time: datetime.strftime(@format[:time]),
+        pid: Process.pid,
+        severity: severity,
+        pipe: self.progname,
+        context: build_context(context)
+        }
+
+      # If we have a plain message, we're done
+      return "#{header} #{trimmed(payload)}\n" unless messages.is_a?(Array)
+
+      # If we have a bunch of lines, prefix them and send them together
+      return messages.collect do |line|
+        "#{header} #{trimmed(line)}\n"
+      end.join
+    end
+
+  private
+
+    # Builds prefix from @format[:context] and values
+    def build_context values
+      # Skip if no format defined
+      return "[context is not a hash]" unless @format[:context].is_a? Hash
+
+      # Call the instance's method to get hash values
+      return "[log_context is not a hash]" unless values.is_a? Hash
+
+      # Build each context part
+      return @format[:context].collect do |key, format|
+        sprintf(format, values[key])
+      end.join
+
+    rescue KeyError, ArgumentError => ex
+      return "[context: #{ex.message}]"
+    end
+
+  end
+end

data/lib/bmc-daemon-lib/logger_formatter.rb

@@ -23,9 +23,5 @@ module BmcDaemonLib
 
   protected
 
-    def self.trimmed line
-      line.to_s.rstrip[0..LOG_MESSAGE_TRIM].force_encoding(Encoding::UTF_8)
-    end
-
   end
 end

data/lib/bmc-daemon-lib/logger_helper.rb

@@ -2,77 +2,54 @@ require "logger"
 
 module BmcDaemonLib
   module LoggerHelper
+    # Use accessor to expose logger to Grape, who uses .logger
+    attr_accessor :logger
 
   protected
 
-    def log_info message, details = nil
-      log Logger::INFO, message, details
+    def log_pipe pipe, caller = nil
+      @log_pipe = pipe
+      @logger = BmcDaemonLib::LoggerPool.instance.get pipe
+      @caller = caller
+      #Conf.log "log #{@log_pipe}", "log_to pipe: #{pipe} logger class: #{@logger.class}"
+      #return @logger
     end
 
-    def log_error message, details = nil
-      log Logger::ERROR, message, details
+    def log_context
+      {}      # ['DEFAULT', self.class.name.split('::').last]
     end
 
-    def log_debug message, details = nil
-      log Logger::DEBUG, message, details
+    def log_info message, details = nil
+      logger.add Logger::INFO, message, get_full_context, details
     end
-
-    alias info log_info
-    alias error log_error
-    alias debug log_debug
-
-    def log severity, message, details = nil
-      fail "LoggerHelper.log: invalid logger" unless logger.respond_to? :add
-
-      messages = []
-
-      prefix = build_prefix
-
-      # Add main message
-      messages << sprintf(LOG_MESSAGE_TEXT, prefix, message) if message
-
-      # Add details from array
-      details.each do |line|
-        messages << sprintf(LOG_MESSAGE_ARRAY, prefix, line)
-      end if details.is_a? Array
-
-      # Add details from hash
-      details.each do |key, value|
-        messages << sprintf(LOG_MESSAGE_HASH, prefix, key, value)
-      end if details.is_a? Hash
-
-      # Return all that stuff
-      logger.add severity, messages
+    def log_error message, details = nil
+      logger.add Logger::ERROR, message, get_full_context, details
+    end
+    def log_debug message, details = nil
+      logger.add Logger::DEBUG, message, get_full_context, details
     end
 
   private
 
-    # Builds prefix if LOG_PREFIX_FORMAT defined and caller has log_prefix method to provide values
-    def build_prefix
-      # Skip if no format defined
-      return unless defined?('LOG_PREFIX_FORMAT')
-      return unless LOG_PREFIX_FORMAT.is_a? String
-
-      # At start, values is an empty array
-      values = nil
+    def get_full_context
+      context = nil
 
-      # Call the instance's method
-      if respond_to?(:log_prefix, true)
-        values = log_prefix
-      end
+      # Grab the classe's context
+      context = log_context() if self.respond_to?(:log_context)
 
-      # Change to an array if a simple string
-      values = [values] if values.is_a? String
+      # Initialize an empty context, if log_context returned something else, or it the method was not exposed
+      context = {} unless context.is_a? Hash
 
-      # Ensure we always have an array (method not found, or log_prefix returning something else)
-      values = [] unless values.is_a? Array
+      # Who is the caller? Guess it from caller's class name if not provided
+      context[:caller] ||= self.class.name.to_s.split('::').last
 
-      # Finally format the string
-      return LOG_PREFIX_FORMAT % values.map(&:to_s)
-
-    rescue ArgumentError => ex
-      return "(LOG_PREFIX_FORMAT has an invalid format)"
+      # Return the whole context
+      return context
     end
 
+    # alias info log_info
+    # alias error log_error
+    # alias debug log_debug
+
   end
 end

data/lib/bmc-daemon-lib/logger_pool.rb

@@ -21,11 +21,11 @@ module BmcDaemonLib
       filename = Conf.logfile(pipe)
 
       # Create the logger and return it
-      logger = Logger.new(filename, LOG_ROTATION)   #, 10, 1024000)
+      logger = BmcDaemonLib::Logger.new(filename, LOG_ROTATION)   #, 10, 1024000)
       logger.progname = pipe.to_s.downcase
-      logger.formatter = LoggerFormatter
 
       # Finally return this logger
+      # FIXME logger.datetime_format
       logger
 
     rescue Errno::EACCES

data/lib/bmc-daemon-lib/mq_consumer.rb

@@ -5,9 +5,7 @@ module BmcDaemonLib
   class MqConsumerException          < StandardError; end
 
   class MqConsumer < MqEndpoint
-
     include LoggerHelper
-    attr_reader :logger
 
     def subscribe_to_queue name, context = nil
       log_info "subscribe_to_queue [#{name}]"

data/lib/bmc-daemon-lib/mq_endpoint.rb

@@ -11,14 +11,9 @@ module BmcDaemonLib
 
   class MqEndpoint
     include LoggerHelper
-    attr_reader :logger
 
   protected
 
-    def log_prefix
-      self.class.name.split('::').last
-    end
-
     def log_message msg_way, msg_topic, msg_key, msg_body = [], msg_attrs = {}
       # Message header
       log_info sprintf("%4s %-20s %s", msg_way, msg_topic, msg_key)

data/lib/bmc-daemon-lib/worker_base.rb

@@ -3,12 +3,12 @@ module BmcDaemonLib
     include LoggerHelper
 
     # Class options
-    attr_reader :logger
     attr_reader :pool
     attr_reader :wid
 
     def initialize wid, pool = nil
       # Logger
+      # FIXME log_pipe
       @logger = LoggerPool.instance.get :workers
       @log_worker_status_changes = true
 
@@ -16,8 +16,8 @@ module BmcDaemonLib
       @config = {}
 
       # Set thread context
-      Thread.current.thread_variable_set :pool, (@pool = pool)
       Thread.current.thread_variable_set :wid, (@wid = wid)
+      Thread.current.thread_variable_set :pool, (@pool = pool)
       Thread.current.thread_variable_set :started_at, Time.now
       worker_status WORKER_STATUS_STARTING
 
@@ -28,7 +28,7 @@ module BmcDaemonLib
         # We're ok, let's start out loop
         start_loop
       end
-  end
+    end
 
   protected
 
@@ -42,14 +42,6 @@ module BmcDaemonLib
     def worker_config
     end
 
-    def log_prefix
-     [
-      Thread.current.thread_variable_get(:wid),
-      Thread.current.thread_variable_get(:jid),
-      nil
-      ]
-    end
-
     def start_loop
       log_info "start_loop starting", @config
       loop do
@@ -83,11 +75,6 @@ module BmcDaemonLib
       # end
     end
 
-    def worker_jid jid
-      Thread.current.thread_variable_set :jid, jid
-      Thread.current.thread_variable_set :updated_at, Time.now
-    end
-
     def config_section key
       # Debugging
       @log_worker_status_changes = @debug

data/lib/bmc-daemon-lib.rb

@@ -7,7 +7,7 @@ require "time"
 
 # Project's libs
 require_relative "bmc-daemon-lib/conf"
-require_relative "bmc-daemon-lib/logger_formatter"
+require_relative "bmc-daemon-lib/logger"
 require_relative "bmc-daemon-lib/logger_helper"
 require_relative "bmc-daemon-lib/logger_pool"
 require_relative "bmc-daemon-lib/worker_base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bmc-daemon-lib
 version: !ruby/object:Gem::Version
-  version: 0.3.18
+  version: 0.4.0
 platform: ruby
 authors:
 - Bruno MEDICI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2016-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - bmc-daemon-lib.gemspec
 - lib/bmc-daemon-lib.rb
 - lib/bmc-daemon-lib/conf.rb
+- lib/bmc-daemon-lib/logger.rb
 - lib/bmc-daemon-lib/logger_formatter.rb
 - lib/bmc-daemon-lib/logger_helper.rb
 - lib/bmc-daemon-lib/logger_pool.rb