lenjador 1.2.1 → 2.1.0

data/lib/lenjador/preprocessors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     def self.get(type, arguments)

data/lib/lenjador/preprocessors/blacklist.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     class Blacklist
-
       DEFAULT_ACTION = 'prune'
       MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 
-      class UnsupportedActionException < Exception
+      class UnsupportedActionException < RuntimeError
       end
 
       def initialize(config = {})
@@ -19,15 +20,16 @@ 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])
-              self.send(action_method(field[:action]), mem, key, val)
+              send(action_method(field[:action]), mem, key, val)
             else
               mem.merge(key => process(val))
             end
           end
-        elsif data.is_a? Array
+        when Array
           data.inject([]) do |mem, val|
             mem + [process(val)]
           end
@@ -43,19 +45,19 @@ class Lenjador
       end
 
       def validate_action_supported(action)
-        unless self.respond_to?(action_method(action).to_sym, true)
-          raise UnsupportedActionException.new("Action: #{action} is not supported")
+        unless respond_to?(action_method(action).to_sym, true)
+          raise UnsupportedActionException, "Action: #{action} is not supported"
         end
       end
 
-      def mask_field(data, key, val)
+      def mask_field(data, key, _val)
         data.merge(key => MASKED_VALUE)
       end
 
       def prune_field(data, *)
         data
       end
-      alias_method :exclude_field, :prune_field
+      alias exclude_field prune_field
     end
   end
 end

data/lib/lenjador/preprocessors/json_pointer_trie.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'lru_redux'
 
 class Lenjador
   module Preprocessors
     class JSONPointerTrie
-      SEPARATOR = '/'.freeze
-      WILDCARD = '~'.freeze
+      SEPARATOR = '/'
+      WILDCARD = '~'
       DEFAULT_CACHE_SIZE = 100
 
       def initialize(cache_size: DEFAULT_CACHE_SIZE, **)

data/lib/lenjador/preprocessors/strategies/mask.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     module Strategies
       class Mask
-        MASK_SYMBOL = '*'.freeze
+        MASK_SYMBOL = '*'
         MASKED_VALUE = MASK_SYMBOL * 5
 
         def initialize(trie)

data/lib/lenjador/preprocessors/strategies/prune.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Lenjador
   module Preprocessors
     module Strategies

data/lib/lenjador/preprocessors/whitelist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lenjador/preprocessors/json_pointer_trie'
 require 'lenjador/preprocessors/strategies/mask'
 require 'lenjador/preprocessors/strategies/prune'
@@ -6,12 +8,12 @@ class Lenjador
   module Preprocessors
     class Whitelist
       DEFAULT_WHITELIST = %w[/id /message /correlation_id /queue].freeze
-      MASK_SYMBOL = '*'.freeze
+      MASK_SYMBOL = '*'
       MASKED_VALUE = MASK_SYMBOL * 5
 
       PRUNE_ACTION_NAMES = %w[prune exclude].freeze
 
-      class InvalidPointerFormatException < Exception
+      class InvalidPointerFormatException < RuntimeError
       end
 
       def initialize(config = {})
@@ -31,9 +33,7 @@ class Lenjador
       private
 
       def validate_pointer(pointer)
-        if pointer.slice(-1) == '/'
-          raise InvalidPointerFormatException, 'Pointer should not contain trailing slash'
-        end
+        raise InvalidPointerFormatException, 'Pointer should not contain trailing slash' if pointer.slice(-1) == '/'
       end
 
       def decode(pointer)
@@ -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,8 +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
     #
@@ -13,8 +22,9 @@ class Lenjador
     # @return [Hash]
     def self.build_event(metadata, level, application_name)
       overwritable_params
