bmc-daemon-lib 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed9ad3dcff468f9985fead6dee82b410b31c102c
-  data.tar.gz: fc5db932cc62485666498ce1484c71ac777f42b6
+  metadata.gz: cd041b445612d4933a4f5f69ccb0158051892ed7
+  data.tar.gz: 5a4a9aa4dd013fb2369498d46380d5d815ebdaba
 SHA512:
-  metadata.gz: 6292fe5cd270d41d6b623382a54db753c7a8d06d0b0401915db31a1c546647b80eb75eebed309bea110f7c66a3649251e317647d6a90889b8a8b0be131ba4ca9
-  data.tar.gz: ceeb98c78d297955c0ad58dc27cb761067ce12fe49ebea611e3e5fd5bd8edd8d7a7ad6e63bfccd850615e38b0ee96754d681be96c1754a49bd53fa5b441cb077
+  metadata.gz: b98b2147d8abeb9b4f6e5214b363a14142c3beb7feff0d673b5b387a05d395f0b986f06df2735e7ea86b6dcb96c5994b01c5cd3568581a426fa2b4e1d552a813
+  data.tar.gz: 454958f16430d0be771750e5b88244d9619d3eb7e425b9c7f23bdce810fc2988c5ea22d01efc1a5b37d7c43c2c04be16894608009d61fc6ba525142860229d39

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    bmc-daemon-lib (0.1.2)
+    bmc-daemon-lib (0.2.0)
       chamber (~> 2.9)
-      newrelic_rpm
 
 GEM
   remote: https://rubygems.org/
@@ -14,7 +13,6 @@ GEM
       thor (~> 0.19.1)
     diff-lcs (1.2.5)
     hashie (3.4.4)
-    newrelic_rpm (3.16.0.318)
     parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)

data/bmc-daemon-lib.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   # Project version
-  spec.version                      = "0.1.2"
+  spec.version                      = "0.2.0"
 
   # Project description
   spec.name                         = "bmc-daemon-lib"
@@ -27,5 +27,4 @@ Gem::Specification.new do |spec|
 
   # Runtime dependencies
   spec.add_runtime_dependency       "chamber", "~> 2.9"
-  spec.add_runtime_dependency       "newrelic_rpm"
 end

data/lib/bmc-daemon-lib.rb

@@ -1,4 +1,12 @@
+# Global libs
+require "rubygems"
+require "syslog"
+require "thread"
+
+
+# Project's libs
 require_relative "bmc-daemon-lib/conf"
 require_relative "bmc-daemon-lib/logger_formatter"
 require_relative "bmc-daemon-lib/logger_helper"
-# require_relative "bmc-daemon-lib/worker_base"
+require_relative "bmc-daemon-lib/logger_pool"
+require_relative "bmc-daemon-lib/worker_base"

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

@@ -2,6 +2,8 @@
 require "chamber"
 
 module BmcDaemonLib
+  # Class exceptions
+  class ConfigInitiRequired       < StandardError; end
   class ConfigMissingParameter    < StandardError; end
   class ConfigOtherError          < StandardError; end
   class ConfigParseError          < StandardError; end
@@ -53,8 +55,10 @@ module BmcDaemonLib
       # Now we know app_name, initalize app_libs
       @app_libs = File.expand_path("lib/#{@app_name}/", @app_root)
 
+      # By default, Newrelic is disabled
+      ENV["NEWRELIC_AGENT_ENABLED"] = "false"
+
       # Add other config files
-      #add_default_config
       add_config generate(:config_defaults)
       add_config generate(:config_etc)
 
@@ -108,7 +112,7 @@ module BmcDaemonLib
 
     def self.newrelic_enabled?
       ensure_init
-      self[:newrelic] && self[:newrelic][:licence]
+      !! (self[:newrelic] && self[:newrelic][:license])
     end
 
     # Defaults generators
@@ -156,21 +160,16 @@ module BmcDaemonLib
 
     def self.prepare_newrelic section, logfile
       # Disable NewRelic if no config present
-      unless self.newrelic_enabled?
-        ENV["NEWRELIC_AGENT_ENABLED"] = "false"
-        return
-      end
+      return unless self.newrelic_enabled?
 
       # Enable GC profiler
       GC::Profiler.enable
 
-      # Enable module
-      ENV["NEWRELIC_AGENT_ENABLED"] = "true"
+      # Set logfile, license, monitor mode
+      ENV["NEW_RELIC_LOG"] = logfile.to_s if logfile
+      ENV["NEW_RELIC_LICENSE_KEY"] = section[:license].to_s
       ENV["NEW_RELIC_MONITOR_MODE"] = "true"
 
-      # License
-      ENV["NEW_RELIC_LICENSE_KEY"] = section[:licence].to_s
-
       # Build NewRelic app_name if not provided as-is
       if section[:app_name]
         ENV["NEW_RELIC_APP_NAME"] = section[:app_name].to_s
@@ -183,18 +182,22 @@ module BmcDaemonLib
         ENV["NEW_RELIC_APP_NAME"] = "#{text}-#{host};#{text}"
       end
 
-      # Logfile
-      ENV["NEW_RELIC_LOG"] = logfile.to_s if logfile
+      # Enable module
+      ENV["NEWRELIC_AGENT_ENABLED"] = "true"
     end
 
   private
 
     def self.ensure_init
-      # Skip is already done
-      return if @initialized
+      unless @initialized
+        fail ConfigInitiRequired, "ensure_init: Conf.init(app_root) should be invoked beforehand"
+      end
+
+      # # Skip is already done
+      # return if @initialized
 
-      # Go through init if not already done
-      self.init
+      # # Go through init if not already done
+      # self.init
     end
 
   end

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

