gitlab-labkit 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c7057e132dd046256e4e099cadef103283e3bbd682ecf3d1c596a0996d2c007
-  data.tar.gz: 238db3eca235a4423df26c23b65ed22523c7d27d9209a19f953df9e3ff817437
+  metadata.gz: 4f0ded1c554ab0eb289f72738429db8f92ab18eb091fd7186663bdeb7d861cfc
+  data.tar.gz: 1b5276133b05752d03c3a58d36602e923cf69b8e040a71a22e194a971ca0bff6
 SHA512:
-  metadata.gz: cd33f670799561477b139c690eab1e89ba6e28e660cf95d64725be3a5daf2b2df3e589180fcd6afeea7c2c6fa01e8c7e76ddaba3be4d0ee0ced09f16953e4764
-  data.tar.gz: bd64be24a45c2fec786c94bdc61bc3d4abf982eb1d073db41a217240b46b741fea2982e58c1ca568d6c4ff3474d32296cca2991f96011b7a188fa955f457fc3a
+  metadata.gz: 9e100693a48024f97d9314e2699c39be46a7dad631e3679e136b9477d9f6410a9ef86f346ed8a63777cae8e528332b6bc0adef41a5c8702ec84a62227ddb1e43
+  data.tar.gz: dd31347725dd09c313f8294238ab5e10faa50bcd2a94496bf77f80eaa1b5ea70bc2c194c4c1cb61991cf63c7a92386111abd7f36140de8d704d92c4e6ae6dc18

data/.gitlab-ci.yml

@@ -19,13 +19,13 @@ include:
   # It includes standard checks, gitlab-scanners, validations and release processes
   # common to all projects using this template library.
   # see https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/templates/standard.md
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/standard-build@v3.5
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/standard-build@v3.8
 
   # Runs rspec tests and rubocop on the project
   # see https://gitlab.com/gitlab-com/gl-infra/common-ci-tasks/-/blob/main/templates/ruby.md
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/ruby-build@v3.5
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/ruby-build@v3.8
 
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v3.5
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v3.8
 
 .test_template: &test_definition
   extends: .with_bundle

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

data/lib/labkit/fields.rb

@@ -44,10 +44,45 @@ module Labkit
     # captures the user's username for logging purposes.
     GL_USER_NAME = "gl_user_name"
 
+    # ErrorType - a string field that should contain the error type or classification
+    # (e.g., "NoMethodError", "ValidationError").
+    ERROR_TYPE = "error_type"
+
+    # ErrorMessage - a string field that should contain the detailed error message
+    # (e.g., "undefined method `boom!' for nil").
+    ERROR_MESSAGE = "error_message"
+
     # HTTPStatusCode - an integer field that
     # captures the HTTP status code of requests for logging purposes.
     HTTP_STATUS_CODE = "status"
 
+    # HTTPMethod - a string field that captures the HTTP method
+    # (e.g., "GET", "POST") of a request for logging purposes.
+    HTTP_METHOD = "method"
+
+    # HTTPURL - a string field that captures the URL of an HTTP request
+    # (scheme, host, and path only - query strings should be omitted
+    # to avoid logging sensitive data) for logging purposes.
+    # (e.g. "https://example.com/foo") Query strings and fragments (anchors)
+    # must be omitted to avoid logging sensitive information such as tokens
+    # or passwords that may appear in query parameters.
+    HTTP_URL = "url"
+
+    # DurationS - a float field that captures the duration of any operation
+    # in seconds for logging purposes. It is not limited to HTTP requests and
+    # can be used for any timed operation (e.g. database queries, background
+    # jobs, external API calls).
+    DURATION_S = "duration_s"
+
+    # RemoteIP - a string field that captures the remote IP
+    # address of a request for logging purposes.
+    REMOTE_IP = "remote_ip"
+
+    # TCPAddress - a string field that captures the TCP address a service or
+    # component is listening on, in "host:port" format
+    # (e.g. "0.0.0.0:8080" or "127.0.0.1:9090").
+    TCP_ADDRESS = "tcp_address"
+
     # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-labkit
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Andrew Newdigate