-        .merge(metadata)
-        .merge(
+        .merge!(metadata)
+        .merge!(tracing_information)
+        .merge!(
           application: application_name,
           level: level
         )
@@ -34,58 +44,47 @@ class Lenjador
 
     def self.overwritable_params
       {
-        :@timestamp => Time.now.utc.iso8601(DECIMAL_FRACTION_OF_SECOND)
+        :@timestamp => Time.now
       }
     end
+    private_class_method :overwritable_params
 
-    def self.serialize_time_objects!(object)
-      if object.is_a?(Hash)
-        object.each do |key, value|
-          object[key] = serialize_time_objects!(value)
-        end
-      elsif object.is_a?(Array)
-        object.each_index do |index|
-          object[index] = serialize_time_objects!(object[index])
-        end
-      elsif object.is_a?(Time) || object.is_a?(Date)
-        object.iso8601
-      else
-        object
-      end
-    end
-
-    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: :compat, time_format: :ruby }.freeze
-
-      def self.generate_json(obj)
-        serialize_time_objects!(obj)
-
-        Oj.dump(obj, DUMP_OPTIONS)
-      end
+    def self.generate_json(obj)
+      Oj.dump(obj, DUMP_OPTIONS)
     end
 
     def self.underscore(input)
       word = input.to_s.dup
       word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      word.tr!("-", "_")
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+      word.tr!('-', '_')
       word.downcase!
       word
     end
 
-    private_class_method :overwritable_params
+    # 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)
+
+      context = OpenTracing.active_span&.context
+      if context && context.respond_to?(:trace_id) && context.respond_to?(:span_id)
+        {
+          trace_id: context.trace_id,
+          span_id: context.span_id
+        }
+      else
+        NO_TRACE_INFORMATION
+      end
+    end
+    private_class_method :tracing_information
   end
 end

data/profiler/logs.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Run with `ruby profiler/logs.rb > /dev/null` and then you can read the
+# results using `open /tmp/lenjador.html`
+
+require 'bundler/setup'
+Bundler.require
+logger = Lenjador.build('test_service', stdout: {level: 'info', json: true})
+
+require 'ruby-prof'
+RubyProf.start
+
+100_000.times do
+  logger.info 'hello there', a: 'asdf', b: 'eadsfasdf', c: {hello: 'there'}
+end
+
+result = RubyProf.stop
+printer = RubyProf::GraphHtmlPrinter.new(result)
+File.open('/tmp/lenjador.html', 'w+') { |file| printer.print(file) }

data/spec/lenjador/adapters/stdout_adapter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'lenjador/adapters/stdout_adapter'
+
+describe Lenjador::Adapters::StdoutAdapter do
+  it 'creates a stdout logger' do
+    io_logger = described_class.new('service name')
+
+    logger = io_logger.logger
+    expect(logger).to be_a Logger
+  end
+
+  describe '#log' do
+    let(:adapter) { described_class.new('sevice name') }
+    let(:logger) { adapter.logger }
+
+    context 'with only a message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:add).with(Logger::Severity::INFO, 'test')
+
+        adapter.log Lenjador::Severity::INFO, message: 'test'
+      end
+    end
+
+    context 'with an empty message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:add).with(Logger::Severity::INFO, ' {"a":"b"}')
+
+        adapter.log Lenjador::Severity::INFO, message: '', a: 'b'
+      end
+    end
+
+    context 'with no message' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:add).with(Logger::Severity::INFO, '{"a":"b"}')
+
+        adapter.log Lenjador::Severity::INFO, a: 'b'
+      end
+    end
+
+    context 'with a message and metadata' do
+      it 'stringifies it correctly' do
+        expect(logger).to receive(:add).with(Logger::Severity::INFO, 'test {"a":"b"}')
+
+        adapter.log Lenjador::Severity::INFO, message: 'test', a: 'b'
+      end
+    end
+  end
+end

