yeti_logger 3.2.0 → 3.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ebf769a9b7ffda8af122c0f39ccf931af0bf2a91f5009755f441ec4df9e3d1
-  data.tar.gz: 5230ebd2a81295a96370c7e2915f59e9c45d75873a4cdf035f00b185d17f31be
+  metadata.gz: 674c0f92e94346d1accfabe2491837bd0b82b56e1efb92b982e7e33ab2f18202
+  data.tar.gz: 4ebfb336c218f0497e84a0194b862cf17fc398760e47f5ac4e15448ea6e881f2
 SHA512:
-  metadata.gz: b6d144db8cfccda8ecc46ede21c1b7b5838cb31a208d667cfefa0a00c6696a4908fda101458235cd128f76ab276cbf5623e93159aba2b1ca7197bbdcc3baaa54
-  data.tar.gz: 384158be6d4621ce55e5347dd69ace02b25444c4ff3f0e3e7cb389ea7fb736b478d6ff8d984c26c78e58ef9ecc9c9e4d603f2776f814d840b908f3e876bf0321
+  metadata.gz: 59517ffceea669788533d74d550ef975ef8b1d051f251e2bb0d452e14f12eec85ce5b06340d3038fcd3b39cd89295828e337f4006122896887c2c8666ca4d773
+  data.tar.gz: 4ed75834c5fcb6c3308f199f64cd7596b01ffb1b3025e5a023242aba66333b01b97f628954c743bed3ea84ada74359465fa71f972b8ecba3ff5d5926f355e141

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 3.4
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# 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
+permissions:
+  contents: read
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.3', '3.4']
+
+    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,5 +1,17 @@
 # yeti_logger changelog
 
+## v3.3.3
+- Replace deprecated `active_support/core_ext/benchmark` with Ruby's standard `Benchmark` library (fixes Rails 8.2 deprecation warning)
+
+## 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
 

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

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/message_formatters.rb

@@ -1,12 +1,3 @@
-# require 'logger'
-# require 'yeti_logger/version'
-# require 'yeti_logger/configuration'
-# require 'active_support/core_ext/benchmark'
-# require 'active_support/concern'
-# require 'active_support/core_ext/object/blank'
-# require 'active_support/core_ext/object/try'
-
-
 # Helper class used to format messages for logging. These can be used
 # directly, but are more convenient when used via YetiLogger
 module YetiLogger::MessageFormatters

data/lib/yeti_logger/version.rb

@@ -1,3 +1,3 @@
 module YetiLogger
-  VERSION = "3.2.0"
+  VERSION = "3.3.3"
 end

data/lib/yeti_logger.rb

@@ -4,7 +4,7 @@ require 'yeti_logger/constants'
 require 'yeti_logger/configuration'
 require 'yeti_logger/wrapped_logger'
 require 'yeti_logger/message_formatters'
-require 'active_support/core_ext/benchmark'
+require 'benchmark'
 require 'active_support/concern'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
@@ -151,9 +151,7 @@ module YetiLogger
   end
 
   def log_time(action, level = :info)
-    ms = Benchmark.ms do
-      yield
-    end
+    ms = Benchmark.realtime { yield } * 1000
     YetiLogger.logger.send(level,
                            MessageFormatters.build_log_message(self.class.name,
                                                                { action: action,

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_spec.rb

@@ -256,6 +256,19 @@ describe YetiLogger do
         sleep 0.01
       end
     end
+
+    it "logs elapsed time in milliseconds" do
+      expect(YetiLogger.logger).to receive(:info) do |msg|
+        expect(msg).to match(/time_ms=\d+/)
+        # Verify it's roughly 100ms (with some tolerance for CI variance)
+        ms = msg.match(/time_ms=(\d+)/)[1].to_i
+        expect(ms).to be_between(80, 200)
+      end
+
+      instance.log_time("query_db") do
+        sleep 0.1
+      end
+    end
   end
 
   describe '#as_logger' do

data/yeti_logger.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   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,13 @@
 --- !ruby/object:Gem::Specification
 name: yeti_logger
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.3
 platform: ruby
 authors:
 - Yesware, Inc
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,20 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: kramdown
-  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -115,11 +100,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -128,6 +112,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
@@ -142,7 +127,6 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Provides standardized logging
 test_files:

data/.ruby-gemset

@@ -1 +0,0 @@
-yesware

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.7.3

data/.travis.yml

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