gitlab-labkit 0.42.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cefb3ce3a1f0b663c7d4ac1a60d0b4ed3a6ecb8b170efac046f07e5d700a0b66
-  data.tar.gz: 3cb390d7949d332aaa959c03fe1a0d152100067e3822f0832327583972e7ad46
+  metadata.gz: 848c7a3b2a208349e041ead5190bb2f665190100e9c4868b3391f040674834b7
+  data.tar.gz: be220cf29fa57499b1101cabda163816fd37f77b09b5b3be93464cd87c6294b6
 SHA512:
-  metadata.gz: 74ac536ebabf46339787079b5c972c8541a4b3d3bd15a597395b110adb1c20fff19ec8bdb554fcf57fc4a36ecbe39c26369bf5c1f4fadfc309bfc5f96c3cb6ee
-  data.tar.gz: b3fa11140a2d30d29af280f76887afe57fa0b4c94eb4b73112d1dde67dfcf35a59bb1bb24e32827ea3c30cfddeb3ddcedb438923ca2d6199d72fc0b0182dd6fa
+  metadata.gz: e5e4181d842aa238bc113b4d1486471f71b44e3d04d7f8613583e2ae23eeb33a4c6e275a5fccb18b2db5a962c0e4ff294b2df7a6eb9bd6c08a8aaf88a9146a96
+  data.tar.gz: eeab7e40652242988f381b9192a9384a9098a7bd31ad8ef6e8f0b17c5c6f17032a8f2199f9b1fbe543e9d11ba04a30cb5c59a2b96d9bb86df3a30a026924e96f

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.98  # renovate:managed
+    rev: v3.0  # renovate:managed
 
     hooks:
       - id: shellcheck  # Run shellcheck for changed Shell files

data/gitlab-labkit.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   # Please maintain alphabetical order for dependencies
   spec.add_runtime_dependency "actionpack", ">= 5.0.0", "< 8.1.0"
   spec.add_runtime_dependency "activesupport", ">= 5.0.0", "< 8.1.0"
-  spec.add_runtime_dependency "grpc", ">= 1.62" # Be sure to update the "grpc-tools" dev_dependency too
+  spec.add_runtime_dependency "grpc", ">= 1.75" # Be sure to update the "grpc-tools" dev_dependency too
   spec.add_runtime_dependency "google-protobuf", "~> 3" # Keep the major version to 3 until we update the `grpc` gem
   spec.add_runtime_dependency "jaeger-client", "~> 1.1.0"
   spec.add_runtime_dependency 'json-schema', '~> 5.1'
@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "faraday", "~> 1.10.3"
   spec.add_development_dependency "gitlab-dangerfiles", "~> 2.11.0"
   spec.add_development_dependency "gitlab-styles", "~> 13.0.2"
-  spec.add_development_dependency "grpc-tools", ">= 1.62"
+  spec.add_development_dependency "grpc-tools", ">= 1.75"
   spec.add_development_dependency "httparty", "~> 0.22.0"
   spec.add_development_dependency "httpclient", "~> 2.9.0"
   spec.add_development_dependency "irb", "~> 1.15.2"

data/lib/labkit/fields.rb

@@ -18,24 +18,37 @@ module Labkit
   #   data[Labkit::Fields::GL_USER_ID] = user.id
   #   ...
   #
+  # Labkit (Go): https://gitlab.com/gitlab-org/labkit/-/tree/master/fields?ref_type=heads
+  #
+  # For Engineers Looking to add fields:
+  #
+  # These fields are derived from the Go Labkit variant. Please ensure that you've made the
+  # respective changes in that repository prior to including the fields in this package.
+  #
+  # Please see the handbook page for more information
+  # https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/observability_field_standardisation/
   module Fields
     # correlation_id - string
     #
+    # 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
+    # GitLabUserID - an integer field that
+    # captures the user's numeric ID for logging purposes.
     GL_USER_ID = "gl_user_id"
 
-    # gl_user_name - string
+    # GitLabUserName - a string field that
+    # captures the user's username for logging purposes.
     GL_USER_NAME = "gl_user_name"
+
+    # New fields being added to this section should have
+    # the appropriate doc comments added above. These
+    # should clearly indicate what the intended use of the
+    # field is and should be replicated across the labkit
+    # variations.
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 0.42.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Newdigate
@@ -55,14 +55,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -235,14 +235,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.62'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement