gitlab-labkit 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0bb2d14be346d721a3bd2bc1341998a10f3d6befdb876314545f4dfb4d9f807
-  data.tar.gz: 138b2737773ca89e9f7cde1f60085eaaebedfb23476f710a595672c2f9195a54
+  metadata.gz: 83ec781fd3b5955bb25dd8b3beb5719bd39fbb624db27ce3166227c9cc295aa7
+  data.tar.gz: 0d710400cece77eb16ab725ee1cb0b3eb0bfc833618a5218681865e72fd07aa6
 SHA512:
-  metadata.gz: be04a46cb79b377100e72228c5a50c79c7d6cac89fb3c68b7e3f649aec625f3db48c441e0d9c9927d43fe8daabe6b2db45ea5f0aff2657ce77952f20bcfef046
-  data.tar.gz: ab11eca1c5a11801cbeb3f24dd540e56a279df4e17383d61d7ecf05a1e945fb57eba165dd57a405f1f8cc456aa8b14492642e68dc09cf40a45b8fd3d2c13255c
+  metadata.gz: 576fc58fe5c6319f2a35a3ac3b83ad64f56e187ee0f5844b88e2fa37f8a0f2a7d0d0a1ea0e85640941d50331b187139b99033a4c5a5804b478aa3640108d48d7
+  data.tar.gz: b7fe82edce2720772c26f2f2057b139be363dc34adf77d860fdf11614500e45a9abff07319a912accf1f6e38f1833bbaa19d55b4217befe72e960821ea975a35

data/lib/labkit/fields.rb

@@ -1,93 +1,84 @@
 # frozen_string_literal: true
 
+# Code generated by labkit-spec. DO NOT EDIT.
+#
+# Source: schema/fields.yaml (version 1.0)
+
 module Labkit
-  ##
-  # Fields is intended to be a SSOT for all of the common field names that
-  # we emit via any observability we add to our systems.
-  #
-  # These fields should span multiple services.
-  #
-  # The goal of this package is to reduce the likelihood for typos or
-  # subtly different naming conventions. This will help to ensure we
-  # are able to marry up logs between different systems as a request
-  # is being processed.
-  #
-  # Usage:
-  #   require 'labkit/fields'
-  #   ...
-  #   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
-    #
-    # This field is used to correlate
-    # the logs emitted by all of our systems.
-    # This should be present in all log line
-    # emissions.
+    # Unique identifier for correlating requests across services. Should be
+    # present in all log line emissions.
     CORRELATION_ID = "correlation_id"
 
-    # GitLabUserID - an integer field that
-    # captures the user's numeric ID for logging purposes.
+    # GitLab user numeric ID.
     GL_USER_ID = "gl_user_id"
 
-    # GitLabUserName - a string field that
-    # captures the user's username for logging purposes.
+    # GitLab username.
     GL_USER_NAME = "gl_user_name"
 
-    # ErrorType - a string field that should contain the error type or classification
-    # (e.g., "NoMethodError", "ValidationError").
+    # Duo Workflow definition identifier (e.g. "analytics_agent/v1"). Identifies
+    # which Duo Workflow agent originated a request, enabling per-agent
+    # filtering in Kibana and Grafana.
+    DUO_WORKFLOW_DEFINITION = "duo_workflow_definition"
+
+    # 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").
+    # 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 response status code.
     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 (e.g. "GET", "POST").
     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.
+    # URL of an HTTP request containing only scheme, host, and path (e.g.
+    # "https://example.com/foo"). Query strings and fragments must be omitted to
+    # avoid logging sensitive information.
     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 of any operation in seconds. Not limited to HTTP requests; can be
+    # used for database queries, background jobs, external API calls. Uses
+    # float64 for sub-second precision (e.g. 0.032 for 32ms).
     DURATION_S = "duration_s"
 
-    # RemoteIP - a string field that captures the remote IP
-    # address of a request for logging purposes.
+    # Remote IP address of a request.
     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 a service is listening on, in "host:port" format (e.g.
+    # "0.0.0.0:8080").
     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
-    # field is and should be replicated across the labkit
-    # variations.
+    # Request URI including path and query string with sensitive parameters
+    # masked (e.g. "?password=[FILTERED]").
+    HTTP_URI = "uri"
+
+    # HTTP Host header of a request (e.g. "api.gitlab.com").
+    HTTP_HOST = "host"
+
+    # HTTP protocol version (e.g. "HTTP/1.1", "HTTP/2.0").
+    HTTP_PROTO = "proto"
+
+    # Raw remote socket address in "host:port" format (e.g. "10.0.0.1:54321").
+    # Use remote_ip when only the IP is needed.
+    REMOTE_ADDR = "remote_addr"
+
+    # HTTP Referer header with sensitive query parameters masked.
+    HTTP_REFERRER = "referrer"
+
+    # HTTP User-Agent header.
+    HTTP_USER_AGENT = "user_agent"
+
+    # Number of bytes written to the HTTP response body.
+    WRITTEN_BYTES = "written_bytes"
+
+    # Content-Type of an HTTP response (e.g. "application/json").
+    CONTENT_TYPE = "content_type"
+
+    # Time to first byte of an HTTP response in seconds. Measures duration from
+    # request receipt to first response byte written.
+    TTFB_S = "ttfb_s"
 
     # Get the constant name for a field value
     # @param field_value [String] The field value (e.g., "gl_user_id")
@@ -107,7 +98,7 @@ module Labkit
 
       MAPPINGS = {
         Fields::GL_USER_ID => %w[user_id userid],
-        Fields::HTTP_STATUS_CODE => %w[status_code extra.status status_text]
+        Fields::HTTP_STATUS_CODE => %w[status_code extra.status status_text],
       }.freeze
 
       class << self

metadata

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