gitlab-labkit 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959c572170b2eacd0d0886603f9bac07fea6e85d45b12a66f8048a822d0ac2f8
-  data.tar.gz: 8e63111f0c1fb923f482a68845a2c92f550323e63f048a633f06ef7b5dd63135
+  metadata.gz: b4b144027d3b759c387a532a28c949d4551e6af5bc058d886d8a0f15f7156ddd
+  data.tar.gz: 40650117c553316ffb3260ddde7c50005287856ded9dec86339dc33b8c4b73d6
 SHA512:
-  metadata.gz: e6a475fa4b31747f731ddffc6fe0439795f060c7aa2e743d214ec9629708ecfd8c03abfd2532a6482a5ef5259f121333c113253fb13860487de1e345fbc75a30
-  data.tar.gz: 7f30c1a8cfb9a36313045bc2d1beed7df127bd97dd01deba6880eba4e7c6f82bd2705cb30d2759dd6f01579dd46652e4d07e1eef67a792f7087f6e3d4f451f26
+  metadata.gz: 19bf82ef843b8bc1ec633d50065c674d95f9ade7c0b3bcc2e9a9764972b650c4497f5741dffb95c9e30df0b5a7b7d68af601007f27396aa875bfe85573df6e26
+  data.tar.gz: 957be0fe6bcc5a00f8565c9c2e55de978032586fc6749ab4b0b2fc1a8ca5a1e92ff547b2a3ea2d489d28c54f77b39eef97ae54eb2e0419afe2b3be04e4e091a5

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,17 @@ require "json"
 module Labkit
   module Logging
     class JsonLogger < ::Logger
+      INTERNAL_LOG_KEYS = Labkit::Context::RAW_KEYS + [Labkit::Context::LOG_KEY]
+      RESERVED_LOG_KEYS = INTERNAL_LOG_KEYS.map(&:to_sym) + [
+        :environment,
+        :host,
+        :shard,
+        :stage,
+        :subcomponent,
+        :tier,
+        :type,
+      ].freeze
+
       def self.log_level(fallback: ::Logger::DEBUG)
         ENV.fetch("GITLAB_LOG_LEVEL", fallback)
       end
@@ -24,6 +35,7 @@ module Labkit
         when String
           data[:message] = message
         when Hash
+          reject_reserved_log_keys!(message)
           data.merge!(message)
         end
 
@@ -39,6 +51,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.0
 platform: ruby
 authors:
 - Andrew Newdigate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-25 00:00:00.000000000 Z
+date: 2023-02-09 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