lorekeeper 1.11.1 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfcc3f33a2a846246a7e85d8c8c2730d1099bb0c41b80b86998ffd6beb5736a4
-  data.tar.gz: 2e7b7f4a5e80c372ca5b17b4f961efa80bbd17e67713a075064c63659767bc2f
+  metadata.gz: db3ae6a493b8fc903122557d5144db57633e3c72a881cb4bc88ad458d438f7dc
+  data.tar.gz: 69ba8f5fd5ea48d6325f27ae777c91e857e28c5f7e6093cef71aa427cfcb8266
 SHA512:
-  metadata.gz: fc4fa20700854b22f850129142a801ac56131e0f46e6f7ad74e69356821505715514c3b32041c58eaf3affa4dfe0ec951244e5e63222c26a08b115d9ecf8ea3f
-  data.tar.gz: 8de40794309ff297adee1865243dbc856a6b6f687cef620af6807b5a582e2011b00ab822a948e870368b01bcce9ac0c3071eba9d7b95ce8a75c8451468cc4dfa
+  metadata.gz: 5b3b703f5182598b73f0c86411b9a627060eed1e0c59ddd1b9507dd3e9f28b5c3239e2e48a59bdf42edc017fa5df1acb4ba8aee5f502f73f21ff6fcc1876c8b4
+  data.tar.gz: 8925f11071fbccff8ddca89066a473b9286c8aedd87f9b76c3f872388e83ead883f2b78fe3645e71753009535f9e7b2e09e0e3921b4f64883a86f49c3737da72

data/.github/workflows/build.yml

@@ -0,0 +1,29 @@
+# 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: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '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 rspec
+    - name: Run benchmark
+      run: bundle exec rake benchmark

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.12.0
+* Remove ZipkinTracer information from stacktrace output
+* Move CI to GitHub Actions
+
 # 1.11.1
 * Modify FastLogger#add to log progname as a message if no message and block are given
 

data/README.md

@@ -1,6 +1,6 @@
 # Lorekeeper
 
-[![Build Status](https://travis-ci.org/JordiPolo/lorekeeper.svg?branch=master)](https://travis-ci.org/JordiPolo/lorekeeper)
+[![build](https://github.com/JordiPolo/lorekeeper/actions/workflows/build.yml/badge.svg)](https://github.com/JordiPolo/lorekeeper/actions/workflows/build.yml)
 
 LoreKeeper contains a highly optimized JSON logger. It outputs messages as JSON and let the users to add their own customized fields.
 When used without extra fields it outputs 20% faster than the standard Logger for messages not longer than one line of text.
@@ -141,7 +141,7 @@ Will output:
 }
 ```
 
-This method also accepts a custom message, data and log level.
+This method also accepts a custom message, data and log level:
 
 ```ruby
 rescue => e
@@ -169,16 +169,30 @@ Will output:
 }
 ```
 
-Alternatively you can use named parameters:
+Please note that due to the way Ruby 2.x automatically converts Hash objects to keyword arguments when they come last,
+you need to explicitly use the `data` keyword argument when you don't pass any other argument afterwards:
 
 
+```ruby
+logger.exception(e, "custom msg!", { some: { data: 123 } })
+# => ArgumentError: unknown keyword: some
+
+logger.exception(e, "custom msg!", data: { some: { data: 123 } })
+# => works
+```
+
+Ruby 3.x is unaffected by this issue since the conversion is [not done automatically anymore](https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/).
+
+
+The available keyword arguments are `message`, `data` and `level`. They can be used instead of the fixed arguments:
+
 ```ruby
 rescue => e
   logger.exception(e, message: "custom msg!", data: { some: { data: 123 } }, level: :warn)
 end
 ```
 
-This is specially useful when there is no custom message or data:
+This is especially useful when there is no custom message or data:
 
 ```ruby
 rescue => e

data/lib/lorekeeper/json_logger.rb

@@ -98,7 +98,7 @@ module Lorekeeper
 
     # Some instrumentation libraries pollute the stacktrace and create a large output which may
     # cause problems with certain logging backends.
-    # Hardcording newrelic and active_support/callbacks now here.
+    # Hardcording newrelic, active_support/callbacks and zipkin-tracer now here.
     # In the future if this list grows, we may make it configurable.
     def clean_backtrace(backtrace)
       @backtrace_cleaner&.clean(backtrace) || backtrace
@@ -121,7 +121,7 @@ module Lorekeeper
     EXCEPTION = 'exception'
     STACK = 'stack'
     DATA = 'data'
-    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb}.freeze
+    BLACKLISTED_FINGERPRINT = %r{newrelic_rpm|active_support/callbacks.rb|zipkin-tracer}.freeze
 
     def with_extra_fields(fields)
       state[:extra_fields] = fields

data/lib/lorekeeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lorekeeper
-  VERSION = '1.11.1'
+  VERSION = '1.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lorekeeper
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - Jordi Polo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -183,10 +183,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.4.9
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-  - 3.0.0
-
-script: bundle exec rspec