Verified Commit 4b8d7365 authored by Bob Van Landuyt's avatar Bob Van Landuyt 💬 Committed by GitLab
Browse files

Merge branch 'fix/rate-limit-error-log-fields' into 'master' 

fix: Use standard error fields for rate limit logs

See merge request !313

Merged-by: Bob Van Landuyt's avatarBob Van Landuyt <bob@gitlab.com>
Approved-by: Max Woolf's avatarMax Woolf <mwoolf@gitlab.com>
Reviewed-by: default avatarGitLab Duo <gitlab-duo@gitlab.com>
Co-authored-by: Hercules Merscher's avatarHercules Merscher <hmerscher@gitlab.com>
parents fb73d565 656cd935

lib/labkit/rate_limit/evaluator.rb

+3 −2
Original line number Diff line number Diff line
@@ -287,9 +287,10 @@ module Labkit 


      def log_error(error, identifier)

        @logger.warn(

          message: "rate_limit_error",

          name: @name,

          error: error.class.to_s,

          Labkit::Fields::ERROR_TYPE => "rate_limit_error",

          Labkit::Fields::CLASS_NAME => error.class.to_s,

          Labkit::Fields::ERROR_MESSAGE => error.message,

          identifier: identifier&.to_h

        )

      end

spec/labkit/rate_limit/evaluator_spec.rb

+15 −3
Original line number Diff line number Diff line
@@ -423,7 +423,11 @@ RSpec.describe Labkit::RateLimit::Evaluator do 


      logger = instance_double(Labkit::Logging::JsonLogger)

      expect(logger).to receive(:warn).with(

        hash_including(message: "rate_limit_error", error: "RuntimeError")

        hash_including(

          Labkit::Fields::ERROR_TYPE => "rate_limit_error",

          Labkit::Fields::CLASS_NAME => "RuntimeError",

          Labkit::Fields::ERROR_MESSAGE => "connection refused"

        )

      )



      ev = described_class.new(name: "rack_request", rules: [peek_rule], redis: faulty_redis, logger: logger)
@@ -526,7 +530,11 @@ RSpec.describe Labkit::RateLimit::Evaluator do 


      logger = instance_double(Labkit::Logging::JsonLogger)

      expect(logger).to receive(:warn).with(

        hash_including(message: "rate_limit_error", error: "RuntimeError")

        hash_including(

          Labkit::Fields::ERROR_TYPE => "rate_limit_error",

          Labkit::Fields::CLASS_NAME => "RuntimeError",

          Labkit::Fields::ERROR_MESSAGE => "connection refused"

        )

      )



      rule = make_rule(name: "err_rule")
@@ -1031,7 +1039,11 @@ RSpec.describe Labkit::RateLimit::Evaluator do 
      broken_pool = PooledRedis.new(broken)

      logger = instance_double(Labkit::Logging::JsonLogger)

      expect(logger).to receive(:warn).with(

        hash_including(message: "rate_limit_error", error: "RuntimeError")

        hash_including(

          Labkit::Fields::ERROR_TYPE => "rate_limit_error",

          Labkit::Fields::CLASS_NAME => "RuntimeError",

          Labkit::Fields::ERROR_MESSAGE => "connection refused"

        )

      )



      rule = make_rule(name: "uniq_rule", count_distinct: :project)