2022-05-05 07:32:12 +08:00
|
|
|
Add support for telemetry endpoint
|
|
|
|
|
2022-09-10 01:05:30 +08:00
|
|
|
To test:
|
2022-12-23 01:25:28 +08:00
|
|
|
1. Create a mock API using [RequestBin](https://requestbin.io/) or [Beeceptor](https://beeceptor.com/)
|
2022-09-28 05:09:53 +08:00
|
|
|
2. Run code-server with `CS_TELEMETRY_URL` set:
|
2022-10-27 02:50:08 +08:00
|
|
|
i.e. `CS_TELEMETRY_URL="https://requestbin.io/1ebub9z1" ./code-server-<version>-macos-amd64/bin/code-server`
|
2022-11-10 06:10:03 +08:00
|
|
|
NOTE: it has to be a production build.
|
2022-09-28 05:09:53 +08:00
|
|
|
3. Load code-server in browser an do things (i.e. open a file)
|
|
|
|
4. Refresh RequestBin and you should see logs
|
2022-09-10 01:05:30 +08:00
|
|
|
|
2022-05-05 07:32:12 +08:00
|
|
|
Index: code-server/lib/vscode/src/vs/server/node/serverServices.ts
|
|
|
|
===================================================================
|
|
|
|
--- code-server.orig/lib/vscode/src/vs/server/node/serverServices.ts
|
|
|
|
+++ code-server/lib/vscode/src/vs/server/node/serverServices.ts
|
2023-10-19 08:50:21 +08:00
|
|
|
@@ -65,6 +65,7 @@ import { IExtensionsScannerService } fro
|
2022-06-22 05:51:46 +08:00
|
|
|
import { ExtensionsScannerService } from 'vs/server/node/extensionsScannerService';
|
2023-02-08 06:22:06 +08:00
|
|
|
import { IExtensionsProfileScannerService } from 'vs/platform/extensionManagement/common/extensionsProfileScannerService';
|
|
|
|
import { IUserDataProfilesService } from 'vs/platform/userDataProfile/common/userDataProfile';
|
2023-10-19 08:50:21 +08:00
|
|
|
+import { TelemetryClient } from 'vs/server/node/telemetryClient';
|
2022-06-22 05:51:46 +08:00
|
|
|
import { NullPolicyService } from 'vs/platform/policy/common/policy';
|
2022-08-17 09:26:19 +08:00
|
|
|
import { OneDataSystemAppender } from 'vs/platform/telemetry/node/1dsAppender';
|
2022-11-10 06:10:03 +08:00
|
|
|
import { LoggerService } from 'vs/platform/log/node/loggerService';
|
2024-06-07 07:02:13 +08:00
|
|
|
@@ -147,11 +148,23 @@ export async function setupServerService
|
2024-05-07 07:53:53 +08:00
|
|
|
const requestService = new RequestService(configurationService, environmentService, logService, loggerService);
|
|
|
|
services.set(IRequestService, requestService);
|
|
|
|
|
|
|
|
+ let isContainer = undefined;
|
|
|
|
+ try {
|
|
|
|
+ await Promises.stat('/run/.containerenv');
|
|
|
|
+ isContainer = true;
|
|
|
|
+ } catch (error) { /* Does not exist, probably. */ }
|
|
|
|
+ if (!isContainer) {
|
|
|
|
+ try {
|
|
|
|
+ const content = await Promises.readFile('/proc/self/cgroup', 'utf8')
|
|
|
|
+ isContainer = content.includes('docker');
|
|
|
|
+ } catch (error) { /* Permission denied, probably. */ }
|
|
|
|
+ }
|
|
|
|
+
|
2023-03-15 04:03:53 +08:00
|
|
|
let oneDsAppender: ITelemetryAppender = NullAppender;
|
2022-08-17 09:26:19 +08:00
|
|
|
const isInternal = isInternalTelemetry(productService, configurationService);
|
2022-05-05 07:32:12 +08:00
|
|
|
if (supportsTelemetry(productService, environmentService)) {
|
2023-10-19 08:50:21 +08:00
|
|
|
- if (!isLoggingOnly(productService, environmentService) && productService.aiConfig?.ariaKey) {
|
2024-05-07 11:27:34 +08:00
|
|
|
- oneDsAppender = new OneDataSystemAppender(requestService, isInternal, eventPrefix, null, productService.aiConfig.ariaKey);
|
|
|
|
+ if (!isLoggingOnly(productService, environmentService) && productService.telemetryEndpoint) {
|
2024-05-08 03:33:03 +08:00
|
|
|
+ oneDsAppender = new OneDataSystemAppender(requestService, isInternal, eventPrefix, null, () => new TelemetryClient(productService.telemetryEndpoint!, machineId, isContainer));
|
2023-09-21 07:33:28 +08:00
|
|
|
disposables.add(toDisposable(() => oneDsAppender?.flush())); // Ensure the AI appender is disposed so that it flushes remaining data
|
2022-05-05 07:32:12 +08:00
|
|
|
}
|
2024-05-07 11:27:34 +08:00
|
|
|
|
2022-05-05 07:32:12 +08:00
|
|
|
Index: code-server/lib/vscode/src/vs/server/node/telemetryClient.ts
|
|
|
|
===================================================================
|
|
|
|
--- /dev/null
|
|
|
|
+++ code-server/lib/vscode/src/vs/server/node/telemetryClient.ts
|
2024-06-13 07:09:45 +08:00
|
|
|
@@ -0,0 +1,71 @@
|
2022-08-17 09:26:19 +08:00
|
|
|
+import { AppInsightsCore, IExtendedTelemetryItem, ITelemetryItem } from '@microsoft/1ds-core-js';
|
2022-05-05 07:32:12 +08:00
|
|
|
+import * as https from 'https';
|
|
|
|
+import * as http from 'http';
|
|
|
|
+import * as os from 'os';
|
|
|
|
+
|
2024-06-13 07:09:45 +08:00
|
|
|
+interface SystemInfo {
|
|
|
|
+ measurements: Record<string, number | undefined>;
|
|
|
|
+ properties: Record<string, string | boolean | null | undefined>;
|
|
|
|
+}
|
|
|
|
+
|
2022-08-17 09:26:19 +08:00
|
|
|
+export class TelemetryClient extends AppInsightsCore {
|
2024-06-13 07:09:45 +08:00
|
|
|
+ private readonly systemInfo: SystemInfo = {
|
|
|
|
+ measurements: {},
|
|
|
|
+ properties: {},
|
|
|
|
+ };
|
|
|
|
+
|
2024-05-07 07:53:53 +08:00
|
|
|
+ public constructor(
|
|
|
|
+ private readonly endpoint: string,
|
2024-06-13 07:09:45 +08:00
|
|
|
+ machineId: string,
|
|
|
|
+ isContainer: boolean | undefined) {
|
2022-08-17 09:26:19 +08:00
|
|
|
+ super();
|
2024-06-13 07:09:45 +08:00
|
|
|
+
|
|
|
|
+ // os.cpus() can take a very long time sometimes (personally I see 1-2
|
|
|
|
+ // seconds in a Coder workspace). This adds up significantly, especially
|
|
|
|
+ // when many telemetry requests are sent during startup, which can cause
|
|
|
|
+ // connection timeouts. Try to cache as much as we can.
|
|
|
|
+ try {
|
|
|
|
+ const cpus = os.cpus();
|
|
|
|
+ this.systemInfo.measurements.cores = cpus.length;
|
|
|
|
+ this.systemInfo.properties['common.cpuModel'] = cpus[0].model;
|
|
|
|
+ } catch (error) {}
|
|
|
|
+
|
|
|
|
+ try {
|
|
|
|
+ this.systemInfo.properties['common.shell'] = os.userInfo().shell;
|
|
|
|
+ this.systemInfo.properties['common.release'] = os.release();
|
|
|
|
+ this.systemInfo.properties['common.arch'] = os.arch();
|
|
|
|
+ } catch (error) {}
|
|
|
|
+
|
|
|
|
+ this.systemInfo.properties['common.remoteMachineId'] = machineId;
|
|
|
|
+ this.systemInfo.properties['common.isContainer'] = isContainer;
|
2022-05-05 07:32:12 +08:00
|
|
|
+ }
|
|
|
|
+
|
2022-08-17 09:26:19 +08:00
|
|
|
+ public override track(item: IExtendedTelemetryItem | ITelemetryItem): void {
|
|
|
|
+ const options = item.baseData || {}
|
2024-06-13 07:09:45 +08:00
|
|
|
+ options.measurements = {
|
|
|
|
+ ...(options.measurements || {}),
|
|
|
|
+ ...this.systemInfo.measurements,
|
2022-05-05 07:32:12 +08:00
|
|
|
+ }
|
2024-06-13 07:09:45 +08:00
|
|
|
+ options.properties = {
|
|
|
|
+ ...(options.properties || {}),
|
|
|
|
+ ...this.systemInfo.properties,
|
2022-05-05 07:32:12 +08:00
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ try {
|
|
|
|
+ options.measurements.memoryFree = os.freemem();
|
|
|
|
+ options.measurements.memoryTotal = os.totalmem();
|
|
|
|
+ } catch (error) {}
|
|
|
|
+
|
|
|
|
+ try {
|
|
|
|
+ const request = (/^http:/.test(this.endpoint) ? http : https).request(this.endpoint, {
|
|
|
|
+ method: 'POST',
|
|
|
|
+ headers: {
|
|
|
|
+ 'Content-Type': 'application/json',
|
|
|
|
+ },
|
|
|
|
+ });
|
|
|
|
+ request.on('error', () => { /* We don't care. */ });
|
|
|
|
+ request.write(JSON.stringify(options));
|
|
|
|
+ request.end();
|
|
|
|
+ } catch (error) {}
|
|
|
|
+ }
|
|
|
|
+}
|
2022-06-22 05:51:46 +08:00
|
|
|
Index: code-server/lib/vscode/src/vs/server/node/webClientServer.ts
|
|
|
|
===================================================================
|
|
|
|
--- code-server.orig/lib/vscode/src/vs/server/node/webClientServer.ts
|
|
|
|
+++ code-server/lib/vscode/src/vs/server/node/webClientServer.ts
|
2024-05-07 08:58:07 +08:00
|
|
|
@@ -318,6 +318,8 @@ export class WebClientServer {
|
2023-05-16 07:44:03 +08:00
|
|
|
scope: vscodeBase + '/',
|
|
|
|
path: base + '/_static/out/browser/serviceWorker.js',
|
2022-06-22 05:51:46 +08:00
|
|
|
},
|
2023-05-16 07:44:03 +08:00
|
|
|
+ enableTelemetry: this._productService.enableTelemetry,
|
2024-05-07 08:58:07 +08:00
|
|
|
+ telemetryEndpoint: this._productService.telemetryEndpoint,
|
2023-05-16 07:44:03 +08:00
|
|
|
embedderIdentifier: 'server-distro',
|
|
|
|
extensionsGallery: this._productService.extensionsGallery,
|
2024-06-07 07:02:13 +08:00
|
|
|
} satisfies Partial<IProductConfiguration>;
|
2024-05-07 08:58:07 +08:00
|
|
|
Index: code-server/lib/vscode/src/vs/base/common/product.ts
|
|
|
|
===================================================================
|
|
|
|
--- code-server.orig/lib/vscode/src/vs/base/common/product.ts
|
|
|
|
+++ code-server/lib/vscode/src/vs/base/common/product.ts
|
|
|
|
@@ -64,6 +64,7 @@ export interface IProductConfiguration {
|
|
|
|
readonly path: string;
|
|
|
|
readonly scope: string;
|
|
|
|
}
|
|
|
|
+ readonly telemetryEndpoint?: string
|
|
|
|
|
|
|
|
readonly version: string;
|
|
|
|
readonly date?: string;
|
|
|
|
Index: code-server/lib/vscode/src/vs/platform/product/common/product.ts
|
|
|
|
===================================================================
|
|
|
|
--- code-server.orig/lib/vscode/src/vs/platform/product/common/product.ts
|
|
|
|
+++ code-server/lib/vscode/src/vs/platform/product/common/product.ts
|
|
|
|
@@ -55,7 +55,8 @@ else if (globalThis._VSCODE_PRODUCT_JSON
|
|
|
|
resourceUrlTemplate: "https://open-vsx.org/vscode/asset/{publisher}/{name}/{version}/Microsoft.VisualStudio.Code.WebResources/{path}",
|
|
|
|
controlUrl: "",
|
|
|
|
recommendationsUrl: "",
|
|
|
|
- })
|
|
|
|
+ }),
|
|
|
|
+ telemetryEndpoint: env.CS_TELEMETRY_URL || product.telemetryEndpoint || "https://v1.telemetry.coder.com/track",
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|