gitlab-labkit 2.3.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a91b55e1bea047b7f80c63eef77e85988ea3b35f8b33d076dc6d1593167a6ec7
-  data.tar.gz: 60768ba7bb3128b91050f28dc00989166f7cb922bf513f2db16d4d510fd2a448
+  metadata.gz: 56e915f4c8d7e206c94fc8b2392466598ce04d6e81c8ac3302778c5fc02ee2d1
+  data.tar.gz: 53092edbcdb67c099fd8ffa9617d4de51580856293de4bb94e9d75ad8727dd26
 SHA512:
-  metadata.gz: 44c7a3631ef962ba8294450924e41ca9a1c32d3fc0baa68995870ecf7deeefbcb7469833a1ab3ebde678653dffc0ff952764ddfcc256d4c1cf9858bd7503f9e3
-  data.tar.gz: 5b0cca246ffcaf2bb391223646a44e6f29fcf44e6f5997562189fd65ac58c8333c93ff59687eb9372322d0bb3a6f9f0ca1d8d8bc61fbdec8bc5913dad081cdca
+  metadata.gz: 85589bdd3f7daaf47e62c404267bf2b669cd89c9ca4ad0a7b4a30747316d9b397b710f2bc56d069da0e0141cef18cf58061b1e13e09715aa812177343f38dae2
+  data.tar.gz: 13cb4e20ec4be4dc8aa2c97b339c071e747bc18d54e36144a14249ca956b0f834558d0e4ac2a0e547d02467338438d27fe96c04f83d508089265f8d2cd54a095

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@v4.7
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/standard-build@v4.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@v4.7
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/ruby-build@v4.8
 
-  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v4.7
+  - component: $CI_SERVER_FQDN/gitlab-com/gl-infra/common-ci-tasks/danger@v4.8
 
 # Attach a redis service to the rspec job from common-ci-tasks/ruby-build.
 # GitLab merges keys when a local job has the same name as an included one,

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

data/config/user_experience_slis/schema.json

@@ -21,15 +21,44 @@
         "sync_fast",
         "sync_slow",
         "async_fast",
-        "async_slow"
+        "async_slow",
+        "custom"
       ],
       "description": "Urgency level for this user experience"
+    },
+    "apdex_threshold_s": {
+      "type": "number",
+      "exclusiveMinimum": 0,
+      "maximum": 600,
+      "description": "Custom Apdex threshold duration in seconds. Required when urgency is custom."
     }
   },
   "required": [
     "description",
     "feature_category",
     "urgency"
+  ],
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "urgency": {
+            "const": "custom"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "apdex_threshold_s"
+        ]
+      },
+      "else": {
+        "not": {
+          "required": [
+            "apdex_threshold_s"
+          ]
+        }
+      }
+    }
   ]
 }
-

data/lib/labkit/fields.rb

@@ -21,6 +21,10 @@ module Labkit
     # filtering in Kibana and Grafana.
     DUO_WORKFLOW_DEFINITION = "duo_workflow_definition"
 
+    # Unique identifier for a Duo Workflow instance. Identifies a specific
+    # workflow run, enabling per-workflow tracing in logs.
+    DUO_WORKFLOW_ID = "duo_workflow_id"
+
     # Error type or classification (e.g. "NoMethodError", "ValidationError").
     ERROR_TYPE = "error_type"
 
@@ -125,6 +129,7 @@ module Labkit
       GL_USER_ID => 1,
       GL_USER_NAME => 1,
       DUO_WORKFLOW_DEFINITION => 0,
+      DUO_WORKFLOW_ID => 0,
       ERROR_TYPE => 0,
       ERROR_MESSAGE => 1,
       HTTP_STATUS_CODE => 1,

data/lib/labkit/user_experience_sli/README.md

@@ -107,6 +107,22 @@ https://docs.gitlab.com/development/feature_categorization/#feature-categorizati
 | `sync_slow`  | A user is awaiting a synchronous response which needs to be returned before they can continue with their action, but which the user may accept a slower response | Displaying a full-text search response while displaying an amusement animation | 5s    |
 | `async_fast` | An async process which may block a user from continuing with their user journey                                                                                  | MR diff update after git push                                                  | 15s   |
 | `async_slow` | An async process which will not block a user and will not be immediately noticed as being slow                                                                   | Notification following an assignment                                           | 5m    |
+| `custom`     | A user experience whose acceptable duration does not match the predefined urgency buckets                                                                        | Creating a merge request with an accepted threshold of 90s                     | Set by `apdex_threshold_s` |
+
+**Custom Apdex thresholds**
+
+Use `urgency: "custom"` when none of the predefined thresholds accurately represents the expected user experience. Custom urgency requires `apdex_threshold_s`.
+
+```yaml
+description: "Creating a new merge request in a project"
+feature_category: "code_review_workflow"
+urgency: "custom"
+apdex_threshold_s: 90
+```
+
+`apdex_threshold_s` is measured in seconds, must be greater than `0`, and cannot exceed `600`.
+
+Prefer the predefined urgency values unless the SLI would otherwise be permanently red or permanently green because the predefined thresholds do not match the experience.
 
 ## Usage
 

data/lib/labkit/user_experience_sli/experience.rb

@@ -209,7 +209,9 @@ module Labkit
       end
 
       def urgency_threshold
-        URGENCY_THRESHOLDS_IN_SECONDS[@definition.urgency.to_sym]
+        # Definitions are loaded through the registry, which validates the schema before instantiating them.
+        # The schema guarantees experience with custom urgency provide apdex_threshold_s.
+        @definition.apdex_threshold_s || URGENCY_THRESHOLDS_IN_SECONDS[@definition.urgency.to_sym]
       end
 
       def elapsed_time

data/lib/labkit/user_experience_sli/registry.rb

@@ -8,7 +8,11 @@ require 'labkit/json_schema/ref_resolver'
 
 module Labkit
   module UserExperienceSli
-    Definition = Data.define(:user_experience_id, :description, :feature_category, :urgency)
+    Definition = Data.define(:user_experience_id, :description, :feature_category, :urgency, :apdex_threshold_s) do
+      def initialize(user_experience_id:, description:, feature_category:, urgency:, apdex_threshold_s: nil)
+        super
+      end
+    end
 
     class Registry
       extend Forwardable
@@ -78,15 +82,16 @@ module Labkit
         content = YAML.safe_load(file_path.read)
         return nil unless content.is_a?(Hash)
 
-        return Definition.new(user_experience_id: experience_id, **content) if schema.valid?(content)
+        return Definition.new(user_experience_id: experience_id, **content.transform_keys(&:to_sym)) if schema.valid?(content)
 
         warn("Invalid schema for #{file_path}")
-
         nil
       rescue Psych::SyntaxError => e
         warn("Invalid definition file #{file_path}: #{e.message}")
+        nil
       rescue StandardError => e
         warn("Unexpected error processing #{file_path}: #{e.message}")
+        nil
       end
 
       def schema

metadata

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