gitlab-labkit 0.29.0 → 0.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959c572170b2eacd0d0886603f9bac07fea6e85d45b12a66f8048a822d0ac2f8
-  data.tar.gz: 8e63111f0c1fb923f482a68845a2c92f550323e63f048a633f06ef7b5dd63135
+  metadata.gz: b1307834ccc43bf7c67a2869284eb88596f8bc179aa23ffc54850c3094cb1e92
+  data.tar.gz: bf1e7c8464a5d6412673b98e957e7d725fce091408f9e79ab0eebead46afd432
 SHA512:
-  metadata.gz: e6a475fa4b31747f731ddffc6fe0439795f060c7aa2e743d214ec9629708ecfd8c03abfd2532a6482a5ef5259f121333c113253fb13860487de1e345fbc75a30
-  data.tar.gz: 7f30c1a8cfb9a36313045bc2d1beed7df127bd97dd01deba6880eba4e7c6f82bd2705cb30d2759dd6f01579dd46652e4d07e1eef67a792f7087f6e3d4f451f26
+  metadata.gz: 668d57c1c15b3e54dda7fa7906de490494725d07854d6ae60118a2973b2c51034a35e12765ab66a805d73d5e664c866574ae3e0d4c247b97355c87caabe25954
+  data.tar.gz: 04cde34debf83ad8fe76bf3207c99a8f83bbee367e0c9636f717f710286b4423ef66894e4803a99f21c0843518a49fc222e554389decd3348f7aea9a392eab22

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+2.7.7

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.7

data/lib/labkit/logging/json_logger.rb

@@ -6,6 +6,19 @@ require "json"
 module Labkit
   module Logging
     class JsonLogger < ::Logger
+      # We should also reject log keys coming from Labkit::Context, but we cannot
+      # do this without breaking clients currently. This is tracked in
+      # https://gitlab.com/gitlab-org/ruby/gems/labkit-ruby/-/issues/35
+      RESERVED_LOG_KEYS = [
+        :environment,
+        :host,
+        :shard,
+        :stage,
+        :subcomponent,
+        :tier,
+        :type,
+      ].freeze
+
       def self.log_level(fallback: ::Logger::DEBUG)
         ENV.fetch("GITLAB_LOG_LEVEL", fallback)
       end
@@ -24,6 +37,7 @@ module Labkit
         when String
           data[:message] = message
         when Hash
+          reject_reserved_log_keys!(message)
           data.merge!(message)
         end
 
@@ -39,6 +53,16 @@ module Labkit
       def dump_json(data)
         JSON.generate(data)
       end
+
+      def reject_reserved_log_keys!(hash)
+        return if ENV["RAILS_ENV"] == "production"
+
+        reserved_keys_used = hash.transform_keys(&:to_sym).slice(*RESERVED_LOG_KEYS)
+        if reserved_keys_used.any?
+          raise "The following log keys used are reserved: #{reserved_keys_used.keys.join(", ")}" +
+                  "\n\nUse key names that are descriptive e.g. by using a prefix."
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.1
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-25 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -372,6 +372,7 @@ files:
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - ".rufo"
+- ".tool-versions"
 - CONTRIBUTING.md
 - Dangerfile
 - Gemfile