Commit 920fcdff authored by Elliot Forbes's avatar Elliot Forbes 2️⃣
Browse files

Merge branch 'perf/optimize-caller-locations' into 'master' 

perf: skip internal frames in determine_callsite

See merge request !231

Merged-by: Elliot Forbes's avatarElliot Forbes <eforbes@gitlab.com>
Approved-by: default avatarNao Hashizume <nhashizume@gitlab.com>
Approved-by: Elliot Forbes's avatarElliot Forbes <eforbes@gitlab.com>
Reviewed-by: default avatarGitLab Duo <gitlab-duo@gitlab.com>
Co-authored-by: default avatardbarrett <dbarrett@gitlab.com>
parents 67f29f23 79947c4d

lib/labkit/logging/field_validator/log_interceptor.rb

+7 −1
Original line number Diff line number Diff line
@@ -55,8 +55,14 @@ module Labkit 


        private



        # Skip internal frames (determine_callsite, format_data, format_message, add, info) for performance.

        INTERNAL_FRAMES_TO_SKIP = 5

        MAX_FRAMES_TO_INSPECT = 15

        private_constant :INTERNAL_FRAMES_TO_SKIP, :MAX_FRAMES_TO_INSPECT



        def determine_callsite

          locations = caller_locations(1, 30) || []

          locations = caller_locations(INTERNAL_FRAMES_TO_SKIP, MAX_FRAMES_TO_INSPECT) || []

          locations = caller_locations(1, MAX_FRAMES_TO_INSPECT) || [] if locations.empty?



          locations.find do |loc|

            path = loc.path

spec/labkit/logging/field_validator/log_interceptor_spec.rb

+28 −0
Original line number Diff line number Diff line
@@ -137,6 +137,34 @@ RSpec.describe Labkit::Logging::FieldValidator::LogInterceptor do 
    end

  end



  describe '#determine_callsite' do

    it 'verifies internal frame structure for INTERNAL_FRAMES_TO_SKIP constant' do

      captured_frame_labels = nil

      test_interceptor = Module.new do

        define_method(:determine_callsite) do

          captured_frame_labels = caller_locations(1, 10).map(&:label)

          super()

        end

      end



      real_logger_class = Class.new(Labkit::Logging::JsonLogger) do

        prepend Labkit::Logging::FieldValidator::LogInterceptor

      end

      real_logger_class.prepend(test_interceptor)



      output = StringIO.new

      real_logger = real_logger_class.new(output)

      real_logger.info('test')



      # Frames 0-3 are internal; frame 4 should be the actual callsite (this test)

      expect(captured_frame_labels[0]).to include('format_data')

      expect(captured_frame_labels[1]).to include('format_message')

      expect(captured_frame_labels[2]).to include('add')

      expect(captured_frame_labels[3]).to include('info')

      expect(captured_frame_labels[4]).to include('block')

    end

  end



  describe 'wrapper patterns' do

    describe '.register_wrapper_pattern' do

      after do