service_skeleton 0.0.0.3.g1269800.1.gaaa2fa1 → 0.0.0.3.g1269800.1.gaaa2fa1.6.gf4e308e

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 217daf5c11dec98416acbde668b1dc611aa33858
-  data.tar.gz: df99d97d1611db368e17a970d0306522532ddb82
+  metadata.gz: 18784bb11dd6bbc8127fa41afde5f70bb6eaba45
+  data.tar.gz: cdce481c5d0f3f30d71b4909814cb08fd188591c
 SHA512:
-  metadata.gz: 95be950d0c0d0f3163386eff63509d771b11c279886e28095780836235f78d446a117df2468f3f56c0cdae342febec97398611ed00eb475797afa48dad17307f
-  data.tar.gz: d9c5fb3b6662c245006cb1c7887d6e681ae2c41542aa1f7c5469539b50ff24e277eaf54020a7370d64ae696412ae1699fef8b275c31503eb9f07ed76c7879985
+  metadata.gz: 52fd258fda63cd6f9e6437720dc7b22bde7c8c2de3b5ba8353efdff5c7438de3b215327b82c0c076c16a0a51b451b90f8f2caf49e5df441e4e43482a18b9f6a3
+  data.tar.gz: 5cfebd77c0522f6171b73c71ee4fa0a835c89a085e4b6b42c3ca4264b7aa28c445e782af967b6275efc80d1b32c06c89d670cf92bd7e0d05afcc4a40fed56540

data/README.md

@@ -489,9 +489,6 @@ metrics](https://www.rubydoc.info/gems/frankenstein/Frankenstein/RubyGCMetrics),
 and [Ruby VM
 metrics](https://www.rubydoc.info/gems/frankenstein/Frankenstein/RubyVMMetrics).
 
-If, for some reason, you *don't* want any default metrics in your bundle of
-metrics, call `no_default_metrics` in your service class definition.
-
 
 ### Metrics Server Configuration
 
@@ -520,9 +517,8 @@ behaviours for common signals.
 
 ### Default Signals
 
-Unless told otherwise, by calling the `no_default_signals` class method in your
-service class' definition, the following signals will be hooked with the following
-behaviour:
+When the `#run` method on your service instance is called, the following
+signals will be hooked with the following behaviour:
 
 * **`SIGUSR1`** -- increase the default minimum severity for messages which
   will be emitted by the logger.  The default severity only applies to log

data/lib/service_skeleton/config.rb

@@ -6,7 +6,7 @@ require "loggerstash"
 
 class ServiceSkeleton
   class Config
-    attr_reader :logger
+    attr_reader :logger, :env
 
     def initialize(env, svc)
       @env = env.to_hash.dup.freeze

data/lib/service_skeleton/logging_helpers.rb

@@ -17,5 +17,10 @@ class ServiceSkeleton
         (["#{explanation}#{explanation ? ": " : ""}#{ex.message} (#{ex.class})"] + ex.backtrace).join("\n  ")
       end
     end
+
+    def logloc
+      loc = caller_locations.first
+      "#{self.class}##{loc.label}"
+    end
   end
 end

data/lib/service_skeleton/signal_handler.rb

@@ -84,7 +84,7 @@ class ServiceSkeleton
     end
 
     def start
-      logger.info("SignalHandler#start") { "Starting signal handler with #{@signal_registry.length} hooks" }
+      logger.info(logloc) { "Starting signal handler with #{@signal_registry.length} hooks" }
 
       @r, @w = IO.pipe
 
@@ -95,14 +95,14 @@ class ServiceSkeleton
           if ios = IO.select([@r])
             if ios.first.include?(@r)
               if ios.first.first.eof?
-                logger.info("SignalHandler#run") { "Signal pipe closed; shutting down" }
+                logger.info(logloc) { "Signal pipe closed; shutting down" }
                 break
               else
                 c = ios.first.first.read_nonblock(1)
                 handle_signal(c)
               end
             else
-              logger.error("SignalHandler#run") { "Mysterious return from select: #{ios.inspect}" }
+              logger.error(logloc) { "Mysterious return from select: #{ios.inspect}" }
             end
           end
         rescue StandardError => ex
@@ -127,7 +127,7 @@ class ServiceSkeleton
       handler = @signal_registry[char.ord]
 
       if handler
-        logger.debug("SignalHandler#handle_signal") { "#{handler[:signal]} received" }
+        logger.debug(logloc) { "#{handler[:signal]} received" }
         @signal_counter.increment(signal: handler[:signal].to_s)
         begin
           handler[:callback].call
@@ -135,7 +135,7 @@ class ServiceSkeleton
           log_exception(ex) { "Exception in signal handler" }
         end
       else
-        logger.error("SignalHandler#handle_signal") { "Unrecognised signal character: #{char.inspect}" }
+        logger.error(logloc) { "Unrecognised signal character: #{char.inspect}" }
       end
     end
 

data/lib/service_skeleton.rb

@@ -38,14 +38,17 @@ class ServiceSkeleton
     @logger   = @config.logger
     @op_mutex = Mutex.new
 
-    setup_metrics
-    setup_signals
+    initialize_metrics
+    initialize_signals
   end
 
   def start
     @op_mutex.synchronize { @thread = Thread.current }
 
     begin
+      logger.info(logloc) { "Starting service #{service_name}" }
+      logger.info(logloc) { (["Environment:"] + config.env.map { |k, v| "#{k}=#{v.inspect}" }).join("\n  ") }
+
       start_metrics_server
       start_signal_handler
       run
@@ -112,7 +115,7 @@ class ServiceSkeleton
     #:nocov:
   end
 
-  def setup_metrics
+  def initialize_metrics
     @metrics = Prometheus::Client::Registry.new
 
     Frankenstein::RubyGCMetrics.register(@metrics)
@@ -126,7 +129,7 @@ class ServiceSkeleton
 
   def start_metrics_server
     if config.metrics_port
-      logger.info(self.class.to_s) { "Starting metrics server on port #{config.metrics_port}" }
+      logger.info(logloc) { "Starting metrics server on port #{config.metrics_port}" }
 
       @metrics_server = Frankenstein::Server.new(
         port: config.metrics_port,
@@ -138,8 +141,9 @@ class ServiceSkeleton
     end
   end
 
-  def setup_signals
-    @signal_handler = ServiceSkeleton::SignalHandler.new(logger: logger, service: self, signal_counter: metrics.counter(:"#{self.service_name}_signals_handled_total", "How many of each type of signal have been handled"))
+  def initialize_signals
+    metrics.counter(:"#{self.service_name}_signals_handled_total", "How many of each type of signal have been handled")
+    @signal_handler = ServiceSkeleton::SignalHandler.new(logger: logger, service: self, signal_counter: metrics.signals_handled_total)
 
     @signal_handler.hook_signal("USR1") do
       logger.level -= 1 unless logger.level == Logger::DEBUG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.3.g1269800.1.gaaa2fa1
+  version: 0.0.0.3.g1269800.1.gaaa2fa1.6.gf4e308e
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-17 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein