gitlab-labkit 0.41.1 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9f3f7db908df4f839a96f74ce39650dad4a132e5b72e3ac4d7fb1358bc48f1
-  data.tar.gz: 125b63a4f1716bfbb8dca8ab986c5f824dd2a56f8df46079041c6c62f5e385e5
+  metadata.gz: a34b2991af0968bfb934925fb5a71ac0206224a6ffdfe65ba026fa0dc9a56dc3
+  data.tar.gz: 001d8f998218b85fb6da441681197211d2d13a21d36bff3218e3f142fbfd2d0d
 SHA512:
-  metadata.gz: 92907d96e457abebe07567df0506f80c585f159ead4b78b6bdf8c57b3eb82d19c7700b88d2733415dad5c0d3bba792c23ae9b1e2281df9fef6ec44b7069d453c
-  data.tar.gz: 678ab5ad3290e93ff0682ef1f5f08681ea85e01c65919c3c16f21c95949065fa70c20507499b20c2c72f1a856838650fe79963533b529a463d9fc5a6f99a3bfc
+  metadata.gz: d294b0a1f9c935bf723082a0e470ea1774c150c755511f5f8aa879611e48aec0d7b268758d908af4ccccbcfa957b7df5c940d11b7a37237f433fa7e8a2d0011e
+  data.tar.gz: fb075af43298d662526fb561eff09bccd38dcce8d6b58f740e165a13dc9fca9e3e3391e67e114c11f317814ce0dbc687c1509ddcac491d9c4b4a4c1cdf8b03e4

data/.pre-commit-config.yaml

@@ -25,7 +25,7 @@ repos:
   # Documentation available at
   # https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/docs/pre-commit.md
   - repo: https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks
-    rev: v2.92  # renovate:managed
+    rev: v2.93  # renovate:managed
 
     hooks:
       - id: shellcheck  # Run shellcheck for changed Shell files

data/lib/gitlab-labkit.rb

@@ -15,6 +15,7 @@ module Labkit
   autoload :Logging, "labkit/logging"
   autoload :Metrics, "labkit/metrics"
   autoload :Middleware, "labkit/middleware"
+  autoload :Fields, "labkit/fields"
 
   # Publishers to publish notifications whenever a HTTP reqeust is made.
   # A broadcasted notification's payload in topic "request.external_http" includes:

data/lib/labkit/context.rb

@@ -7,6 +7,8 @@ require "active_support/core_ext/string/starts_ends_with"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/object/blank"
 
+require_relative "fields"
+
 module Labkit
   # A context can be used to provide structured information on what resources
   # GitLab is working on within a service.
@@ -24,9 +26,14 @@ module Labkit
   #   end
   #
   class Context
+    # The meta log key is used to effectively aggregate
+    # the attributes that we should be associating with
+    # the logs that we emit.
+    # These fields will get propagated across all services
+    # which will allow us to correlate logs across these
+    # different services.
     LOG_KEY = "meta"
-    CORRELATION_ID_KEY = "correlation_id"
-    RAW_KEYS = [CORRELATION_ID_KEY].freeze
+    RAW_KEYS = [Fields::CORRELATION_ID].freeze
 
     class << self
       def with_context(attributes = {})
@@ -92,7 +99,7 @@ module Labkit
     end
 
     def correlation_id
-      data[CORRELATION_ID_KEY]
+      data[Fields::CORRELATION_ID]
     end
 
     def get_attribute(attribute)
@@ -113,7 +120,7 @@ module Labkit
 
       # Assign a correlation if it was missing in the first context or when
       # explicitly removed
-      data[CORRELATION_ID_KEY] ||= new_id
+      data[Fields::CORRELATION_ID] ||= new_id
 
       data
     end

data/lib/labkit/correlation/correlation_id.rb

@@ -5,11 +5,11 @@ module Labkit
     # CorrelationId module provides access the Correlation-ID
     # of the current request
     module CorrelationId
-      LOG_KEY = Labkit::Context::CORRELATION_ID_KEY
-
       class << self
         def use_id(correlation_id)
