loggerstash 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8eb55e42f97396acbdf11494af9948941bb8736c4726287c3b762869a82b28b
-  data.tar.gz: 618b63be291e7bbe849c67d80294f26bc52663a1b23f5e93fe2553e1f48703ea
+  metadata.gz: f20d5ce8da4dbfec707d7b7ccd2dd6dba95a7f911980c3c4791e342a290034c0
+  data.tar.gz: 5a335fdc5d9632439e9d75b3e141b5e09123b2de8d233acf70da8d5efee52a0c
 SHA512:
-  metadata.gz: 9ca77a67d2b5ac773e75aa016e0019e521e085643d39b20fc5b458aaf927245b8c6b43898c8b73b621f0ee66b1d0592265806443d6367822e189fea0f700f0f8
-  data.tar.gz: c207d626c99a6eb3caed82493ba5e5c24550df36916c28169c2fcbc74e1ad179274baca8136d395f3e955e0f73b8c1dd52c91b928b2ebd29a1b0b8252a5547f2
+  metadata.gz: a1e713734296868661da7ee81e9487dbce2173d41353abd9f9b665cb21e363d16929082fa1e4d5ab1c29b26075b7ae0126e9eaaec8c43b5dd57c57004084fc5b
+  data.tar.gz: 2402ff129f1e76086a2f4c51bdc026f4a0a180b526644c70dd6ec7b595ef9e9324dc8c1852a36356a8a41c44c748cab170a0c0d1b102b74e207943e4aad95579

data/.editorconfig

@@ -0,0 +1,7 @@
+[*.rb]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true

data/.rubocop.yml

@@ -1 +1,4 @@
 inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+
+Layout/AlignHash:
+  Enabled: false

data/lib/loggerstash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logstash_writer'
 require 'thread'
 
@@ -14,31 +16,29 @@ class Loggerstash
   #
   class AlreadyRunningError < Error; end
 
-  # Set the formatter proc to a new proc.
-  #
-  # The passed in proc must take four arguments: `severity`, `timestamp`,
-  # `progname` and `message`.  `timestamp` is a `Time`, all over arguments
-  # are `String`s, and `progname` can possibly be `nil`.  It must return a
-  # Hash containing the parameters you wish to send to logstash.
-  #
-  attr_writer :formatter
-
   # A new Loggerstash!
   #
   # @param logstash_server [String] an address:port, hostname:port, or srvname
   #   to which a `json_lines` logstash connection can be made.
+  #
   # @param metrics_registry [Prometheus::Client::Registry] where the metrics
   #   which are used by the underlying `LogstashWriter` should be registered,
   #   for later presentation by the Prometheus client.
+  #
   # @param formatter [Proc] a formatting proc which takes the same arguments
   #   as the standard `Logger` formatter, but rather than emitting a string,
   #   it should pass back a Hash containing all the fields you wish to send
   #   to logstash.
+  #
   # @param logstash_writer [LogstashWriter] in the event that you've already
   #   got a LogstashWriter instance configured, you can pass it in here.  Note
   #   that any values you've set for logstash_server and metrics_registry
   #   will be ignored.
   #
+  # @param logger [Logger] passed to the LogstashWriter we create.  May or
+  #   may not, itself, be attached to the Loggerstash for forwarding to
+  #   logstash (Logception!).
+  #
   def initialize(logstash_server:, metrics_registry: nil, formatter: nil, logstash_writer: nil, logger: nil)
     @logstash_server  = logstash_server
     @metrics_registry = metrics_registry
@@ -61,20 +61,21 @@ class Loggerstash
   #   benefit from the attachment; that's up to you to ensure.
   #
   def attach(obj)
+    run_writer
+
     @op_mutex.synchronize do
-      obj.instance_variable_set(:@loggerstash, self)
+      obj.instance_variable_set(:@logstash_writer, @logstash_writer)
+      obj.instance_variable_set(:@loggerstash_formatter, @formatter)
 
       if obj.is_a?(Module)
         obj.prepend(Mixin)
       else
         obj.singleton_class.prepend(Mixin)
       end
-
-      run_writer
     end
   end
 
-  %i{logstash_server metrics_registry}.each do |sym|
+  %i{formatter logger logstash_server metrics_registry}.each do |sym|
     define_method(:"#{sym}=") do |v|
       @op_mutex.synchronize do
         if @logstash_writer
@@ -86,111 +87,67 @@ class Loggerstash
     end
   end
 
-  # Send a logger message to logstash.
-  #
-  # @private
-  #
-  def log_message(s, t, p, m)
-    @op_mutex.synchronize do
-      if @logstash_writer.nil?
-        #:nocov:
-        run_writer
-        #:nocov:
-      end
-
-      @logstash_writer.send_event((@formatter || default_formatter).call(s, t, p, m))
-    end
-  end
-
   private
 
   # Do the needful to get the writer going.
   #
-  # This will error out unless the @op_mutex is held at the time the
-  # method is called; we can't acquire it ourselves because some calls
-  # to run_writer already need to hold the mutex.
-  #
   def run_writer
