gitlab-labkit 2.4.0 → 2.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 56e915f4c8d7e206c94fc8b2392466598ce04d6e81c8ac3302778c5fc02ee2d1
|
|
4
|
+
data.tar.gz: 53092edbcdb67c099fd8ffa9617d4de51580856293de4bb94e9d75ad8727dd26
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 85589bdd3f7daaf47e62c404267bf2b669cd89c9ca4ad0a7b4a30747316d9b397b710f2bc56d069da0e0141cef18cf58061b1e13e09715aa812177343f38dae2
|
|
7
|
+
data.tar.gz: 13cb4e20ec4be4dc8aa2c97b339c071e747bc18d54e36144a14249ca956b0f834558d0e4ac2a0e547d02467338438d27fe96c04f83d508089265f8d2cd54a095
|
|
@@ -21,15 +21,44 @@
|
|
|
21
21
|
"sync_fast",
|
|
22
22
|
"sync_slow",
|
|
23
23
|
"async_fast",
|
|
24
|
-
"async_slow"
|
|
24
|
+
"async_slow",
|
|
25
|
+
"custom"
|
|
25
26
|
],
|
|
26
27
|
"description": "Urgency level for this user experience"
|
|
28
|
+
},
|
|
29
|
+
"apdex_threshold_s": {
|
|
30
|
+
"type": "number",
|
|
31
|
+
"exclusiveMinimum": 0,
|
|
32
|
+
"maximum": 600,
|
|
33
|
+
"description": "Custom Apdex threshold duration in seconds. Required when urgency is custom."
|
|
27
34
|
}
|
|
28
35
|
},
|
|
29
36
|
"required": [
|
|
30
37
|
"description",
|
|
31
38
|
"feature_category",
|
|
32
39
|
"urgency"
|
|
40
|
+
],
|
|
41
|
+
"allOf": [
|
|
42
|
+
{
|
|
43
|
+
"if": {
|
|
44
|
+
"properties": {
|
|
45
|
+
"urgency": {
|
|
46
|
+
"const": "custom"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"then": {
|
|
51
|
+
"required": [
|
|
52
|
+
"apdex_threshold_s"
|
|
53
|
+
]
|
|
54
|
+
},
|
|
55
|
+
"else": {
|
|
56
|
+
"not": {
|
|
57
|
+
"required": [
|
|
58
|
+
"apdex_threshold_s"
|
|
59
|
+
]
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
33
63
|
]
|
|
34
64
|
}
|
|
35
|
-
|
|
@@ -107,6 +107,22 @@ https://docs.gitlab.com/development/feature_categorization/#feature-categorizati
|
|
|
107
107
|
| `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 |
|
|
108
108
|
| `async_fast` | An async process which may block a user from continuing with their user journey | MR diff update after git push | 15s |
|
|
109
109
|
| `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 |
|
|
110
|
+
| `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` |
|
|
111
|
+
|
|
112
|
+
**Custom Apdex thresholds**
|
|
113
|
+
|
|
114
|
+
Use `urgency: "custom"` when none of the predefined thresholds accurately represents the expected user experience. Custom urgency requires `apdex_threshold_s`.
|
|
115
|
+
|
|
116
|
+
```yaml
|
|
117
|
+
description: "Creating a new merge request in a project"
|
|
118
|
+
feature_category: "code_review_workflow"
|
|
119
|
+
urgency: "custom"
|
|
120
|
+
apdex_threshold_s: 90
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
`apdex_threshold_s` is measured in seconds, must be greater than `0`, and cannot exceed `600`.
|
|
124
|
+
|
|
125
|
+
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.
|
|
110
126
|
|
|
111
127
|
## Usage
|
|
112
128
|
|
|
@@ -209,7 +209,9 @@ module Labkit
|
|
|
209
209
|
end
|
|
210
210
|
|
|
211
211
|
def urgency_threshold
|
|
212
|
-
|
|
212
|
+
# Definitions are loaded through the registry, which validates the schema before instantiating them.
|
|
213
|
+
# The schema guarantees experience with custom urgency provide apdex_threshold_s.
|
|
214
|
+
@definition.apdex_threshold_s || URGENCY_THRESHOLDS_IN_SECONDS[@definition.urgency.to_sym]
|
|
213
215
|
end
|
|
214
216
|
|
|
215
217
|
def elapsed_time
|
|
@@ -8,7 +8,11 @@ require 'labkit/json_schema/ref_resolver'
|
|
|
8
8
|
|
|
9
9
|
module Labkit
|
|
10
10
|
module UserExperienceSli
|
|
11
|
-
Definition = Data.define(:user_experience_id, :description, :feature_category, :urgency)
|
|
11
|
+
Definition = Data.define(:user_experience_id, :description, :feature_category, :urgency, :apdex_threshold_s) do
|
|
12
|
+
def initialize(user_experience_id:, description:, feature_category:, urgency:, apdex_threshold_s: nil)
|
|
13
|
+
super
|
|
14
|
+
end
|
|
15
|
+
end
|
|
12
16
|
|
|
13
17
|
class Registry
|
|
14
18
|
extend Forwardable
|
|
@@ -78,15 +82,16 @@ module Labkit
|
|
|
78
82
|
content = YAML.safe_load(file_path.read)
|
|
79
83
|
return nil unless content.is_a?(Hash)
|
|
80
84
|
|
|
81
|
-
return Definition.new(user_experience_id: experience_id, **content) if schema.valid?(content)
|
|
85
|
+
return Definition.new(user_experience_id: experience_id, **content.transform_keys(&:to_sym)) if schema.valid?(content)
|
|
82
86
|
|
|
83
87
|
warn("Invalid schema for #{file_path}")
|
|
84
|
-
|
|
85
88
|
nil
|
|
86
89
|
rescue Psych::SyntaxError => e
|
|
87
90
|
warn("Invalid definition file #{file_path}: #{e.message}")
|
|
91
|
+
nil
|
|
88
92
|
rescue StandardError => e
|
|
89
93
|
warn("Unexpected error processing #{file_path}: #{e.message}")
|
|
94
|
+
nil
|
|
90
95
|
end
|
|
91
96
|
|
|
92
97
|
def schema
|