lenjador 2.0.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c13138df41134b3d17319ff6d02d86e5b261ab5b45eaf901ec35e19bb0667b
-  data.tar.gz: 963d753a7188d8ce556b2f03236db1a18e9428e8d5f71d07890e039ea6dcdf51
+  metadata.gz: 9d2c05e9a5e41ddcfb2274063ae0b5d75387a5657e9effb6440e1d0ac9aa10e2
+  data.tar.gz: f5e80262d179b4320f7db1e2f1998b9a6160c57868a14dbf3d74d73420289e2a
 SHA512:
-  metadata.gz: 77ea852dc496c9c973954da2d83de33811a6c7e37b7028ca1596aece01009944e0d476f5e8e32790c380735338283d5ee62e634f0555da7aa58b8a99a73bdb91
-  data.tar.gz: 367a1528be10b7d2cde8f9d8cbe16080ebdf90a9d9e6c0670b42ced776018c1d1871b904434f1b6d11e18eeebbd993365573e5ec8acb21f8cb6d04eb3563f585
+  metadata.gz: a051c066866a827ca68e7b207a5f37f73ce7eb73bc1a33afca8523f2b51d2c44f47bd3d7d87d07ac2e7498f03298ac5120d314718c906043cf17b5ed913c6711
+  data.tar.gz: 212cc99147c9d533b82fb92594259ebf65eb49e9cf61e006d8460b874dec01e2cba6b4f15e898e3b199186c569fbcb488923e26ba05dc76a925292a9d1501f0f

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        submodules: true
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run lint & tests
+      run: bundle exec rake

data/.gitignore

@@ -1,4 +1,2 @@
 node_modules/
 npm-debug.log
-Gemfile.lock
-

data/.rubocop.yml

@@ -1,6 +1,9 @@
 inherit_gem:
   rubocop-salemove: config/default.yml
 
+AllCops:
+  TargetRubyVersion: 2.6
+
 Style/FrozenStringLiteralComment:
   Enabled: yes
   EnforcedStyle: always
@@ -34,8 +37,5 @@ RSpec/MultipleExpectations:
 Style/SafeNavigation:
   Enabled: no
 
-Performance/RegexpMatch:
-  Enabled: no
-
 Style/SingleLineMethods:
   Enabled: no

data/.ruby-version

@@ -1 +1 @@
-ruby-2.4.1
+ruby-2.7.1

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    lenjador (2.2.1)
+      lru_redux
+      oj (~> 3.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    benchmark-ips (2.8.4)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    lru_redux (1.1.0)
+    method_source (1.0.0)
+    oj (3.11.5)
+    opentelemetry-api (0.17.0)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (1.44.1)
+      rubocop (~> 0.87)
+      rubocop-ast (>= 0.7.1)
+    rubocop-salemove (0.0.5)
+      rubocop (~> 0.82)
+      rubocop-rspec (~> 1.15)
+    ruby-prof (1.4.3)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler
+  lenjador!
+  opentelemetry-api
+  pry
+  rake
+  rspec
+  rubocop-salemove
+  ruby-prof
+
+BUNDLED WITH
+   2.1.4

data/lenjador.gemspec

@@ -4,13 +4,14 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.name          = RUBY_PLATFORM =~ /java/ ? 'lenjador-jruby' : 'lenjador'
-  gem.version       = '2.0.0'
+  gem.name          = 'lenjador'
+  gem.version       = '2.2.1'
   gem.authors       = ['Salemove']
   gem.email         = ['support@salemove.com']
   gem.description   = "It's lenjadoric"
   gem.summary       = 'What description said'
   gem.license       = 'MIT'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -18,18 +19,14 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'lru_redux'
-
-  if RUBY_PLATFORM =~ /java/
-    gem.add_dependency 'jrjackson'
-  else
-    gem.add_dependency 'oj', '~> 3.6'
-    gem.add_development_dependency 'ruby-prof'
-  end
+  gem.add_dependency 'oj', '~> 3.6'
 
   gem.add_development_dependency 'benchmark-ips'
   gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'opentelemetry-api'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop-salemove'
+  gem.add_development_dependency 'ruby-prof'
 end

data/lib/lenjador/adapters/stdout_adapter.rb

@@ -8,7 +8,7 @@ class Lenjador
       attr_reader :logger
 
       def initialize(_service_name)
-        @logger = Logger.new(STDOUT)
+        @logger = Logger.new($stdout)
       end
 
       def log(level, metadata = {})

data/lib/lenjador/adapters/stdout_json_adapter.rb

@@ -5,7 +5,6 @@ class Lenjador
     class StdoutJsonAdapter
       def initialize(service_name)
         @application_name = Utils.application_name(service_name)
-        @mutex = Mutex.new if RUBY_ENGINE == 'jruby'
       end
 
       def log(level, metadata = {})
@@ -20,13 +19,9 @@ class Lenjador
         def print_line(str)
           $stdout.puts(str)
         end
-      elsif RUBY_ENGINE == 'jruby'
-        def print_line(str)
-          @mutex.synchronize { $stdout.write(str + "\n") }
-        end
       else
         def print_line(str)
-          $stdout.write(str + "\n")
+          $stdout.write("#{str}\n")
         end
       end
     end

data/lib/lenjador/preprocessors/blacklist.rb

@@ -20,7 +20,8 @@ class Lenjador
       end
 
       def process(data)
-        if data.is_a? Hash
+        case data
+        when Hash
           data.inject({}) do |mem, (key, val)|
             if (field = @fields_to_process[key.to_s])
               send(action_method(field[:action]), mem, key, val)
@@ -28,7 +29,7 @@ class Lenjador
               mem.merge(key => process(val))
             end
           end
-        elsif data.is_a? Array
+        when Array
           data.inject([]) do |mem, val|
             mem + [process(val)]
           end

data/lib/lenjador/preprocessors/whitelist.rb

@@ -7,7 +7,7 @@ require 'lenjador/preprocessors/strategies/prune'
 class Lenjador
   module Preprocessors
     class Whitelist
-      DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue].freeze
+      DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue /trace_id /span_id].freeze
       MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 