@@ -39,12 +39,6 @@ module BmcDaemonLib
 
     def build_messages severity, message, details = nil
       messages = []
-      # messages << "/---------------------------------------"
-      # messages << "severity: #{severity}"
-      # messages << "message: #{message.class}"
-      # messages << "details: #{details.class} #{details.inspect}"
-      # messages << "ARRAY(#{details.count})" if details.is_a? Array
-      # messages << "HASH(#{details.count})" if details.is_a? Hash
 
       prefix = build_prefix
 
@@ -62,17 +56,8 @@ module BmcDaemonLib
       end if details.is_a? Hash
 
       # Return all that stuff
-      # messages << "\\---------------------------------------"
       logger.add severity, messages
     end
 
-    # def debug_lines lines, prefix = ''
-    #   if lines.is_a? Array
-    #     logger.debug lines.map{ |line| sprintf(LOG_MESSAGE_ARRAY, prefix, line) }
-    #   elsif lines.is_a? Hash
-    #     logger.debug lines.map{ |key, value| sprintf(LOG_MESSAGE_HASH, prefix, key, value) }
-    #   end
-    # end
-
   end
 end

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

@@ -0,0 +1,61 @@
+require "logger"
+require "singleton"
+
+# Logger interface class to access logger though symbolic names
+module BmcDaemonLib
+  class LoggerPool
+    include Singleton
+
+    def get pipe
+      @loggers ||= {}
+      @loggers[pipe] ||= create(pipe)
+    end
+
+    def create pipe
+      # Compute logfile or STDERR, and declare what we're doing
+      filename = logfile(pipe)
+
+      # Create the logger and return it
+      logger = Logger.new(filename, LOG_ROTATION)   #, 10, 1024000)
+      logger.progname = pipe.to_s.downcase
+      logger.formatter = LoggerFormatter
+
+      # Finally return this logger
+      logger
+
+    rescue Errno::EACCES
+      puts "logging [#{pipe}] failed: access error"
+    end
+
+  protected
+
+    def logfile pipe
+      # Disabled if no valid config
+      return nil unless Conf[:logs].is_a?(Hash)
+
+      # Compute logfile and check if we can write there
+      logfile = File.expand_path(Conf[:logs][pipe].to_s, Conf[:logs][:path].to_s)
+
+      # Check that we'll be able to create logfiles
+      if File.exists?(logfile)
+        # File is there, is it writable ?
+        unless File.writable?(logfile)
+          puts "logging [#{pipe}] disabled: file not writable [#{logfile}]"
+          return nil
+        end
+      else
+        # No file here, can we create it ?
+        logdir = File.dirname(logfile)
+        unless File.writable?(logdir)
+          puts "logging [#{pipe}] disabled: directory not writable [#{logdir}]"
+          return nil
+        end
+      end
+
+      # OK, return a clean file path
+      puts "logging [#{pipe}] to [#{logfile}]"
+      return logfile
+    end
+
+  end
+end

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

@@ -0,0 +1,106 @@
+module BmcDaemonLib
+  class WorkerBase
+    include LoggerHelper
+
+    # Class options
+    attr_reader :logger
+    attr_reader :pool
+    attr_reader :wid
+
+    def initialize wid, pool = nil
+      # Logger
+      @logger = LoggerPool.instance.get :workers
+      @log_worker_status_changes = true
+
+      # Configuration
+      @config = {}
+
+      # Set thread context
+      @pool = pool
+      @wid = wid
+      Thread.current.thread_variable_set :pool, pool
+      Thread.current.thread_variable_set :wid, wid
+      Thread.current.thread_variable_set :started_at, Time.now
+      worker_status WORKER_STATUS_STARTING
+
+      # Ask worker to init itself, and return if there are errors
+      if worker_init_result = worker_init
+        log_error "worker_init aborting: #{worker_init_result.inspect}", @config
+      else
+        # We're ok, let's start out loop
+        start_loop
+      end
+  end
+
+  protected
+
+    # Worker methods prototypes
+    def worker_init
+    end
+    def worker_after
+    end
+    def worker_process
+    end
+    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
+        begin
+          # Do the hard work
+          worker_process
+
+          # Do the cleaning/sleeping stuff
+          worker_after
+
+        rescue StandardError => e
+          log_error "WORKER EXCEPTION: #{e.inspect}"
+          sleep 1
+        end
+      end
+    end
+
+    def worker_status status, job = nil
+      # Update thread variables
+      Thread.current.thread_variable_set :status, status
+      Thread.current.thread_variable_set :updated_at, Time.now
+
+      # Nothin' to log if "silent"
+      return unless @log_worker_status_changes
+
+      # Log this status change
+      if job.is_a?(Job)
+        log_info "status [#{status}] on job[#{job.id}] status[#{job.status}] error[#{job.error}]"
+      else
+        log_info "status [#{status}]"
+      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
+
+      # Set my configuration
+      if (Conf[key].is_a? Hash) && Conf[key]
+        @config = Conf[key]
+      else
+        log_error "missing [#{key}] configuration"
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bmc-daemon-lib
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruno MEDICI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
-- !ruby/object:Gem::Dependency
-  name: newrelic_rpm
-  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'
 description: 'Shared utilities to build a daemon: logger, configuration, helpers'
 email: bmc-daemon-lib@bmconseil.com
 executables: []
@@ -111,6 +97,8 @@ files:
 - lib/bmc-daemon-lib/conf.rb
 - lib/bmc-daemon-lib/logger_formatter.rb
 - lib/bmc-daemon-lib/logger_helper.rb
+- lib/bmc-daemon-lib/logger_pool.rb
+- lib/bmc-daemon-lib/worker_base.rb
 homepage: http://github.com/bmedici/bmc-daemon-lib
 licenses:
 - MIT