yeti_logger 3.2.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7ebf769a9b7ffda8af122c0f39ccf931af0bf2a91f5009755f441ec4df9e3d1
-  data.tar.gz: 5230ebd2a81295a96370c7e2915f59e9c45d75873a4cdf035f00b185d17f31be
+  metadata.gz: f58be8ecadfe9be95d8517795d6d28b68d3c870957f73477e9a9780c78089c9d
+  data.tar.gz: b693a3f73e811f9f2d773755d05339b083517bbf288dcb96cf7c2710819ce326
 SHA512:
-  metadata.gz: b6d144db8cfccda8ecc46ede21c1b7b5838cb31a208d667cfefa0a00c6696a4908fda101458235cd128f76ab276cbf5623e93159aba2b1ca7197bbdcc3baaa54
-  data.tar.gz: 384158be6d4621ce55e5347dd69ace02b25444c4ff3f0e3e7cb389ea7fb736b478d6ff8d984c26c78e58ef9ecc9c9e4d603f2776f814d840b908f3e876bf0321
+  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,5 +1,14 @@
 # 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
 

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

@@ -1,3 +1,3 @@
 module YetiLogger
-  VERSION = "3.2.0"
+  VERSION = "3.3.2"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yeti_logger
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Yesware, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2024-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,11 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -128,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
@@ -157,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Provides standardized logging

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"