gitlab-labkit 1.5.0 → 1.12.0

data/lib/labkit/tracing/auto_initialize.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "cgi"
+require "uri"
 require "active_support/core_ext/object/blank"
 
 module Labkit
@@ -9,9 +9,16 @@ module Labkit
       def self.detect_service_name(connection_string)
         return Labkit::Tracing::DEFAULT_SERVICE_NAME unless connection_string
 
-        if connection_string =~ /[?&]service_name=([^&]+)/
-          CGI.unescape(Regexp.last_match(1))
-        else
+        begin
+          parsed = URI.parse(connection_string)
+          options = TracingUtils.parse_query_string(parsed.query)
+
+          return options[:service_name] if options[:service_name]
+
+          warn "Labkit::Tracing: service_name not found in connection string, using default: '#{Labkit::Tracing::DEFAULT_SERVICE_NAME}'"
+          Labkit::Tracing::DEFAULT_SERVICE_NAME
+        rescue URI::InvalidURIError => e
+          warn "Labkit::Tracing: Invalid connection string (#{e.message}), using default service name: '#{Labkit::Tracing::DEFAULT_SERVICE_NAME}'"
           Labkit::Tracing::DEFAULT_SERVICE_NAME
         end
       end
@@ -22,9 +29,24 @@ module Labkit
 
         service_name = detect_service_name(connection_string)
 
+        require "opentelemetry/instrumentation/concurrent_ruby"
+        require "opentelemetry/instrumentation/net/http"
+        require "opentelemetry/instrumentation/action_pack" if defined?(ActionPack)
+        require "opentelemetry/instrumentation/action_mailer" if defined?(ActionMailer)
+        require "opentelemetry/instrumentation/active_job" if defined?(ActiveJob)
+
         Factory.create_tracer(service_name, connection_string) do |c|
-          require "opentelemetry/instrumentation/all"
-          c.use_all
+          # Enable only non-conflicting instrumentations
+          # Exclude: ActiveSupport, ActiveRecord, ActionView, Redis, Rack, Sidekiq
+          # (LabKit provides its own instrumentation for these via AbstractInstrumenter)
+
+          # Core instrumentations
+          c.use("OpenTelemetry::Instrumentation::ConcurrentRuby")
+
+          # Rails components that don't conflict with LabKit
+          c.use("OpenTelemetry::Instrumentation::ActionPack") if defined?(ActionPack)
+          c.use("OpenTelemetry::Instrumentation::ActionMailer") if defined?(ActionMailer)
+          c.use("OpenTelemetry::Instrumentation::ActiveJob") if defined?(ActiveJob)
         end
 
         enable_labkit_instrumentation

data/lib/labkit/tracing/external_http/request_instrumenter.rb

@@ -12,20 +12,11 @@ module Labkit
         def tags(payload)
           # Duration is calculated by start and end time
           # Exception is already captured in lib/labkit/tracing/tracing_utils.rb
-          tags = {
-            "component" => "external_http",
-            "method" => payload[:method],
-            "code" => payload[:code],
-            "host" => payload[:host],
-            "port" => payload[:port],
-            "path" => payload[:path],
-            "scheme" => payload[:scheme],
-          }
+          tags = payload.slice(:method, :code, :host, :port, :path, :scheme, :proxy_host, :proxy_port)
+          tags.transform_keys!(&:name)
+          tags["component"] = "external_http"
 
-          unless payload[:proxy_host].nil?
-            tags["proxy_host"] = payload[:proxy_host]
-            tags["proxy_port"] = payload[:proxy_port]
-          end
+          tags.compact!
 
           tags
         end

data/lib/labkit/tracing/open_telemetry_factory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "base64"
-require "cgi"
+require "cgi/escape"
 require "active_support"
 require "active_support/core_ext"
 
@@ -79,14 +79,10 @@ module Labkit
               yield(c)
             end
 
-            # SDK.configure doesn't expose sampler configuration directly
-            # We need to replace the tracer provider to set the sampler
-            # This is a known limitation of the OpenTelemetry Ruby SDK
             current_provider = OpenTelemetry.tracer_provider
             return unless current_provider.is_a?(OpenTelemetry::SDK::Trace::TracerProvider)
 
-            # Create new provider with sampler, preserving resource from SDK.configure
-            create_and_configure_provider(current_provider.resource, sampler, exporter)
+            current_provider.sampler = sampler
           else
             create_and_configure_provider(base_resource, sampler, exporter)
           end
@@ -175,7 +171,7 @@ module Labkit
           parsed = URI.parse(connection_string)
 
           # Parse query parameters for additional options
-          options = parse_query(parsed.query)
+          options = TracingUtils.parse_query_string(parsed.query)
 
           # Handle console exporter (special case - no endpoint needed)
           if parsed.host == "console"