-    unless @op_mutex.owned?
-      #:nocov:
-      raise RuntimeError,
-            "Must call run_writer while holding @op_mutex"
-      #:nocov:
-    end
-
-    if @logstash_writer.nil?
-      {}.tap do |opts|
-        opts[:server_name] = @logstash_server
-        if @metrics_registry
-          opts[:metrics_registry] = @metrics_registry
-        end
-        if @logger
-          opts[:logger] = @logger
+    @op_mutex.synchronize do
+      if @logstash_writer.nil?
+        {}.tap do |opts|
+          opts[:server_name] = @logstash_server
+          if @metrics_registry
+            opts[:metrics_registry] = @metrics_registry
+          end
+          if @logger
+            opts[:logger] = @logger
+          end
+
+          @logstash_writer = LogstashWriter.new(**opts)
+          @logstash_writer.start!
         end
-
-        @logstash_writer = LogstashWriter.new(**opts)
-        @logstash_writer.run
       end
     end
   end
 
-  # Mangle the standard sev/time/prog/msg set into a minimal logstash
-  # event.
-  #
-  def default_formatter
-    @default_formatter ||= ->(s, t, p, m) do
-      caller = caller_locations.find { |loc| ! [__FILE__, logger_filename].include? loc.absolute_path }
-
-      {
-        "@timestamp":  t.utc.strftime("%FT%T.%NZ"),
-        "@metadata":   { event_type: "loggerstash" },
-        message:       m,
-        severity_name: s.downcase,
-        hostname:      Socket.gethostname,
-        pid:           $$,
-        thread_id:     Thread.current.object_id,
-        caller:        {
-          absolute_path: caller.absolute_path,
-          base_label:    caller.base_label,
-          label:         caller.label,
-          lineno:        caller.lineno,
-          path:          caller.path,
-        },
-      }.tap do |ev|
-        ev[:progname] = p if p
-      end
-    end
-  end
-
-  # Identify the absolute path of the file that defines the Logger class.
-  #
-  def logger_filename
-    @logger_filename ||= Logger.instance_method(:format_message).source_location.first
-  end
-
   # The methods needed to turn any Logger into a Loggerstash Logger.
   #
   module Mixin
+    attr_writer :logstash_writer, :loggerstash_formatter
+
     private
 
     # Hooking into this specific method may seem... unorthodox, but
     # it seemingly has an extremely stable interface and is the most
     # appropriate place to inject ourselves.
+    #
     def format_message(s, t, p, m)
-      loggerstash.log_message(s, t, p, m)
+      loggerstash_log_message(s, t, p, m)
 
       super
     end
 
-    # Find where our associated Loggerstash object is being held captive.
+    # Send a logger message to logstash.
+    #
+    def loggerstash_log_message(s, t, p, m)
+      logstash_writer.send_event(loggerstash_formatter.call(s, t, p, m))
+    end
+
+    # The current formatter for logstash-destined messages.
+    #
+    def loggerstash_formatter
+      @loggerstash_formatter ||= self.class.ancestors.find { |m| m.instance_variable_defined?(:@loggerstash_formatter) }.instance_variable_get(:@loggerstash_formatter) || default_loggerstash_formatter
+    end
+
+    # Find the relevant logstash_writer for this Logger.
     #
     # We're kinda reimplementing Ruby's method lookup logic here, but there's
     # no other way to store our object *somewhere* in the object + class
     # hierarchy and still be able to get at it from a module (class variables
-    # don't like being accessed from modules).
-    #
-    def loggerstash
-      ([self] + self.class.ancestors).find { |m| m.instance_variable_defined?(:@loggerstash) }.instance_variable_get(:@loggerstash).tap do |ls|
+    # don't like being accessed from modules).  This is necessary because you
+    # can attach Loggerstash to the Logger class, not just to an instance.
+    def logstash_writer
+      @logstash_writer ||= self.class.ancestors.find { |m| m.instance_variable_defined?(:@logstash_writer) }.instance_variable_get(:@logstash_writer).tap do |ls|
         if ls.nil?
           #:nocov:
           raise RuntimeError,
@@ -199,5 +156,40 @@ class Loggerstash
         end
       end
     end
+
+    # Mangle the standard sev/time/prog/msg set into a logstash
+    # event.
+    #
+    def default_loggerstash_formatter
+      ->(s, t, p, m) do
+        caller = caller_locations.find { |loc| ! [__FILE__, logger_filename].include? loc.absolute_path }
+
+        {
+          "@timestamp":  t.utc.strftime("%FT%T.%NZ"),
+          "@metadata":   { event_type: "loggerstash" },
+          message:       m,
+          severity_name: s.downcase,
+          hostname:      Socket.gethostname,
+          pid:           $$,
+          thread_id:     Thread.current.object_id,
+          caller:        {
+            absolute_path: caller.absolute_path,
+            base_label:    caller.base_label,
+            label:         caller.label,
+            lineno:        caller.lineno,
+            path:          caller.path,
+          },
+        }.tap do |ev|
+          ev[:progname]    = p if p
+          ev[:thread_name] = Thread.current.name if Thread.current.name
+        end
+      end
+    end
+
+    # Identify the absolute path of the file that defines the Logger class.
+    #
+    def logger_filename
+      @logger_filename ||= Logger.instance_method(:format_message).source_location.first
+    end
   end
 end

data/loggerstash.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'git-version-bump'
 rescue LoadError
@@ -27,7 +29,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.3.0"
 
-  s.add_runtime_dependency "logstash_writer", "~> 0.0"
+  s.add_runtime_dependency "logstash_writer", ">= 0.0.11"
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'github-release'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: loggerstash
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash_writer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -202,6 +202,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -230,8 +231,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Monkeypatch Logger to send log entries to logstash