gitlab-labkit 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3269b7b18f723ade60333e9e3d40216fde75dc5e1ab338d5970be043ee0b4146
-  data.tar.gz: 344f0595a78eaf3ae471fbc569d9abb43bb190de9423e351681ea5a0243f5bd8
+  metadata.gz: dd0d698d4683c94ad8c37047253ab83f4504b17a7a3162a822660b1e42512d3e
+  data.tar.gz: dedef03b41c33466eeec83483b82bb20e9e30987493b104cda3c14a6b2b55003
 SHA512:
-  metadata.gz: 3921f2408e5c7c33f20b82ca43825f5818c4b843aba4ab5b0ac99cb3a361dafa9884c39c03c1706a2890a58ac8d39ddcff84e5bf9b417c8a5f70d03d2177762d
-  data.tar.gz: 016b1990785aab0f54e16cbf97335931467d308c9169057796da64272941f8dd0c082ff01022f655cb590a52888b4473f18a41c50451d0b8a9abf56dc6ce822e
+  metadata.gz: e7f5b41fc2d7b844d0b553a206136824de6f9a470e30e96281191590cc4a879eb7243e3fa6deb70452b79959a0536c77a4d2d6fbd7e7af225b076f2c72e6effc
+  data.tar.gz: 6bc549eb4aecdcb9ed93b6309fd7cbec8add69b816a19a25eb06be7f1ee7670d2a6f82e9555758b6fa567ce4b4860a7fd374386ea8a679d3bc14785ceaef4426

data/gitlab-labkit.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   # Please maintain alphabetical order for dev dependencies
   spec.add_development_dependency "excon", "~> 0.78.1"
-  spec.add_development_dependency "faraday", "~> 1.2.0"
+  spec.add_development_dependency "faraday", "~> 1.0"
   spec.add_development_dependency "gitlab-dangerfiles", "~> 2.11.0"
   spec.add_development_dependency "gitlab-styles", "~> 6.2.0"
   spec.add_development_dependency "grpc-tools", ">= 1.37"

data/lib/labkit/context.rb

@@ -26,7 +26,6 @@ module Labkit
     LOG_KEY = "meta"
     CORRELATION_ID_KEY = "correlation_id"
     RAW_KEYS = [CORRELATION_ID_KEY].freeze
-    HEADER_PREFIX = "X-Gitlab-"
 
     class << self
       def with_context(attributes = {})
@@ -71,10 +70,6 @@ module Labkit
         @known_log_keys ||= (KNOWN_KEYS.map(&method(:log_key)) + RAW_KEYS).freeze
       end
 
-      def header_name(name)
-        HEADER_PREFIX + log_key(name).titlecase(keep_id_suffix: true).gsub(/\W/, "-")
-      end
-
       private
 
       def contexts
@@ -103,12 +98,6 @@ module Labkit
       data[CORRELATION_ID_KEY]
     end
 
-    def to_headers
-      to_h.except(CORRELATION_ID_KEY).transform_keys do |key|
-        self.class.header_name(key)
-      end
-    end
-
     def get_attribute(attribute)
       raw = call_or_value(data[log_key(attribute)])
 

data/lib/labkit/logging/json_logger.rb

@@ -23,6 +23,15 @@ module Labkit
         ENV.fetch("GITLAB_LOG_LEVEL", fallback)
       end
 
+      def self.exclude_context!
+        @exclude_context = true
+        self
+      end
+
+      def self.exclude_context?
+        !!@exclude_context
+      end
+
       def initialize(path, level: JsonLogger.log_level)
         super
       end
@@ -31,7 +40,12 @@ module Labkit
         data = default_attributes
         data[:severity] = severity
         data[:time] = timestamp.utc.iso8601(3)
-        data.merge!(Labkit::Context.current.to_h)
+
+        if self.class.exclude_context?
+          data[Labkit::Correlation::CorrelationId::LOG_KEY] = Labkit::Correlation::CorrelationId.current_id
+        else
+          data.merge!(Labkit::Context.current.to_h)
+        end
 
         case message
         when String

data/lib/labkit/middleware/rack.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 require "action_dispatch"
+require "json"
 
 module Labkit
   module Middleware
+    HEADER = "X-Gitlab-Meta"
+
     # This is a rack middleware to be inserted in GitLab-rails
     # It makes sure that there's always a root context containing the correlation
     # id.
@@ -15,8 +18,12 @@ module Labkit
       end
 
       def call(env)
-        Labkit::Context.with_context(Labkit::Context::CORRELATION_ID_KEY => correlation_id(env)) do
-          @app.call(env)
+        Labkit::Context.with_context(Labkit::Context::CORRELATION_ID_KEY => correlation_id(env)) do |context|
+          status, headers, response = @app.call(env)
+
+          headers[HEADER] = context_to_json(context)
+
+          [status, headers, response]
         end
       end
 
@@ -29,6 +36,14 @@ module Labkit
       def request(env)
         ActionDispatch::Request.new(env)
       end
+
+      def context_to_json(context)
+        context
+          .to_h
+          .transform_keys { |k| k.delete_prefix("meta.") }
+          .merge("version" => "1")
+          .to_json
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -146,14 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: gitlab-dangerfiles
   requirement: !ruby/object:Gem::Requirement