yeti_logger 3.0.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3e5e9a8554d3123f83bd27c2cefe1663025fa9b9
-  data.tar.gz: 8f79e414571cbc0c5815eb5ce888892be8114231
+SHA256:
+  metadata.gz: f58be8ecadfe9be95d8517795d6d28b68d3c870957f73477e9a9780c78089c9d
+  data.tar.gz: b693a3f73e811f9f2d773755d05339b083517bbf288dcb96cf7c2710819ce326
 SHA512:
-  metadata.gz: 3fa2b8fedb91ee5f6cb0d0dcf41b4219cc16a5c98092c574ee55576d2c1ad9e0ce702c2d6e05c87af6445fbf80016e8f4e9134afc0d210a7554728fc8e99432a
-  data.tar.gz: 61e988b8d18bc89954b49cbd49a6d4d288280bc53312f9507f15e7404ac3e828f0fd433548599005ca49f8136c41caf02c47db2bdafb12f230dc65ae0823ebf4
+  metadata.gz: '010960813b5a5cabea56c2299a692a5111682a330262350bd68da570c435ca9a61cfcdf79ff66c20c18424a596179ea2423681d3acb42262ce35d61b4e3db45f'
+  data.tar.gz: 5f1a528a27bbc3b851c4980f3fe5af6c135a37874da3744c9a958488b351fa41e772725241204d87e61f4e946de96814defd08ddafa26e15ac9bdade103c5b3c

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,4 +1,20 @@
 # yeti_logger changelog
 
+## v3.3.2
+- CustomFormatter does not include timestamp in log in production and staging environments
+
+## v3.3.1
+- CustomFormatter uses Time.now instead of Time.now.utc
+
+## v3.3.0
+- Add custom rails logger formatter
+
+## v3.2.0
+- Added configuration to override debug logging for specific users
+
+## v3.1.0
+- Added `YetiLogger::TestHelper.expect_to_not_see_log_message[s]` for testing
+  that given messages were not logged at the given log level.
+
 ## v3.0.0
 - First public release

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
+if RUBY_VERSION < '2.2.2'
+  gem 'activesupport', '< 5'
+end
+
 # Specify your gem's dependencies in yeti_logger.gemspec
 gemspec

data/README.md

@@ -2,7 +2,8 @@
 
 Provides standardized logging across Yesware apps.
 
