loggerstash 0.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f2945f9572e10047201fc9b3ac4422923e8b58b
-  data.tar.gz: 7652bff72a6bb80fe20fcfd1d6ffe7c55679bc8f
+SHA256:
+  metadata.gz: 2d39439e76c2953faa8dace7d2fe630d79f9e492ff206ebc1631417993fd191a
+  data.tar.gz: 0bf51ec28020039b3ae864a03be3403caa7c2d84c73b236f003184827c37a1c2
 SHA512:
-  metadata.gz: 3c2c0be50c3a3706dca83b4e7b26c549f920c41c88fb73d0e397c1b5aa5ff99d9d89057d15d5a2adff18b3f4043b835e8a4a4474c69dc34e78a712ff3b20114e
-  data.tar.gz: 81d0b3da5b0ccabd57f6beaa74b43b993f33b11a23a1b2b9bb9aa3b96362043aca95626d3c0bf71ce0ad52021ce74fac3e0e1627a8bb95cca186f175098b3e6d
+  metadata.gz: efe6185c0427be6761ae1661e64d288667d91e6cb00fa1fbb276d942216fdd7e14ada8d8122523b64c51d542ca8e26303b1ec94d3d978122ca452371b90d9e16
+  data.tar.gz: 393bfa2235d52e84fac15bab45229e80c9e5b3264e67d23078f09540a47343102d7c4e3e2cf87f7242d89d2e0bf5574e4b456f78cccde39cec7a74aae72c1da5

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/.github/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - 3.0
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Lint
+        run: bundle exec rubocop
+
+      - name: Tests
+        run: bundle exec rake test
+
+  publish:
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: discourse/publish-rubygems-action@v2-beta
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/.gitignore

@@ -1,7 +1,2 @@
 Gemfile.lock
-/pkg
-/doc
-/.yardoc
 /coverage
-/.bundle
-/tmp

data/.rubocop.yml

@@ -1,116 +1,2 @@
-AllCops:
-  TargetRubyVersion: 2.4
-  DisabledByDefault: true
-  Exclude:
-    - 'db/schema.rb'
-    - 'bundle/**/*'
-    - 'vendor/**/*'
-    - 'node_modules/**/*'
-    - 'public/**/*'
-
-# Prefer &&/|| over and/or.
-Style/AndOr:
-  Enabled: true
-
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
-  Enabled: true
-
-# Align `when` with `case`.
-Layout/CaseIndentation:
-  Enabled: true
-
-# Align comments with method definitions.
-Layout/CommentIndentation:
-  Enabled: true
-
-# No extra empty lines.
-Layout/EmptyLines:
-  Enabled: true
-
-# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
-Style/HashSyntax:
-  Enabled: true
-
-# Two spaces, no tabs (for indentation).
-Layout/IndentationWidth:
-  Enabled: true
-
-Layout/SpaceAfterColon:
-  Enabled: true
-
-Layout/SpaceAfterComma:
-  Enabled: true
-
-Layout/SpaceAroundEqualsInParameterDefault:
-  Enabled: true
-
-Layout/SpaceAroundKeyword:
-  Enabled: true
-
-Layout/SpaceAroundOperators:
-  Enabled: true
-
-Layout/SpaceBeforeFirstArg:
-    Enabled: true
-
-# Defining a method with parameters needs parentheses.
-Style/MethodDefParentheses:
-  Enabled: true
-
-# Use `foo {}` not `foo{}`.
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Use `foo { bar }` not `foo {bar}`.
-Layout/SpaceInsideBlockBraces:
-  Enabled: true
-
-# Use `{ a: 1 }` not `{a:1}`.
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-
-Layout/SpaceInsideParens:
-  Enabled: true
-
-# Detect hard tabs, no hard tabs.
-Layout/Tab:
-  Enabled: true
-
-# Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
-  Enabled: true
-
-# No trailing whitespace.
-Layout/TrailingWhitespace:
-  Enabled: true
-
-Lint/Debugger:
-  Enabled: true
-
-Layout/BlockAlignment:
-  Enabled: true
-
-# Align `end` with the matching keyword or starting expression except for
-# assignments, where it should be aligned with the LHS.
-Layout/EndAlignment:
-  Enabled: true
-  EnforcedStyleAlignWith: variable
-
-# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
-Lint/RequireParentheses:
-  Enabled: true
-
-Lint/ShadowingOuterLocalVariable:
-  Enabled: true
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Layout/AlignHash:
-  Enabled: true
-
-Bundler/OrderedGems:
-  Enabled: false
+inherit_gem:
+  rubocop-discourse: default.yml

data/CONTRIBUTING.md

@@ -1,5 +1,5 @@
 * If, heaven forbid, you find a security vulnerability, please e-mail
-  `matt.palmer@discourse.org`.
+  `security@discourse.org`.
 
 * If you have found a discrepancy in documented and observed behaviour, that
   is a bug.  Feel free to [report it as an

data/README.md

@@ -135,7 +135,7 @@ conduct](CODE_OF_CONDUCT.md).
 Unless otherwise stated, everything in this repo is covered by the following
 copyright notice:
 
