-
Notifications
You must be signed in to change notification settings - Fork 3
/
app.js
309 lines (271 loc) · 10.9 KB
/
app.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
import { createApp } from './vendor/vue.js'
import { config } from './config.js'
import HelpComponent from './components/help.js'
import AlertComponent from './components/alert.js'
import BurnRateComponent from './components/burn-rate.js'
import ErrorBudgetComponent from './components/error-budget.js'
import ExtLink from './components/ext-link.js'
import { setTitle } from './lib/header.js'
import { percent, percentToRatio, toFixed, clamp } from './lib/math.js'
import { daysToSeconds } from './lib/time.js'
import { Window } from './lib/window.js'
import { numL10n, percL10n } from './lib/fmt.js'
import { inRange, inRangePosInt, isNum, isStr } from './lib/validation.js'
import { trackEvent } from './lib/ga-utils.js'
import { stateToUrl, urlToState } from './lib/share.js'
import { Budget } from './lib/budget.js'
export const app = createApp({
data() {
let showCookiePopup = true
try {
if (localStorage.getItem('showCookiePopup') === 'false') {
showCookiePopup = false
}
} catch (e) {
// ignore
}
return {
// Expose the config to the UI
config,
// Show the announcement banner
showAnnouncement: true,
// Show the cookie popup (use localStorage to remember the user's choice)
showCookiePopup,
// Show the short window alert
shortWindowVisible: false,
// The text shown in the toast notification
toastCaption: '',
// The title of the SLI
title: config.title.default,
// The description of the SLI
description: config.description.default,
// unit of SLI or number of seconds in a time slot
unit: config.unit.default,
// definition of good events or good time slots
good: config.good.default,
// definition of valid events or valid time slots
valid: config.valid.default,
// The SLO percentage. It is also read/written by the sloInt and sloFrac computed properties
slo: config.slo.default,
// The length of the SLO window in days
windowDays: config.windowDays.default,
// For event based error budgets, this number holds the total valid events so we can compute the amount of allowed bad events
estimatedValidEvents: config.estimatedValidEvents.default,
// The cost of a bad event
badEventCost: config.badEventCost.default,
// The unit of the bad event cost
badEventCurrency: config.badEventCurrency.default,
// Alert burn rate: the rate at which the error budget is consumed
burnRate: config.burnRate.default,
// Long window alert: percentage of the SLO window
longWindowPerc: config.longWindowPerc.default,
// Short window alert: the fraction of the long window
shortWindowDivider: config.shortWindowDivider.default,
}
},
watch: {
windowDays(newVal, oldVal) {
if (newVal !== oldVal) {
this.estimatedValidEvents = Math.round(this.estimatedValidEvents * newVal / oldVal)
}
},
title(newTitle) {
setTitle(document, newTitle)
},
},
mounted() {
this.loadState(urlToState(window.location.href))
this.$nextTick(() => {
const hash = window.location.hash;
if (hash) {
const element = document.querySelector(hash);
if (element) element.scrollIntoView();
}
})
},
components: {
HelpComponent,
ErrorBudgetComponent,
AlertComponent,
BurnRateComponent,
ExtLink,
},
methods: {
percentToRatio(x) {
return percentToRatio(x)
},
numL10n(x) {
return numL10n(x)
},
percL10n(x) {
return percL10n(x)
},
changeSLO(amount) {
this.slo = clamp(toFixed(this.slo + amount), config.slo.min, config.slo.max)
},
changeErrorBudget(amount) {
// Event based
const newBadEventCount = clamp(this.badEventCount + amount, 1, this.validEventCount)
const newGoodEventCount = this.validEventCount - newBadEventCount
const newSLO = toFixed(newGoodEventCount / this.validEventCount * 100)
this.slo = clamp(newSLO, config.slo.min, config.slo.max)
},
loadState(newState) {
try {
if (isStr(newState.title)) {
this.title = newState.title
}
if (isStr(newState.description)) {
this.description = newState.description
}
// Unit is a bit special. It can be the event name or a time slot length in seconds
if (isStr(newState.unit) || inRangePosInt(newState.unit, config.timeSlot.min, config.timeSlot.max)) {
this.unit = newState.unit
}
if (isStr(newState.good)) {
this.good = newState.good
}
if (isStr(newState.valid)) {
this.valid = newState.valid
}
if (inRange(newState.slo, config.slo.min, config.slo.max)) {
this.slo = newState.slo
}
if (inRangePosInt(newState.windowDays, config.windowDays.min, config.windowDays.max)) {
this.windowDays = newState.windowDays
}
if (inRangePosInt(newState.estimatedValidEvents, config.estimatedValidEvents.min, config.estimatedValidEvents.max)) {
this.estimatedValidEvents = newState.estimatedValidEvents
}
if (inRange(newState.badEventCost, config.badEventCost.min, config.badEventCost.max)) {
this.badEventCost = newState.badEventCost
}
if (isStr(newState.badEventCurrency)) {
this.badEventCurrency = newState.badEventCurrency
}
if (inRange(newState.burnRate, config.burnRate.min, config.burnRate.max)) {
this.burnRate = newState.burnRate
}
if (inRange(newState.longWindowPerc, config.longWindowPerc.min, config.longWindowPerc.max)) {
this.longWindowPerc = newState.longWindowPerc
}
if (inRange(newState.shortWindowDivider, config.shortWindowDivider.min, config.shortWindowDivider.max)) {
this.shortWindowDivider = newState.shortWindowDivider
}
} catch (e) {
this.toastCaption = `Failed to load state ${e}`
console.error(e)
}
},
hideCookiePopup() {
this.showCookiePopup = false
try {
localStorage.setItem('showCookiePopup', 'false')
} catch (e) {
// ignore
}
},
async copy(elementId, label) {
try {
var copyText = document.getElementById(elementId).innerText
await navigator.clipboard.writeText(copyText)
this.toastCaption = 'Copied to clipboard!'
trackEvent('copy', 'button', label)
} catch(err) {
// ignore
}
},
},
computed: {
sloWindow() {
return new Window(
daysToSeconds(this.windowDays),
this.unit,
)
},
// whether the SLI is time-based or event-based
isTimeBased: {
get() {
return isNum(this.unit)
},
set(newVal) {
this.unit = newVal ? 60 : 'events'
}
},
sloInt: {
get() {
return Math.floor(this.slo)
},
set(newIntStr) {
const newInt = Number(newIntStr)
const sloFrac = this.slo % 1
this.slo = toFixed(newInt + sloFrac)
}
},
sloFrac: {
get() {
return toFixed(this.slo % 1)
},
set(newFracStr) {
const newFrac = Number(newFracStr)
const sloInt = Math.floor(this.slo)
this.slo = toFixed(sloInt + newFrac)
}
},
errorBudgetPerc() {
return toFixed(100 - this.slo)
},
validEventCount() {
if (this.isTimeBased) {
return this.sloWindow.timeSlotCount
} else {
return this.estimatedValidEvents || config.estimatedValidEvents.min
}
},
goodEventCount() {
return this.validEventCount - this.badEventCount
},
badEventCount() {
return Math.floor(percent(this.errorBudgetPerc, this.validEventCount))
},
errorBudget() {
const { sec, unit } = this.sloWindow
const eventCost = this.badEventCost || 0
return new Budget(sec, unit, this.badEventCount, eventCost, this.badEventCurrency)
},
// Time to burn the entire error budget at the given burnRate
errorBudgetBurn() {
return this.errorBudget.shrinkWindow(100 / this.burnRate)
},
// If nothing is done to stop the failures, there'll be burnRate times more errors by the end of the SLO window
sloWindowBudgetBurn() {
const { sec, unit } = this.sloWindow
const eventCost = this.badEventCost || 0
const burnedEventAtThisRate = Math.ceil(this.badEventCount * this.burnRate)
const eventCount = Math.min(this.validEventCount, burnedEventAtThisRate)
return new Budget(sec, unit, eventCount, eventCost, this.badEventCurrency)
},
alertLongWindow() {
return this.errorBudgetBurn.shrink(this.longWindowPerc)
},
alertTTRWindow() {
return this.errorBudgetBurn.shrink(100 - this.longWindowPerc)
},
// As a percentage of the error budget
alertShortWindowPerc() {
return toFixed(this.longWindowPerc / this.shortWindowDivider)
},
alertShortWindow() {
return this.errorBudgetBurn.shrink(this.alertShortWindowPerc)
},
shareUrl() {
try {
const url = new URL(window.location.pathname, window.location.origin)
return stateToUrl(url, this).toString()
} catch (e) {
console.error('Could not create shareurl', e)
return null
}
},
}
})