@@ -45,7 +45,7 @@ class Lenjador
       def build_trie(config)
         pointers = (config[:pointers] || []) + DEFAULT_WHITELIST
 
-        pointers.reduce(JSONPointerTrie.new(config)) do |trie, pointer|
+        pointers.reduce(JSONPointerTrie.new(**config)) do |trie, pointer|
           validate_pointer(pointer)
 
           trie.insert(decode(pointer))

data/lib/lenjador/utils.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
 require 'time'
+require 'oj'
 
 class Lenjador
   module Utils
     DECIMAL_FRACTION_OF_SECOND = 3
     NO_TRACE_INFORMATION = {}.freeze
+    DUMP_OPTIONS = {
+      mode: :custom,
+      time_format: :xmlschema,
+      second_precision: 3
+    }.freeze
 
     # Build logstash json compatible event
     #
@@ -43,28 +49,8 @@ class Lenjador
     end
     private_class_method :overwritable_params
 
-    if RUBY_PLATFORM =~ /java/
-      require 'jrjackson'
-
-      DUMP_OPTIONS = {
-        timezone: 'utc',
-        date_format: "YYYY-MM-dd'T'HH:mm:ss.SSSX"
-      }.freeze
-
-      def self.generate_json(obj)
-        JrJackson::Json.dump(obj, DUMP_OPTIONS)
-      end
-    else
-      require 'oj'
-      DUMP_OPTIONS = {
-        mode: :custom,
-        time_format: :xmlschema,
-        second_precision: 3
-      }.freeze
-
-      def self.generate_json(obj)
-        Oj.dump(obj, DUMP_OPTIONS)
-      end
+    def self.generate_json(obj)
+      Oj.dump(obj, DUMP_OPTIONS)
     end
 
     def self.underscore(input)
@@ -77,17 +63,37 @@ class Lenjador
       word
     end
 
-    # Tracing information
-    #
-    # Tracing information is included only if OpenTracing is defined and if it
-    # supports method called `active_span` (version >= 0.4.1). We use
-    # SpanContext#trace_id and SpanContext#span_id methods to retrieve tracing
-    # information. These methods are not yet supported by the OpenTracing API,
-    # so we first check if these methods exist. Popular tracing libraries
-    # already implement them. These methods are likely to be added to the API
-    # very soon: https://github.com/opentracing/specification/blob/master/rfc/trace_identifiers.md
     def self.tracing_information
-      return NO_TRACE_INFORMATION if !defined?(OpenTracing) || !OpenTracing.respond_to?(:active_span)
+      tracing_information_from_opentelemetry ||
+        tracing_information_from_opentracing ||
+        NO_TRACE_INFORMATION
+    end
+    private_class_method :tracing_information
+
+    def self.tracing_information_from_opentelemetry
+      return nil unless defined?(OpenTelemetry)
+
+      current_span_context = OpenTelemetry::Trace.current_span.context
+      return nil unless current_span_context.valid?
+
+      {
+        trace_id: current_span_context.hex_trace_id,
+        span_id: current_span_context.hex_span_id
+      }
+    end
+    private_class_method :tracing_information_from_opentelemetry
+
+    # Tracing information is included only if OpenTracing supports method
+    # called `active_span` (version >= 0.4.1). We use SpanContext#trace_id and
+    # SpanContext#span_id methods to retrieve tracing information. These
+    # methods are not yet supported by the OpenTracing API, so we first check
+    # if these methods exist. Popular tracing libraries already implement them.
+    # These methods are likely to be added to the API very soon:
+    # https://github.com/opentracing/specification/blob/master/rfc/trace_identifiers.md
+    #
+    # @deprecated Use OpenTelemetry instead
+    def self.tracing_information_from_opentracing
+      return nil if !defined?(OpenTracing) || !OpenTracing.respond_to?(:active_span)
 
       context = OpenTracing.active_span&.context
       if context && context.respond_to?(:trace_id) && context.respond_to?(:span_id)