@@ -206,12 +202,6 @@ module Labkit
 
           endpoint
         end
-
-        def parse_query(query)
-          return {} unless query
-
-          CGI.parse(query).symbolize_keys.transform_values(&:first)
-        end
       end
     end
   end

data/lib/labkit/tracing/open_tracing_factory.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "cgi"
-
 module Labkit
   module Tracing
     class OpenTracingFactory
@@ -26,17 +24,10 @@ module Labkit
 
         raise "Invalid tracing connection string" unless valid_uri?(parsed)
 
-        { driver_name: parsed.host, options: parse_query(parsed.query) }
+        { driver_name: parsed.host, options: TracingUtils.parse_query_string(parsed.query) }
       end
       private_class_method :parse_connection_string
 
-      def self.parse_query(query)
-        return {} unless query
-
-        CGI.parse(query).symbolize_keys.transform_values(&:first)
-      end
-      private_class_method :parse_query
-
       def self.valid_uri?(uri)
         return false unless uri
 

data/lib/labkit/tracing/rails/action_view/render_template_instrumenter.rb

@@ -16,7 +16,12 @@ module Labkit
           end
 
           def tags(payload)
-            { "component" => COMPONENT_TAG, "template.id" => payload[:identifier], "template.layout" => payload[:layout] }
+            tags = { "component" => COMPONENT_TAG }
+            # OpenTelemetry rejects nil attributes, and error templates may not
+            # have a layout (e.g., public/406-unsupported-browser.html).
+            tags["template.id"] = payload[:identifier] if payload[:identifier]
+            tags["template.layout"] = payload[:layout] if payload[:layout]
+            tags
           end
         end
       end

data/lib/labkit/tracing/rails/active_record/sql_instrumenter.rb

@@ -19,15 +19,20 @@ module Labkit
               fingerprint = Labkit::Logging::Sanitizer.sql_fingerprint(sql)
             end
 
