Skip to content

Commit 6fc5d45

Browse files
filiptronicekfiliptronicek
committed
[gp-code] measure all sessions vs errored sessions
Co-authored-by: Anton Kosyakov <[email protected]> Move remainder of IDE metrics to under OpenVSCode Server workbench
1 parent 1493922 commit 6fc5d45

File tree

4 files changed

+102
-10
lines changed

4 files changed

+102
-10
lines changed

‎product.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -695,5 +695,8 @@
695695
},
696696
"linkProtectionTrustedDomains": [
697697
"https://open-vsx.org"
698-
]
698+
],
699+
"gitpodPreview": {
700+
"host": "filiptroni52200c8eb9.preview.gitpod-dev.com"
701+
}
699702
}

‎src/vs/gitpod/browser/workbench/workbench-dev.html

Lines changed: 73 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,76 @@
22
<!DOCTYPE html>
33
<html>
44
<head>
5+
<script>
6+
async function gitpodMetricsAddCounter(metricsName, labels, value) {
7+
function getMetricsUrl() {
8+
const gitpodHost = "{{GITPOD_HOST}}";
9+
if (!gitpodHost) {
10+
return '';
11+
}
12+
return `https://ide.${gitpodHost}/metrics-api`;
13+
}
14+
try {
15+
const metricsUrl = getMetricsUrl();
16+
if (!metricsUrl) {
17+
return false;
18+
}
19+
const url = `${metricsUrl}/metrics/counter/add/${metricsName}`;
20+
const params = { value, labels };
21+
const response = await fetch(url, {
22+
method: 'POST',
23+
body: JSON.stringify(params),
24+
credentials: 'omit',
25+
});
26+
if (!response.ok) {
27+
const data = await response.json(); // { code: number; message: string; }
28+
console.error(`Cannot report metrics with addCounter: ${response.status} ${response.statusText}`, data);
29+
return false;
30+
}
31+
return true;
32+
} catch (err) {
33+
console.error('Cannot report metrics with addCounter, error:', err);
34+
return false;
35+
}
36+
}
37+
38+
// sum(rate(gitpod_vscode_web_load_total{status='failed'}[2m]))/sum(rate(gitpod_vscode_web_load_total{status='loading'}[2m]))
39+
const gitpodVSCodeWebLoadTotal = 'gitpod_vscode_web_load_total';
40+
41+
gitpodMetricsAddCounter(gitpodVSCodeWebLoadTotal, { status: 'loading' });
42+
gitpodMetricsAddCounter('gitpod_supervisor_frontend_client_total');
43+
44+
let vscodeWebFailedToLoad = false;
45+
const onVsCodeWorkbenchError = (event) => {
46+
if (!vscodeWebFailedToLoad) {
47+
vscodeWebFailedToLoad = true;
48+
gitpodMetricsAddCounter(gitpodVSCodeWebLoadTotal, { status: 'failed' });
49+
}
50+
51+
// If the error is not an element loading error, we only increase the total error count
52+
if (typeof event?.target?.getAttribute !== 'function') {
53+
gitpodMetricsAddCounter('gitpod_supervisor_frontend_error_total');
54+
return;
55+
}
56+
const labels = {};
57+
58+
// We take a look at the resource that was attempted to load
59+
const resourceSource = event.target.getAttribute('src') || event.target.getAttribute('href');
60+
61+
if (resourceSource) {
62+
if (resourceSource.match(new RegExp(/\/build\/ide\/code:.+\/__files__\//g))) {
63+
// TODO(ak) reconsider how to hide knowledge of VS Code from supervisor frontend, i.e instrument amd loader instead
64+
labels['resource'] = 'vscode-web-workbench';
65+
}
66+
labels['error'] = 'LoadError';
67+
} else {
68+
labels['error'] = 'Unknown';
69+
}
70+
gitpodMetricsAddCounter('gitpod_supervisor_frontend_error_total', labels);
71+
};
72+
73+
window.addEventListener('error', onVsCodeWorkbenchError);
74+
</script>
575
<script>
676
performance.mark('code/didStartRenderer')
777
</script>
@@ -34,8 +104,8 @@
34104
</body>
35105

36106
<!-- Startup (do not modify order of script tags!) -->
37-
<script src="{{WORKBENCH_WEB_BASE_URL}}/out/vs/loader.js"></script>
38-
<script src="{{WORKBENCH_WEB_BASE_URL}}/out/vs/webPackagePaths.js"></script>
107+
<script src="{{WORKBENCH_WEB_BASE_URL}}/out/vs/loader.js" onerror="onVsCodeWorkbenchError(event)"></script>
108+
<script src="{{WORKBENCH_WEB_BASE_URL}}/out/vs/webPackagePaths.js" onerror="onVsCodeWorkbenchError(event)"></script>
39109
<script>
40110
const baseUrl = new URL('{{WORKBENCH_WEB_BASE_URL}}', window.location.origin).toString();
41111
Object.keys(self.webPackagePaths).map(function (key, index) {
@@ -65,6 +135,6 @@
65135
performance.mark('code/willLoadWorkbenchMain');
66136
</script>
67137
<script>
68-
require(['vs/gitpod/browser/workbench/workbench'], function() {});
138+
require(['vs/gitpod/browser/workbench/workbench'], () => {});
69139
</script>
70140
</html>

‎src/vs/gitpod/browser/workbench/workbench.html

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,26 +48,43 @@
4848
}
4949
}
5050

51+
const gitpodVSCodeWebLoadTotal = 'gitpod_vscode_web_load_total';
52+
53+
gitpodMetricsAddCounter(gitpodVSCodeWebLoadTotal, { status: 'loading' });
54+
gitpodMetricsAddCounter('gitpod_supervisor_frontend_client_total');
55+
56+
let vscodeWebFailedToLoad = false;
5157
const onVsCodeWorkbenchError = (event) => {
58+
if (!vscodeWebFailedToLoad) {
59+
vscodeWebFailedToLoad = true;
60+
gitpodMetricsAddCounter(gitpodVSCodeWebLoadTotal, { status: 'failed' });
61+
}
62+
63+
// If the error is not an element loading error, we only increase the total error count
5264
if (typeof event?.target?.getAttribute !== 'function') {
5365
gitpodMetricsAddCounter('gitpod_supervisor_frontend_error_total');
5466
return;
5567
}
5668
const labels = {};
5769

58-
// We take a look at what is the resource that was attempted to load;
70+
// We take a look at what is the resource that was attempted to load
5971
const resourceSource = event.target.getAttribute('src') || event.target.getAttribute('href');
6072

61-
// If the event has a `target`, it means that it wasn't a script error
6273
if (resourceSource) {
63-
labels['resource'] = 'vscode-web-workbench';
74+
if (resourceSource.match(new RegExp(/\/build\/ide\/code:.+\/__files__\//g))) {
75+
// TODO(ak) reconsider how to hide knowledge of VS Code from supervisor frontend, i.e instrument amd loader instead
76+
labels['resource'] = 'vscode-web-workbench';
77+
}
6478
labels['error'] = 'LoadError';
6579
} else {
6680
labels['error'] = 'Unknown';
6781
}
6882
gitpodMetricsAddCounter('gitpod_supervisor_frontend_error_total', labels);
6983
};
7084

85+
window.addEventListener('error', onVsCodeWorkbenchError);
86+
</script>
87+
<script>
7188
performance.mark('code/didStartRenderer');
7289
</script>
7390
<meta charset="utf-8" />
@@ -102,8 +119,8 @@
102119

103120
<!-- Startup (do not modify order of script tags!) -->
104121
<script type="text/javascript" src="/_supervisor/frontend/main.js" onerror="onVsCodeWorkbenchError(event)" charset="utf-8"></script>
105-
<script src="./static/out/vs/loader.js" onerror="onVsCodeWorkbenchError(event)" ></script>
106-
<script src="./static/out/vs/webPackagePaths.js" onerror="onVsCodeWorkbenchError(event)" ></script>
122+
<script src="./static/out/vs/loader.js" onerror="onVsCodeWorkbenchError(event)"></script>
123+
<script src="./static/out/vs/webPackagePaths.js" onerror="onVsCodeWorkbenchError(event)"></script>
107124
<script>
108125
Object.keys(self.webPackagePaths).map(function (key, index) {
109126
self.webPackagePaths[key] = `${window.location.origin}/static/node_modules/${key}/${self.webPackagePaths[key]}`;
@@ -121,7 +138,8 @@
121138
'@gitpod/local-app-api-grpcweb': `${window.location.origin}/static/node_modules/@gitpod/local-app-api-grpcweb/lib/localapp.js`,
122139
'@improbable-eng/grpc-web': `${window.location.origin}/static/node_modules/@improbable-eng/grpc-web/dist/grpc-web-client.umd.js`,
123140
'@zip.js/zipjs': `${window.location.origin}/static/node_modules/@zip.js/zip.js/dist/zip-no-worker-deflate.min.js`
124-
}
141+
},
142+
onError: onVsCodeWorkbenchError
125143
});
126144
</script>
127145
<script>

‎src/vs/server/node/webClientServer.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,7 @@ export class WebClientServer {
323323

324324
const nlsBaseUrl = this._productService.extensionsGallery?.nlsBaseUrl;
325325
const values: { [key: string]: string } = {
326+
GITPOD_HOST: this._productService.gitpodPreview?.host || '',
326327
WORKBENCH_WEB_CONFIGURATION: asJSON(workbenchWebConfiguration),
327328
WORKBENCH_AUTH_SESSION: authSessionInfo ? asJSON(authSessionInfo) : '',
328329
WORKBENCH_WEB_BASE_URL: this._staticRoute,

0 commit comments

Comments
 (0)