-          Labkit::Context.with_context(LOG_KEY => correlation_id) do |context|
+          Labkit::Context.with_context(
+            Labkit::Fields::CORRELATION_ID => correlation_id
+          ) do |context|
             yield(context.correlation_id)
           end
         end

data/lib/labkit/covered_experience/experience.rb

@@ -92,7 +92,7 @@ module Labkit
       # @param extra [Hash] Additional data to include in the log event
       # @return [self]
       def checkpoint(**extra)
-        return unless ensure_started!
+        return self unless ensure_started!
 
         @checkpoint_time = Time.now.utc
         checkpoint_counter.increment(checkpoint: "intermediate", **base_labels)
@@ -106,7 +106,7 @@ 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
       def resume(**extra, &)
-        return unless ensure_started!
+        return self unless ensure_started!
 
         checkpoint(checkpoint_action: 'resume', **extra)
 
@@ -120,8 +120,7 @@ module Labkit
       # @param extra [Hash] Additional data to include in the log event
       # @return [self]
       def complete(**extra)
-        return unless ensure_started!
-        return unless ensure_incomplete!
+        return self unless ensure_started! && ensure_incomplete!
 
         begin
           @end_time = Time.now.utc

data/lib/labkit/fields.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Labkit
+  ##
+  # Fields is intended to be a SSOT for all of the common field names that
+  # we emit via any observability we add to our systems.
+  #
+  # These fields should span multiple services. This is
+  #
+  # The goal of this package is to reduce the likelihood for typos or
+  # subtly different naming conventions. This will help to ensure we
+  # are able to marry up logs between different systems as a request
+  # is being processed.
+  #
+  # Usage:
+  #   require 'labkit/fields'
+  #   ...
+  #   data[Labkit::Fields::GL_USER_ID] = user.id
+  #   ...
+  #
+  module Fields
+    # correlation_id - string
+    #
+    # This field is used to correlate
+    # the logs emitted by all of our systems.
+    #
+    # This should be present in all log line
+    # emissions.
+    CORRELATION_ID = "correlation_id"
+
+    # We'll need to add the rest of the top
+    # level fields here:
+    # [endpoint_id, duration_s, status_code]
+
+    # gl_user_id - integer
+    GL_USER_ID = "gl_user_id"
+
+    # gl_user_name - string
+    GL_USER_NAME = "gl_user_name"
+  end
+end

data/lib/labkit/logging/json_logger.rb

@@ -42,7 +42,7 @@ module Labkit
         data[:time] = timestamp.utc.iso8601(3)
 
         if self.class.exclude_context?
-          data[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
+          data[Labkit::Fields::CORRELATION_ID] = Labkit::Correlation::CorrelationId.current_id
         else
           data.merge!(Labkit::Context.current.to_h)
         end

data/lib/labkit/middleware/rack.rb

@@ -18,7 +18,7 @@ module Labkit
       end
 
       def call(env)
-        Labkit::Context.with_context(Labkit::Context::CORRELATION_ID_KEY => correlation_id(env)) do |context|
+        Labkit::Context.with_context(Labkit::Fields::CORRELATION_ID => correlation_id(env)) do |context|
           status, headers, response = @app.call(env)
 
           headers[HEADER] = context_to_json(context)

data/lib/labkit/middleware/sidekiq/context/client.rb

@@ -15,7 +15,7 @@ module Labkit
             # will always generate a new correlation_id and we'd rather carry
             # through the correlation_id from the previous job if it is
             # present (eg. for retries).
-            attributes[Labkit::Context::CORRELATION_ID_KEY] = job["correlation_id"] if job["correlation_id"]
+            attributes[Labkit::Fields::CORRELATION_ID] = job["correlation_id"] if job["correlation_id"]
 
             Labkit::Context.with_context(attributes) do |context|
               job.merge!(context.to_h)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.41.1
+  version: 0.42.0
 platform: ruby
 authors:
 - Andrew Newdigate
@@ -466,6 +466,7 @@ files:
 - lib/labkit/covered_experience/null.rb
 - lib/labkit/covered_experience/registry.rb
 - lib/labkit/excon_publisher.rb
+- lib/labkit/fields.rb
 - lib/labkit/fips.rb
 - lib/labkit/httpclient_publisher.rb
 - lib/labkit/logging.rb