gitlab-labkit 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1092d43de21613288d5ed802539e0eeab87bee9e8975e223f78aa29116f6cb2d
-  data.tar.gz: 7a4953fd47e09da3cc2f4657cbe563648fec3ea0f0ae63d47e0bf49610b3b39d
+  metadata.gz: 63bc67bcb0041f919748393e6ace8e96d29bcd88e2c5b0e08b8baad8968670b1
+  data.tar.gz: 5bd9b55ece983433e125c7cd087030d740647101a48e9af1f97f1aa68ed51db4
 SHA512:
-  metadata.gz: 5f885a5454c551e8adc0fd4ad8ca99c81bbc438a61b4787e122fae02f966062d8006c9766cb98f73d2e4c4465a3d5c3a3dd9fe13e44eb76ca21816b1c60571a1
-  data.tar.gz: b11dc29d11ea325ea787af6ad1827bb9963146427d0930c38089b4f1901d21e1faca20437f52cd4a4f8de7b7de85fc0de2932cdcc5f8279c8e9fbe1cd77f711b
+  metadata.gz: 61d298ae9cb7c584d6e9979fbdb25fc112b705a8f1c0022825192e2759356408cbe6c03caf339ae5140220e325dc90532f24775a1f76decf1eb1547269cf3aba
+  data.tar.gz: 3755c6de56d994d081210d1cae48430d9938420c6ac33932ce672f3c20eee86457742ce75966bbd2163c09807a4b4e4c72e82579f8eba262e25cb1b79204ce1f

data/lib/labkit/rate_limit/evaluator.rb

@@ -12,6 +12,12 @@ module Labkit
       CHAR_VALUE_MAX_LENGTH = 200
       MISSING_VALUE_SENTINEL = "_unknown_"
 
+      # Carries the rule in flight out of the rule loop and into the rescue in
+      # #check/#peek, where the error is seen but the rule is out of scope.
+      # Per call, not instance state: one Evaluator serves concurrent requests.
+      # Only read while an exception unwinds; nil means no rule was in flight.
+      RuleCursor = Struct.new(:rule)
+
       # Atomic increment-with-TTL Lua script. The whole script runs as one
       # operation from Redis's perspective, so there is no window between
       # the increment and EXPIRE that can leak a key without TTL.
@@ -68,12 +74,13 @@ module Labkit
       end
 
       def check(identifier, cost: 1, rule_context: nil)
-        check_rules(identifier, cost, rule_context)
+        cursor = RuleCursor.new
+        check_rules(identifier, cost, rule_context, cursor)
       rescue StandardError => e
         # Intentionally broad: fail-open applies to any unexpected error (network,
         # timeout, OOM) not only Redis protocol errors.
         report_error_metrics
-        log_error(e, identifier)
+        log_error(e, identifier, cursor.rule)
         Result.error
       end
 
@@ -81,10 +88,11 @@ module Labkit
       # shape; the underlying Redis counter is not mutated and the TTL is not
       # extended. A missing Redis key is treated as count=0 (matched, not exceeded).
       def peek(identifier, rule_context: nil)
-        peek_rules(identifier, rule_context)
+        cursor = RuleCursor.new
+        peek_rules(identifier, rule_context, cursor)
       rescue StandardError => e
         report_error_metrics
-        log_error(e, identifier)
+        log_error(e, identifier, cursor.rule)
         Result.error
       end
 
@@ -117,11 +125,14 @@ module Labkit
       # counters were incremented. No blocking verdict is lost that way - a
       # :limit rule over its limit returns before any later rule can raise -
       # but a rule declared after the failing one loses its chance to block.
-      # The request is counted and allowed.
-      def check_rules(identifier, cost, rule_context)
+      # The request is counted and allowed. +cursor+ is set before the match, so
+      # a raise from the match itself (e.g. Regexp::TimeoutError) is attributed.
+      def check_rules(identifier, cost, rule_context, cursor)
         result = Result.new
 
         @rules.each do |rule|
+          cursor.rule = rule
+
           next unless rule_matches?(rule, identifier)
 
           if rule.action == :skip
@@ -141,6 +152,9 @@ module Labkit
           return result if result.block?
         end
 
+        # The loop is done, so anything raised from here on belongs to no rule.
+        cursor.rule = nil
+
         report_unmatched_metrics unless result.matched?
         result
       end
@@ -152,10 +166,12 @@ module Labkit
       # peek does not need the count_distinct identifier key - it reads SCARD on
       # the rule-keyed compound key, which contains the cardinality across all
       # members. So missing-key fail-open does not apply here.
-      def peek_rules(identifier, rule_context)
+      def peek_rules(identifier, rule_context, cursor)
         result = Result.new
 
         @rules.each do |rule|
+          cursor.rule = rule
+
           next unless rule_matches?(rule, identifier)
 
           return result.skip!(rule) if rule.action == :skip
@@ -164,6 +180,8 @@ module Labkit
           return result if result.block?
         end
 
+        cursor.rule = nil
+
         result
       end
 
@@ -319,9 +337,14 @@ module Labkit
         end
       end
 
-      def log_error(error, identifier)
+      # rule is nil when the error was raised with no rule in flight - before the
+      # loop reached one, or after it finished - so the field is logged as null
+      # rather than omitted, the same way identifier is. A named rule is the rule
+      # whose match or evaluation raised.
+      def log_error(error, identifier, rule = nil)
         @logger.warn(
           name: @name,
+          rule: rule&.name,
           Labkit::Fields::ERROR_TYPE => "rate_limit_error",
           Labkit::Fields::CLASS_NAME => error.class.to_s,
           Labkit::Fields::ERROR_MESSAGE => error.message,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Andrew Newdigate