@@ -95,10 +101,8 @@ class Lenjador
           trace_id: context.trace_id,
           span_id: context.span_id
         }
-      else
-        NO_TRACE_INFORMATION
       end
     end
-    private_class_method :tracing_information
+    private_class_method :tracing_information_from_opentracing
   end
 end

data/lib/lenjador.rb

@@ -58,6 +58,12 @@ class Lenjador
 
   def fatal?; @level <= Severity::FATAL; end
 
+  def level=(new_level)
+    raise ArgumentError, "invalid log level: #{new_level}" unless new_level.is_a?(Integer)
+
+    @level = new_level
+  end
+
   private
 
   def log(level, *args, &block)

data/spec/lenjador/adapters/stdout_json_adapter_spec.rb

@@ -16,7 +16,7 @@ describe Lenjador::Adapters::StdoutJsonAdapter do
     end
   end
 
-  describe '#log' do
+  describe '#log' do # rubocop:disable RSpec/MultipleMemoizedHelpers
     let(:adapter) { described_class.new(service_name) }
     let(:metadata) { {x: 'y'} }
     let(:event) { {a: 'b', x: 'y'} }
@@ -34,7 +34,7 @@ describe Lenjador::Adapters::StdoutJsonAdapter do
 
     it 'sends serialized event to $stdout' do
       adapter.log(info, metadata)
-      expect(output).to eq serialized_event + "\n"
+      expect(output).to eq("#{serialized_event}\n")
     end
   end
 

data/spec/lenjador/preprocessors/whitelist_spec.rb

@@ -146,14 +146,6 @@ RSpec.describe Lenjador::Preprocessors::Whitelist do
       end
     end
 
-    context 'with whitelisted hash' do
-      let(:pointers) { ['/data'] }
-
-      it 'masks hash' do
-        expect(processed_data).to include(data: {field: '*****'})
-      end
-    end
-
     context 'when boolean present' do
       let(:data) { {bool: true} }
 
@@ -320,14 +312,6 @@ RSpec.describe Lenjador::Preprocessors::Whitelist do
       end
     end
 
-    context 'with whitelisted hash' do
-      let(:pointers) { ['/data'] }
-
-      it 'masks hash' do
-        expect(processed_data).to include(data: {})
-      end
-    end
-
     def process(pointers, data)
       described_class.new(pointers: pointers, action: :prune).process(data)
     end

data/spec/lenjador/utils_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
+require 'opentelemetry-api'
 
 describe Lenjador::Utils do
   let(:now) { Time.utc(2015, 10, 11, 23, 10, 21, 123_456) }
@@ -46,7 +47,28 @@ describe Lenjador::Utils do
       end
     end
 
-    context 'when OpenTracing is defined' do
+    context 'when OpenTelemetry is defined' do
+      it 'includes trace information' do
+        provider = OpenTelemetry.tracer_provider
+
+        tracer = provider.tracer('my_app', '1.0')
+        recorded_event = tracer.in_span('my_task') do |_task_span|
+          event
+        end
+
+        expect(recorded_event).to include(
+          trace_id: instance_of(String),
+          span_id: instance_of(String)
+        )
+      end
+
+      it 'does not include trace information if span is invalid' do
+        expect(OpenTelemetry::Trace.current_span.context).not_to be_valid
+        expect(event).not_to include(:trace_id, :span_id)
+      end
+    end
+
+    context 'when OpenTracing is defined' do # rubocop:disable RSpec/MultipleMemoizedHelpers
       let(:trace_id) { 'trace-id' }
       let(:span_id) { 'span-id' }
 

data/spec/lenjador_spec.rb

@@ -128,4 +128,23 @@ describe Lenjador do
       end
     end
   end
+
+  it 'allows changing log level on existing instance' do
+    logger = described_class.build('test_service', level: 'info')
+
+    logger.level = ::Logger::DEBUG
+    expect(logger.debug?).to eq(true)
+
+    logger.level = ::Logger::INFO
+    expect(logger.debug?).to eq(false)
+    expect(logger.info?).to eq(true)
+
+    logger.level = ::Logger::WARN
+    expect(logger.info?).to eq(false)
+    expect(logger.warn?).to eq(true)
+
+    logger.level = ::Logger::ERROR
+    expect(logger.warn?).to eq(false)
+    expect(logger.error?).to eq(true)
+  end
 end

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ Bundler.setup
 
 require 'lenjador'
 
-Dir[File.dirname(__FILE__) + '/support/*.rb'].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lenjador
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2021-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lru_redux
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: opentelemetry-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  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: It's lenjadoric
 email:
 - support@salemove.com
@@ -143,13 +157,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - benchmark/whitelisting.rb
@@ -188,15 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: What description said

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - jruby