data/spec/lenjador/adapters/stdout_json_adapter_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'json'
+require 'lenjador/adapters/stdout_json_adapter'
+
+describe Lenjador::Adapters::StdoutJsonAdapter do
+  let(:stdout) { StringIO.new }
+
+  around do |example|
+    old_stdout = $stdout
+    $stdout = stdout
+
+    begin
+      example.call
+    ensure
+      $stdout = old_stdout
+    end
+  end
+
+  describe '#log' do # rubocop:disable RSpec/MultipleMemoizedHelpers
+    let(:adapter) { described_class.new(service_name) }
+    let(:metadata) { {x: 'y'} }
+    let(:event) { {a: 'b', x: 'y'} }
+    let(:serialized_event) { JSON.dump(event) }
+    let(:service_name) { 'my-service' }
+    let(:application_name) { 'my_service' }
+    let(:info) { Lenjador::Severity::INFO }
+    let(:info_label) { 'info' }
+
+    before do
+      allow(Lenjador::Utils).to receive(:build_event)
+        .with(metadata, info_label, application_name)
+        .and_return(event)
+    end
+
+    it 'sends serialized event to $stdout' do
+      adapter.log(info, metadata)
+      expect(output).to eq("#{serialized_event}\n")
+    end
+  end
+
+  private
+
+  def output
+    stdout.string
+  end
+end

data/spec/{preprocessors → lenjador/preprocessors}/blacklist_spec.rb

@@ -1,21 +1,25 @@
 require 'spec_helper'
-require_relative '../../lib/lenjador/preprocessors/blacklist'
+require_relative '../../../lib/lenjador/preprocessors/blacklist'
 
 describe Lenjador::Preprocessors::Blacklist do
   subject(:processed_data) { described_class.new(config).process(data) }
 
-  let(:config) {{
-    fields: [{ key: 'field', action: action }]
-  }}
+  let(:config) do
+    {
+      fields: [{key: 'field', action: action}]
+    }
+  end
 
   let(:action) {}
-  let(:data) {{
-    field: value,
-    data: {
-      field: 'secret'
-    },
-    array: [{field: 'secret'}]
-  }}
+  let(:data) do
+    {
+      field: value,
+      data: {
+        field: 'secret'
+      },
+      array: [{field: 'secret'}]
+    }
+  end
 
   let(:value) { 'secret' }
 
@@ -39,7 +43,7 @@ describe Lenjador::Preprocessors::Blacklist do
     end
 
     it 'removes nested in array field' do
-      expect(processed_data[:array]).not_to include({field: 'secret'})
+      expect(processed_data[:array]).not_to include(field: 'secret')
     end
 
     context 'when field is deeply nested' do
@@ -60,7 +64,7 @@ describe Lenjador::Preprocessors::Blacklist do
     end
 
     it 'masks nested in array field' do
-      expect(processed_data[:array]).to include({field: '*****'})
+      expect(processed_data[:array]).to include(field: '*****')
     end
 
     context 'when field is string' do
@@ -88,7 +92,7 @@ describe Lenjador::Preprocessors::Blacklist do
     end
 
     context 'when field is array' do
-      let(:value) { [1,2,3,4] }
+      let(:value) { [1, 2, 3, 4] }
 
       it 'masks value with asterisks' do
         expect(processed_data).to include(field: '*****')

data/spec/{preprocessors/json_pointer_trie.rb → lenjador/preprocessors/json_pointer_trie_spec.rb}

@@ -20,9 +20,9 @@ RSpec.describe Lenjador::Preprocessors::JSONPointerTrie do
     it 'returns false if trie does not contain requested prefix or value' do
       trie.insert('/data/nested/key')
 
-      expect(trie).to_not include('/bad_data')
-      expect(trie).to_not include('/data/bad_nested')
-      expect(trie).to_not include('/data/nested/bad_key')
+      expect(trie).not_to include('/bad_data')
+      expect(trie).not_to include('/data/bad_nested')
+      expect(trie).not_to include('/data/nested/bad_key')
     end
 
     it 'returns true if trie contains requested prefix under wildcard' do
@@ -30,7 +30,7 @@ RSpec.describe Lenjador::Preprocessors::JSONPointerTrie do
 
       expect(trie).to include('/data/arbitrary_key/key')
       expect(trie).to include('/data/another_key/key')
-      expect(trie).to_not include('/data/arbitrary_key/bad_nested_key')
+      expect(trie).not_to include('/data/arbitrary_key/bad_nested_key')
     end
   end
 end