-[![Build Status](https://travis-ci.org/Yesware/yeti_logger.svg?branch=master)](https://travis-ci.org/Yesware/yeti_logger)
+[![Ruby](https://github.com/Yesware/yeti_logger/actions/workflows/ruby.yml/badge.svg?branch=master)](https://github.com/Yesware/yeti_logger/actions/workflows/ruby.yml)
+
 
 ## Installation
 
@@ -105,6 +106,17 @@ is a hash, then the exception in injected into the hash and printed as
 additional `key=value` pairs. Classname, message and backtrace are included in
 the message.
 
+### Custom formatter
+To add a set of tags to every log output by the underlying logger, initialize
+`YetiLogger::CustomFormatter` and assign it to your logger's formatter. Pass a
+hash to the initializer mapping the name of the tags to the proc that evaluates
+to their value. The procs are evaluated lazily when the log generated.
+
+    Rails.logger.formatter = CustomFormatter.new({
+                                                "thread_id": -> { Thread.current.object_id.to_s(36) },
+                                                "trace_id": -> { OpenTelemetry::Trace.current_span ? OpenTelemetry::Trace.current_span.context.hex_trace_id : "0" },
+                                                })
+
 ### Nested Hashes
 
 For hash logging, each key and value are converted to strings which means
@@ -118,6 +130,25 @@ this behavior, pass in the serialized format for the hash, such as:
     log_info { hash.to_s }
     log_info { hash.to_my_log_format }
 
+### Override Debug Logging Level
+
+
+You can configure conditions under which to override the app-wide log level for `log_debug` calls, so that it emit logs from `log_debug` calls even if the app's log level is configured as `info` or higher. For example, using  the [settings-in-redis gem](https://github.com/Yesware/settings-in-redis), you can specify user IDs in `Settings.extra_logging_user_ids` so that if the log hash contains those user IDs in its `user_id` key, we'll log at `info` level instead:
+
+```ruby
+YetiLogger.configure do |config|
+  def config.promote_debug_to_info?(log_hash)
+    Settings.extra_logging_user_ids.is_a?(Array) &&
+    log_hash.is_a?(Hash) &&
+    log_hash.with_indifferent_access[:user_id].to_i.in?(Settings.extra_logging_user_ids)
+  end
+end
+```
+
+In this example, the user ID is taken from the `user_id` key of the log payload, so this won't work with the block syntax.
+
+This feature enables us to get more logging for (and hence more insight into) specific users who are experiencing problems, without hardcoding user IDs or increasing the overall log volume with logs we're not interested in. Depending on your configuration, you may avoid setting environment variables and restarting the app too.
+
 ## Test Support
 
 There are a couple helpers provided to support testing of YetiLogger calls. All

data/lib/yeti_logger/custom_formatter.rb

@@ -0,0 +1,34 @@
+# CustomFormatter is a custom Rails log formatter.
+# It has support for adding arbitrary tags to every log created by the Rails logger.
+# Tag values are generated at log creation time.
+class YetiLogger::CustomFormatter
+  # @param tags [Hash] - maps names of tags to procs that return their value.
+  def initialize(tags = {})
+    super()
+    @tags = tags
+  end
+
+  # @param tags [Hash] - maps names of tags to procs that return their value
+  def add_tags(tags)
+    @tags.merge!(tags)
+  end
+
+  # @param severity [String]
+  # @param time [Time] unused
+  # @param progname [String] unused
+  # @param msg [String] - log body
+  def call(severity, time, progname, msg)
+    timestamp = %w(production staging).include?(ENV['RAILS_ENV']) ? "" : "#{Time.now.iso8601(3)} "
+    pid = Process.pid
+    msg = msg.inspect unless msg.is_a?(String)
+    msg = "#{msg}\n" unless msg[-1] == ?\n
+    log_str = "#{timestamp}pid=#{pid}"
+
+    tag_str = @tags.map { |k, v|
+      value = v.call
+      "#{k}=#{value}" unless value.to_s.empty?
+    }.compact.join(' ')
+
+    "#{log_str}#{tag_str.empty? ? '' : ' ' + tag_str} [#{severity}] - #{msg}"
+  end
+end

data/lib/yeti_logger/test_helper.rb

@@ -24,17 +24,7 @@ module YetiLogger::TestHelper
 
   # Plural version of above
   def expect_to_see_log_messages(messages, level = :debug, &block)
-    log_messages = []
-
-    allow(YetiLogger.logger).to receive(level) do |log_line|
-      log_messages << log_line
-    end
-
-    block.call
-
-    # There is no unstub in rspec 3, but the closest to that would be to
-    # continue to stub it, but defer to the original implementation.
-    allow(YetiLogger.logger).to receive(level).and_call_original
+    log_messages = get_log_messages(level, &block)
 
     # Find each message, removing the first occurrence.
     messages.each do |message|
@@ -54,6 +44,47 @@ module YetiLogger::TestHelper
     end
   end
 
+  # Execute a block and ensure that the supplied log message is not among the
+  # messages logged at the specified level.
+  def expect_to_not_see_log_message(message, level = :debug, &block)
+    expect_to_not_see_log_messages([message], level, &block)
+  end
+
+  # Plural version of above
+  def expect_to_not_see_log_messages(messages, level = :debug, &block)
+    log_messages = get_log_messages(level, &block)
+
+    found = messages.find do |message|
+      if message.is_a?(Regexp)
+        log_messages.find do |log_message|
+          log_message =~ message
+        end
+      else
+        log_messages.include?(message)
+      end
+    end
+
+    if found.present?
+      fail "Should not have found #{found.inspect} amongst #{log_messages.inspect}"
+    end
+  end
+
+  def get_log_messages(level = :debug, &block)
+    log_messages = []
+
+    allow(YetiLogger.logger).to receive(level) do |log_line|
+      log_messages << log_line
+    end
+
+    block.call
+
+    # There is no unstub in rspec 3, but the closest to that would be to
+    # continue to stub it, but defer to the original implementation.
+    allow(YetiLogger.logger).to receive(level).and_call_original
+
+    log_messages
+  end
+
   def should_log(level = :info)
     expect(YetiLogger.logger).to(receive(level))
   end

data/lib/yeti_logger/version.rb

@@ -1,3 +1,3 @@
 module YetiLogger
-  VERSION = "3.0.0"
+  VERSION = "3.3.2"
 end

data/lib/yeti_logger.rb

@@ -74,14 +74,18 @@ module YetiLogger
   # passed to the log method.
   # Define these methods explicitly allows the use of yield.
   module LogMethods
+    # See usage at https://github.com/Yesware/yeti_logger/blob/master/README.md#user-based-logging
     def log_debug(obj = nil, ex = nil)
-      if YetiLogger.logger.level <= Logger::DEBUG
+      should_log_as_info = YetiLogger.try(:promote_debug_to_info?, obj)
+
+      if YetiLogger.logger.level <= Logger::DEBUG ||
+         (should_log_as_info && YetiLogger.logger.level <= Logger::INFO)
         msg = if block_given?
                 MessageFormatters.build_log_message(log_class_name, yield)
               else
                 MessageFormatters.build_log_message(log_class_name, obj, ex)
               end
-        YetiLogger.logger.send(:debug, msg)
+        YetiLogger.logger.send(should_log_as_info ? :info : :debug, msg)
       end
     end
 

data/spec/lib/yeti_logger/message_formatters_spec.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require 'spec_helper.rb'
 
 # Class used for class and instance level testing

data/spec/lib/yeti_logger/test_helper_spec.rb

@@ -121,6 +121,95 @@ describe YetiLogger::TestHelper do
 
   end
 
+  describe '.expect_to_not_see_log_messages' do
+    it 'has a singular form' do
+      expect_to_not_see_log_message('YetiLogger::TestLogger: foo', :warn) do
+        instance.log_warn('bar')
+      end
+    end
+
+    it 'checks for multiple messages' do
+      messages = [
+                  'YetiLogger::TestLogger: one',
+                  'YetiLogger::TestLogger: two'
+                 ]
+      expect_to_not_see_log_messages(messages, :info) do
+        instance.log_info('three')
+        instance.log_info('four')
+      end
+    end
+
+    it 'only stubs the log level you request' do
+      expect(YetiLogger.logger).to receive(:info).with('YetiLogger::TestLogger: msg')
+
+      expect_to_not_see_log_message('YetiLogger::TestLogger: msg', :warn) do
+        instance.log_info { 'msg' }
+        instance.log_error { 'msg' }
+      end
+    end
+
+    it 'supports regexes' do
+      messages = [
+                  'YetiLogger::TestLogger: one',
+                  /two-\d/,
+                  'YetiLogger::TestLogger: three'
+                 ]
+      expect_to_not_see_log_messages(messages, :info) do
+        instance.log_info('four')
+        instance.log_info('five')
+      end
+    end
+
+    it 'fails when it finds the string message' do
+      expect do
+        message = 'YetiLogger::TestLogger: should not be there'
+        expect_to_not_see_log_message(message, :info) do
+          instance.log_info('should not be there')
+        end
+      end.to raise_exception(RuntimeError)
+    end
+
+    it 'fails when it matches the regexp message' do
+      expect do
+        expect_to_not_see_log_message(/bazinga/, :info) do
+          instance.log_info('bazinga, punk!')
+        end
+      end.to raise_exception(RuntimeError)
+    end
+
+    it 'fails when it finds one of the string messages' do
+      expect do
+        messages = [
+                    'YetiLogger::TestLogger: one',
+                    /two-\d/,
+                    'YetiLogger::TestLogger: three',
+                    'YetiLogger::TestLogger: four'
+                   ]
+        expect_to_not_see_log_messages(messages, :info) do
+          instance.log_info('one')
+          instance.log_info('five')
+          instance.log_info('six')
+        end
+      end.to raise_exception(RuntimeError)
+    end
+
+    it 'fails when it finds matches one of the regexps' do
+      expect do
+        messages = [
+                    'YetiLogger::TestLogger: one',
+                    /two-\d/,
+                    /three/,
+                    'YetiLogger::TestLogger: four'
+                   ]
+        expect_to_not_see_log_messages(messages, :info) do
+          instance.log_info('two-2')
+          instance.log_info('five')
+          instance.log_info('six')
+        end
+      end.to raise_exception(RuntimeError)
+    end
+  end
+
   describe '.should_log' do
     it 'verifies a log message came through' do
       should_log(:info).with("YetiLogger::TestLogger: hello!")

data/spec/lib/yeti_logger_spec.rb

@@ -97,10 +97,63 @@ describe YetiLogger do
 
       end
 
-      # There is a lot of debug output, so we can't verify it like we do the other
-      # levels. For now, just validate the method is there.
-      it "can call a #{target_type} debug method" do
-        target.log_debug("#{target_type} debuggin")
+      describe "log_debug" do
+        let(:user_id) { rand(9000) }
+
+        shared_examples_for "it logs at the expected level" do |expected_level|
+          it "logs at #{expected_level} level" do
+            regex = /#{class_name}:.*#{target_type}.*debuggin.*user_id=#{user_id}/
+            expect_to_see_log_message(regex, expected_level) do
+              target.log_debug(msg: "#{target_type} debuggin", user_id: user_id)
+            end
+          end
+        end
+
+        after(:each) do
+          if described_class.respond_to?(:promote_debug_to_info?)
+            class <<described_class
+              undef_method(:promote_debug_to_info?)
+            end
+          end
+        end
+
+        context "when promote_debug_to_info? isn't configured," do
+          before(:each) do
+            if described_class.respond_to?(:promote_debug_to_info?)
+              class <<described_class
+                undef_method(:promote_debug_to_info?)
+              end
+            end
+          end
+
+          it_behaves_like "it logs at the expected level", :debug
+        end
+
+        context "when promote_debug_to_info? is configured," do
+          context "when promote_debug_to_info is true," do
+            before(:each) do
+              described_class.configure do |config|
+                def config.promote_debug_to_info?(log_hash)
+                  true
+                end
+              end
+            end
+
+            it_behaves_like "it logs at the expected level", :info
+          end
+
+          context "when promote_debug_to_info is false," do
+            before(:each) do
+              described_class.configure do |config|
+                def config.promote_debug_to_info?(log_hash)
+                  false
+                end
+              end
+            end
+
+            it_behaves_like "it logs at the expected level", :debug
+          end
+        end
       end
 
       it "can log key value pairs at #{target_type} level" do

data/yeti_logger.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "yard"
   spec.add_development_dependency "kramdown"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yeti_logger
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Yesware, Inc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
 description: Provides standardized logging
 email:
 - engineering@yesware.com
@@ -101,10 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -113,6 +126,7 @@ files:
 - lib/yeti_logger.rb
 - lib/yeti_logger/configuration.rb
 - lib/yeti_logger/constants.rb
+- lib/yeti_logger/custom_formatter.rb
 - lib/yeti_logger/message_formatters.rb
 - lib/yeti_logger/test_helper.rb
 - lib/yeti_logger/version.rb
@@ -127,7 +141,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,9 +156,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Provides standardized logging
 test_files:
@@ -153,4 +166,3 @@ test_files:
 - spec/lib/yeti_logger/wrapped_logger_spec.rb
 - spec/lib/yeti_logger_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.2.2

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - jruby-19mode
-
-script:
-  - bundle exec rake ci
-
-sudo: false
-
-env:
-  global:
-    # To allow JRUBY to install c-extension gems
-    - "JRUBY_OPTS=-Xcext.enabled=true"