gitlab-labkit 1.10.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce9130ded76934b6e21e82724c7371548b9e790e451179a7e70cd14f545969d7
-  data.tar.gz: 1463999f63f123911a57a45d6943fb68e25daa07338cc2afd49f9592cb71ffb0
+  metadata.gz: e8c136c0ed8617c5023574687e1b1284621726be410583eb7ee17586fe56c20e
+  data.tar.gz: f9f496d1b6ea56d986b577052f8f50c7a91f1114307af3bd9856734c482afac1
 SHA512:
-  metadata.gz: df940f5abe8e939c2bb84440ed9ad340dc2e4a359dddc330d752f778e1d9c7c5aa2a6d19ee233081a7fc0cfd512e7cf5e54ad44fd419d11b2d0f85030ad6fd56
-  data.tar.gz: eee7205f950d1c9bf59060d25d0e5e7a196dadc98b521064813014129e022b2e3c9a5adfad68332b4ba1e2b9f75cbe6a6e8625cc228daa9d2976edbc05a31c25
+  metadata.gz: caed2e7c544c73856cd6a47a0f63655038f636674cf5070a0cb4b5330c2beda0c07ff0a7352b5d367f293ae818ecf08aa414316485f5cc6a262595c5240f334c
+  data.tar.gz: 7c3b49fc037060c21ea36e49e4878f99640e241b5a7358665fddf6bdde354ac26ddda80c87b11f5de183c4a259a9b2d6c8629818a852078393487c1c78ef6ba1

data/lib/labkit/fields.rb

@@ -80,6 +80,28 @@ module Labkit
     # request receipt to first response byte written.
     TTFB_S = "ttfb_s"
 
+    # GitLab project numeric ID.
+    GL_PROJECT_ID = "gl_project_id"
+
+    # GitLab pipeline numeric ID.
+    GL_PIPELINE_ID = "gl_pipeline_id"
+
+    # Log event timestamp in ISO 8601 format (e.g. "2026-04-02T12:00:00.000Z").
+    TIMESTAMP = "timestamp"
+
+    # Log severity level (e.g. "info", "warn", "error").
+    SEVERITY = "severity"
+
+    # Human-readable log message describing the event.
+    LOG_MESSAGE = "message"
+
+    # Class name associated with a log event (e.g. exception class or worker
+    # class).
+    CLASS_NAME = "class_name"
+
+    # Name of the service or component emitting the log event.
+    SERVICE_NAME = "service_name"
+
     # Get the constant name for a field value
     # @param field_value [String] The field value (e.g., "gl_user_id")
     # @return [String, nil] The constant name (e.g., "GL_USER_ID") or nil if not found
@@ -97,8 +119,22 @@ module Labkit
       # to identify and track usage of deprecated fields in the codebase.
 
       MAPPINGS = {
-        Fields::GL_USER_ID => %w[user_id userid],
-        Fields::HTTP_STATUS_CODE => %w[status_code extra.status status_text],
+        Fields::CORRELATION_ID => %w[tags.correlation_id],
+        Fields::GL_USER_ID => %w[user_id userid extra.user_id extra.current_user_id meta.user_id],
+        Fields::GL_USER_NAME => %w[username extra.user meta.user],
+        Fields::ERROR_MESSAGE => %w[error err error.message exception.message graphql_errors],
+        Fields::HTTP_STATUS_CODE => %w[status_code extra.status status_text http_status],
+        Fields::HTTP_URL => %w[req_url],
+        Fields::DURATION_S => %w[duration duration_ms elapsed_time actual_duration time_ms total_time gitaly.duration],
+        Fields::REMOTE_IP => %w[ip source_ip ip_address meta.remote_ip],
+        Fields::HTTP_HOST => %w[hostname request_host gitlab_host kubernetes.host],
+        Fields::GL_PROJECT_ID => %w[extra.project_id meta.project_id meta.search.project_id job_project_id target_project_id],
+        Fields::GL_PIPELINE_ID => %w[extra.pipeline_id meta.pipeline_id root_pipeline_id],
+        Fields::TIMESTAMP => %w[start_time],
+        Fields::SEVERITY => %w[level],
+        Fields::LOG_MESSAGE => %w[msg custom_message extra.message fields.message graphql.message reason color_message exception.gitaly],
+        Fields::CLASS_NAME => %w[class author_class exception.class extra.class extra.class_name],
+        Fields::SERVICE_NAME => %w[service grpc.service_name auth_service type component subcomponent],
       }.freeze
 
       class << self

data/lib/labkit/user_experience_sli/experience.rb

@@ -61,7 +61,8 @@ module Labkit
       #
       # @yield [self] When a block is provided, the experience will be completed automatically.
       # @param extra [Hash] Additional data to include in the log event
-      # @return [self]
+      # @return [self] When no block is given.
+      # @return [Object] The result of the block when a block is given.
       # @raise [UserExperienceError] If the block raises an error.
       #
       # Usage:
@@ -104,7 +105,9 @@ module Labkit
       # Resume the User Experience.
       #
       # @yield [self] When a block is provided, the experience will be completed automatically.
-      # @param extra [Hash] Additional data to include in the log
+      # @param extra [Hash] Additional data to include in the log event
+      # @return [self] When no block is given.
+      # @return [Object] The result of the block when a block is given.
       def resume(**extra, &)
         return self unless ensure_started!
 
@@ -190,16 +193,12 @@ module Labkit
       end
 
       def completable(**extra, &)
-        begin
-          yield self
-        rescue StandardError => e
-          error!(e)
-          raise
-        ensure
-          complete(**extra)
-        end
-
-        self
+        yield self
+      rescue StandardError => e
+        error!(e)
+        raise
+      ensure
+        complete(**extra)
       end
 
       def ensure_incomplete!

data/lib/labkit/user_experience_sli/null.rb

@@ -11,12 +11,14 @@ module Labkit
       def id = 'null'
 
       def start(**_extra)
-        yield self if block_given?
+        return yield(self) if block_given?
+
         self
       end
 
       def resume(**_extra)
-        yield self if block_given?
+        return yield(self) if block_given?
+
         self
       end
 

metadata

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