-            {
+            tags = {
               "component" => COMPONENT_TAG,
               "span.kind" => "client",
               "db.type" => "sql",
-              "db.connection_id" => payload[:connection_id],
               "db.cached" => payload[:cached] || false,
-              "db.statement" => sql,
-              "db.statement_fingerprint" => fingerprint,
             }
+
+            # OpenTelemetry rejects nil attributes, so only add statement fields
+            # when ActiveRecord supplies SQL (schema events may omit it).
+            tags["db.statement"] = sql if sql
+            tags["db.statement_fingerprint"] = fingerprint if fingerprint
+            tags["db.connection_id"] = payload[:connection_id] if payload[:connection_id]
+
+            tags
           end
         end
       end

data/lib/labkit/tracing/tracing_utils.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "uri"
 require "active_support/core_ext/string/starts_ends_with"
 require "opentracing"
 
@@ -16,7 +17,7 @@ module Labkit
           begin
             yield span
           rescue StandardError => e
-            log_exception_on_span(span, e)
+            span.set_error(e)
             raise e
           end
         end
@@ -55,7 +56,7 @@ module Labkit
         span = tracer.start_span(operation_name, child_of: child_of, tags: tags, start_time: start_time)
 
         log_common_fields_on_span(span, operation_name)
-        log_exception_on_span(span, exception) if exception
+        span.set_error(exception)
 
         span.finish(end_timestamp: end_time)
       end
@@ -68,11 +69,6 @@ module Labkit
         span.log_event("stack", stack: caller.join('\n')) if include_stacktrace?(operation_name)
       end
 
-      # Add exception logging to a span
-      def self.log_exception_on_span(span, exception)
-        span.set_error(exception)
-      end
-
       def self.include_stacktrace?(operation_name)
         @include_stacktrace ||= Hash.new do |result, name|
           result[name] = Tracing.stacktrace_operations.any? { |stacktrace_operation| name.starts_with?(stacktrace_operation) }
@@ -80,6 +76,12 @@ module Labkit
 
         @include_stacktrace[operation_name]
       end
+
+      def self.parse_query_string(query)
+        return {} unless query
+
+        URI.decode_www_form(query).each_with_object({}) { |(k, v), h| h[k.to_sym] ||= v }
+      end
     end
   end
 end

data/lib/labkit/tracing.rb

@@ -30,7 +30,9 @@ module Labkit
       autoload :OpentracingTracer, "labkit/tracing/adapters/opentracing_tracer"
     end
 
-    DEFAULT_SERVICE_NAME = :'labkit-service'
+    # Must be a String, not Symbol, as OpenTelemetry requires resource attribute values
+    # to be strings, integers, floats, or booleans
+    DEFAULT_SERVICE_NAME = "labkit-service"
 
     # Module-level attribute for storing the configured service name
     # Set by Factory.create_tracer when a tracer is created

data/lib/labkit/user_experience_sli/README.md

@@ -161,6 +161,26 @@ experience.checkpoint
 experience.complete
 ```
 
+#### Observing a Past Experience
+
+When an action already happened and you want to record its duration retroactively, use `observed`. It fires the start and end metrics without registering in the active context:
+
+```ruby
+Labkit::UserExperienceSli.observed('merge_request_creation', start_time: start_time_of_past_action)
+```
+
+You can also signal that an error occurred during the action:
+
+```ruby
+Labkit::UserExperienceSli.observed('merge_request_creation', start_time: start_time_of_past_action, error: true)
+```
+
+Extra labels are forwarded to both the start and end log events:
+
+```ruby
+Labkit::UserExperienceSli.observed('merge_request_creation', start_time: start_time_of_past_action, worker: 'MyWorker')
+```
+
 #### Resuming Experiences
 
 You can resume a user experience SLI that was previously started and stored in the context. This is useful for distributed operations or when work spans multiple processes.

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!
 
@@ -135,6 +138,28 @@ module Labkit
         self
       end
 
+      # Records a past User Experience by its duration.
+      #
+      # @param start_time [Time] The time when the experience started.
+      # @param error [Boolean] Whether the experience ended in an error.
+      # @param extra [Hash] Additional data to include in the log events.
+      # @return [self]
+      def observed(start_time:, error: false, **extra)
+        @start_time = start_time.utc
+        @end_time = Time.now.utc
+        error!("observed_error") if error
+
+        checkpoint_counter.increment(checkpoint: "start", **base_labels)
+        log_event("start", **extra)
+
+        checkpoint_counter.increment(checkpoint: "end", **base_labels)
+        total_counter.increment(error: has_error?, **base_labels)
+        apdex_counter.increment(success: apdex_success?, **base_labels) unless has_error?
+        log_event("end", **extra)
+
+        self
+      end
+
       # Marks the experience as failed with an error
       #
       # @param error [StandardError, String] The error that caused the experience to fail.
@@ -168,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,15 +11,18 @@ 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
 
+      def observed(**_kwargs) = self
       def push_attributes!(*_args) = self
       def checkpoint(*_args) = self
       def complete(*_args) = self

data/lib/labkit/user_experience_sli.rb

@@ -77,7 +77,7 @@ module Labkit
         reset_configuration
       end
 
-      # Retrieves a covered experience using the experience_id.
+      # Retrieves a user experience using the experience_id.
       # It retrieves from the current context when available,
       # otherwise it instantiates a new experience with the definition
       # from the registry.
@@ -88,7 +88,7 @@ module Labkit
         find_current(experience_id) || raise_or_null(experience_id)
       end
 
-      # Starts a covered experience using the experience_id.
+      # Starts a user experience using the experience_id.
       #
       # @param experience_id [String, Symbol] The ID of the experience to start.
       # @param extra [Hash] Additional data to include in the log event.
@@ -97,7 +97,19 @@ module Labkit
         get(experience_id).start(**extra, &)
       end
 
-      # Resumes a covered experience using the experience_id.
+      # Records a past user experience by its duration atomically.
+      #
+      # @param experience_id [String, Symbol] The ID of the experience.
+      # @param start_time [Time] The time when the experience started.
+      # @param extra [Hash] Additional data to include in the log events.
+      # @return [Experience, Null] The observed experience or a Null object if not found (in production/staging).
+      def observed(experience_id, start_time:, **extra)
+        definition = registry[experience_id]
+        experience = definition ? Experience.new(definition) : raise_or_null(experience_id)
+        experience.observed(start_time: start_time, **extra)
+      end
+
+      # Resumes a user experience using the experience_id.
       #
       # @param experience_id [String, Symbol] The ID of the experience to resume.
       # @return [Experience, Null] The started experience or a Null object if not found (in production/staging).

data/scripts/prepare-dev-env.sh

@@ -54,6 +54,7 @@ fi
 # install mise/asdf dependencies
 echo "installing required plugins with mise install.."
 mise plugins update -q
+mise trust
 mise install
 
 # set PROMPT_COMMAND to empty value for mise if unset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Andrew Newdigate
@@ -267,14 +267,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.3
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.3
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: gitlab-dangerfiles
   requirement: !ruby/object:Gem::Requirement
@@ -525,6 +525,7 @@ files:
 - ".gitlab-ci-asdf-versions.yml"
 - ".gitlab-ci.yml"
 - ".gitlab/CODEOWNERS"
+- ".gitlab/merge_request_templates/default.md"
 - ".gitleaks.toml"
 - ".mise.toml"
 - ".pre-commit-config.yaml"
@@ -664,16 +665,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Instrumentation for GitLab
 test_files: []