-    Copyright (C) 2018  Civilized Discourse Construction Kit, Inc.
+    Copyright (C) 2018-2021  Civilized Discourse Construction Kit, Inc.
 
     This program is free software: you can redistribute it and/or modify it
     under the terms of the GNU General Public License version 3, as

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,68 +87,25 @@ 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
-      {
-        "@timestamp":  t.utc.strftime("%FT%T.%NZ"),
-        "@metadata":   { event_type: "loggerstash" },
-        message:       m,
-        severity_name: s.downcase,
-        hostname:      Socket.gethostname,
-        pid:           $$,
-      }.tap do |ev|
-        ev[:progname] = p if p
       end
     end
   end
@@ -155,26 +113,41 @@ class Loggerstash
   # 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,
@@ -183,5 +156,53 @@ class Loggerstash
         end
       end
     end
+
+    # Mangle the standard sev/time/prog/msg set into a logstash event.
+    #
+    # Caller information is a https://www.rubydoc.info/stdlib/core/Thread/Backtrace/Location
+    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" },
+          ecs: {
+            version: "1.8"
+          },
+          message: m,
+          log: {
+            level: s.downcase,
+            logger: "Loggerstash",
+            origin: {
+              base_function: caller.base_label, # not in ECS
+              file: {
+                line: caller.lineno,
+                name: caller.absolute_path,
+              },
+              function: caller.label,
+            },
+          },
+          host: {
+            hostname: Socket.gethostname,
+          },
+          process: {
+            pid: $$,
+            thread: {
+              id: Thread.current.object_id,
+            },
+          },
+        }.tap do |ev|
+          ev[:process][:name] = p if p
+          ev[:process][: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,15 +1,9 @@
-begin
-  require 'git-version-bump'
-rescue LoadError
-  nil
-end
+# frozen_string_literal: true
 
 Gem::Specification.new do |s|
   s.name = "loggerstash"
 
-  s.version = GVB.version rescue "0.0.0.1.NOGVB"
-  s.date    = GVB.date    rescue Time.now.strftime("%Y-%m-%d")
-
+  s.version = "1.1.0"
   s.platform = Gem::Platform::RUBY
 
   s.summary  = "Monkeypatch Logger to send log entries to logstash"
@@ -19,26 +13,24 @@ Gem::Specification.new do |s|
     however the message would have been handled otherwise.
   EOF
 
-  s.authors  = ["Matt Palmer"]
-  s.email    = ["matt.palmer@discourse.org"]
+  s.authors  = ["Michael Brown"]
+  s.email    = ["michael.brown@discourse.org"]
   s.homepage = "https://github.com/discourse/loggerstash"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
 
-  s.required_ruby_version = ">= 2.3.0"
+  s.required_ruby_version = ">= 2.5.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'
-  s.add_development_dependency 'git-version-bump'
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rubocop'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rake', "~> 12.0"
+  s.add_development_dependency 'rake', "~> 13.0"
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop-discourse'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
 end

metadata

@@ -1,59 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: loggerstash
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.1.0
 platform: ruby
 authors:
-- Matt Palmer
+- Michael Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-17 00:00:00.000000000 Z
+date: 2021-03-11 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'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: github-release
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.0.11
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
-  name: git-version-bump
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -114,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-discourse
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -197,20 +169,20 @@ description: |
   it to send all logged entries to a Logstash server, in addition to
   however the message would have been handled otherwise.
 email:
-- matt.palmer@discourse.org
+- michael.brown@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENCE
 - README.md
-- lib/filtered_debug_logger.rb
 - lib/loggerstash.rb
 - loggerstash.gemspec
 homepage: https://github.com/discourse/loggerstash
@@ -224,15 +196,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Monkeypatch Logger to send log entries to logstash

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-
-rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.7
-
-gemfile:
-  - Gemfile

data/lib/filtered_debug_logger.rb

@@ -1,42 +0,0 @@
-require 'logger'
-
-# Filter debug-level log entries on progname
-#
-# Whilst well-thought-out debug logs are fantastic at showing you the
-# fine-level detail of your program's execution, they can sometimes be
-# "too much of a good thing".  Excessively verbose debug logs can obscure
-# the important debug info, and turning on debug logging on a busy service
-# can quickly swamp all but the most overprovisioned of log aggregation
-# systems.
-#
-# Hence, there's this little module.  Require it in your program, and then
-# set `logger.permitted_prognames = ['some', 'array']` on whatever logger
-# is likely to want some debug logging.  Then, whenever debug logging is
-# enabled, only those calls to `logger.debug` which provide a progname exactly
-# matching an entry in the list you provided will actually get logged.
-#
-module FilteredDebugLogger
-  # Set the list of prognames to log debug messages for.
-  #
-  # @param l [Array<String>] the (exact) prognames to log debug-level messages
-  #   for.  If it's not in this list, it doesn't get emitted, even if debug
-  #   logging is enabled.
-  #
-  def permitted_prognames=(l)
-    raise ArgumentError, "Must provide an array" unless l.is_a?(Array)
-
-    @permitted_prognames = l
-  end
-
-  # Decorate Logger#add with our "reject by progname" logic.
-  #
-  def add(s, m = nil, p = nil)
-    return if s == Logger::DEBUG && @permitted_prognames && !@permitted_prognames.include?(p)
-
-    super
-  end
-
-  alias log add
-end
-
-Logger.prepend(FilteredDebugLogger)