service_skeleton 0.0.0.3.g1269800 → 0.0.0.3.g1269800.1.gaaa2fa1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f7ce2f282a5da9818948a40ec390c7c5cb13f0
-  data.tar.gz: 83fa2415988d4c7ec93098be26424cbd73dc5ee3
+  metadata.gz: 217daf5c11dec98416acbde668b1dc611aa33858
+  data.tar.gz: df99d97d1611db368e17a970d0306522532ddb82
 SHA512:
-  metadata.gz: 81fb4b71d9a0c17264dc11721df78b720d35e0fbdcc9c8ece31c223571d72e3f9c825fe96ef5c4c0ed8877b11d86bef9c0132c9557f963f5aa8a6b559b10b920
-  data.tar.gz: ec0db152836431cf3891de6802fda44b0dc4816f352fae76a897059f15badf7bc98f1f468e5b44942846c0489a8e3816dbcfdeed506abe5af71b3d83605b1df9
+  metadata.gz: 95be950d0c0d0f3163386eff63509d771b11c279886e28095780836235f78d446a117df2468f3f56c0cdae342febec97398611ed00eb475797afa48dad17307f
+  data.tar.gz: d9c5fb3b6662c245006cb1c7887d6e681ae2c41542aa1f7c5469539b50ff24e277eaf54020a7370d64ae696412ae1699fef8b275c31503eb9f07ed76c7879985

data/README.md

@@ -304,6 +304,10 @@ using Unix signals or the admin HTTP interface (if enabled), you can tell the
 logger to increase or decrease logging verbosity *without interrupting
 service*.  We are truly living in the future.
 
+Finally, if you're a devotee of the ELK stack, we can automagically send log
+entries straight into logstash, rather than you having to do it in some
+more roundabout fashion.
+
 
 ### Logging Configuration
 
@@ -342,6 +346,15 @@ All are all-uppercase, and the `<SERVICENAME>_` portion is the all-uppercase
   Logging levels can be changed at runtime, via [signals](#default-signals) or
   [the HTTP admin interface](#http-admin-interface).
 
+* **`<SERVICENAME>_LOGSTASH_SERVER`** (string; default `""`) -- if set to a
+  non-empty string, we will engage the services of the [loggerstash
+  gem](https://github.com/discourse/loggerstash) on your behalf to send all log
+  entries to the logstash server you specify (as [an `address:port`,
+  `hostname:port`, or SRV
+  record](https://github.com/discourse/logstash_writer#usage).  Just be sure
+  and [configure logstash
+  appropriately](https://github.com/discourse/loggerstash#logstash-configuration).
+
 * **`<SERVICENAME>_LOG_ENABLE_TIMESTAMPS`** (boolean; default: `"no"`) -- if
   set to a true-ish value (`yes`/`y`/`on`/`true`/`1`), then the log entries
   emitted by the logger will have the current time (to the nearest nanosecond)

data/lib/service_skeleton/config.rb

@@ -2,12 +2,14 @@ require "to_regexp"
 
 require_relative "./filtering_logger"
 
+require "loggerstash"
+
 class ServiceSkeleton
   class Config
     attr_reader :logger
 
     def initialize(env, svc)
-      @env = env.to_hash.freeze
+      @env = env.to_hash.dup.freeze
       @svc = svc
 
       parse_registered_variables(env)
@@ -46,6 +48,12 @@ class ServiceSkeleton
 
       @logger = Logger.new(log_file || $stderr, shift_age, shift_size)
 
+      if self.logstash_server && !self.logstash_server.empty?
+        loggerstash = Loggerstash.new(logstash_server: logstash_server, logger: @logger)
+        loggerstash.metrics_registry = @svc.metrics
+        loggerstash.attach(@logger)
+      end
+
       if log_enable_timestamps
         @logger.formatter = ->(s, t, p, m) { "#{t.utc.strftime("%FT%T.%NZ")} #{s[0]} [#{p}] #{m}\n" }
       else

data/lib/service_skeleton.rb

@@ -63,11 +63,13 @@ class ServiceSkeleton
 
   def stop(force = false)
     if force
+      #:nocov:
       @op_mutex.synchronize do
         if @thread
           @thread.raise(ServiceSkeleton::Terminate)
         end
       end
+      #:nocov:
     else
       shutdown
     end
@@ -99,6 +101,7 @@ class ServiceSkeleton
   end
 
   def shutdown
+    #:nocov:
     @op_mutex.synchronize do
       if @thread
         @thread.raise(ServiceSkeleton::Terminate)
@@ -106,6 +109,7 @@ class ServiceSkeleton
         @thread = nil
       end
     end
+    #:nocov:
   end
 
   def setup_metrics
@@ -135,7 +139,7 @@ class ServiceSkeleton
   end
 
   def setup_signals
-    @signal_handler = ServiceSkeleton::SignalHandler.new(logger: logger, service: self, signal_counter: metrics.counter(:"#{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.counter(:"#{self.service_name}_signals_handled_total", "How many of each type of signal have been handled"))
 
     @signal_handler.hook_signal("USR1") do
       logger.level -= 1 unless logger.level == Logger::DEBUG
@@ -173,6 +177,7 @@ class ServiceSkeleton
 
   @registered_variables = [
     ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_LEVEL) { "INFO" },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOGSTASH_SERVER) { "" },
     ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_ENABLE_TIMESTAMPS) { false },
     ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_FILE) { nil },
     ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_MAX_FILE_SIZE) { 1048576 },
@@ -182,6 +187,7 @@ class ServiceSkeleton
 
   def self.inherited(subclass)
     subclass.string(:"#{subclass.service_name.upcase}_LOG_LEVEL", default: "INFO")
+    subclass.string(:"#{subclass.service_name.upcase}_LOGSTASH_SERVER", default: "")
     subclass.boolean(:"#{subclass.service_name.upcase}_LOG_ENABLE_TIMESTAMPS", default: false)
     subclass.string(:"#{subclass.service_name.upcase}_LOG_FILE", default: nil)
     subclass.integer(:"#{subclass.service_name.upcase}_LOG_MAX_FILE_SIZE", default: 1048576, range: 0..Float::INFINITY)

data/service_skeleton.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.3.0"
 
   s.add_runtime_dependency "frankenstein", "~> 1.2"
+  s.add_runtime_dependency "loggerstash", "~> 0.0"
   # prometheus-client provides no guaranteed backwards compatibility,
   # and in fact happily breaks things with no notice, so we're stuck
   # with hard-coding a specific version to avoid unexpected disaster.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.3.g1269800
+  version: 0.0.0.3.g1269800.1.gaaa2fa1
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: loggerstash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement