telemetry: add more fields to data

Fixes #7866

This PR updates the `installation-admin-controller` to also retrieve
more data to send with telemetry. These are not part of the
`installationAdminDb` as we do not want to store this in the database
but lazily retrieve whenever a request is sent to `/data` endpoint
of the `installation-admin` express app unlike the `uuid` and settings
which need to be stored and updated.

The following fields are added:
- `totalUsers` : specifies the total number of users in the instance
- `totalWorkspaces`: specifies the total number of **regular** workspaces in the instance
- `totalInstances`: specifies the total number of **regular** workspace instances in the gitpod instance

Signed-off-by: Tarun Pothulapati <[email protected]>

Author: Pothulapati

components/gitpod-db/src/typeorm/workspace-db-impl.ts

@@ -158,7 +158,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
             .addOrderBy('GREATEST(ws.creationTime, wsi.creationTime, wsi.startedTime, wsi.stoppedTime)', 'DESC')
             .limit(options.limit || 10);
         if (options.searchString) {
-            qb.andWhere("ws.description LIKE :searchString", {searchString: `%${options.searchString}%`});
+            qb.andWhere("ws.description LIKE :searchString", { searchString: `%${options.searchString}%` });
         }
         if (!options.includeHeadless) {
             qb.andWhere("ws.type = 'regular'");
@@ -334,6 +334,15 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         return { total, rows };
     }
 
+    public async getInstanceCount(type?: string): Promise<number> {
+        const workspaceInstanceRepo = await this.getWorkspaceInstanceRepo();
+        const queryBuilder = workspaceInstanceRepo.createQueryBuilder("wsi")
+            .leftJoinAndMapOne("wsi.workspace", DBWorkspace, "ws", "wsi.workspaceId = ws.id")
+            .where("ws.type = :type", { type: type ? type.toString() : "regular" }); // only regular workspaces by default
+
+        return await queryBuilder.getCount();
+    }
+
     public async findRegularRunningInstances(userId?: string): Promise<WorkspaceInstance[]> {
         const infos = await this.findRunningInstancesWithWorkspaces(undefined, userId);
         return infos.filter(
@@ -578,7 +587,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
 
     public async findSnapshotsByWorkspaceId(workspaceId: string): Promise<Snapshot[]> {
         const snapshots = await this.getSnapshotRepo();
-        return snapshots.find({where: {originalWorkspaceId: workspaceId}});
+        return snapshots.find({ where: { originalWorkspaceId: workspaceId } });
     }
 
     public async storePrebuiltWorkspace(pws: PrebuiltWorkspace): Promise<PrebuiltWorkspace> {
@@ -596,7 +605,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         }
         const repo = await this.getPrebuiltWorkspaceRepo();
         return await repo.createQueryBuilder('pws')
-            .where('pws.cloneURL = :cloneURL AND pws.commit LIKE :commit', { cloneURL, commit: commit+'%' })
+            .where('pws.cloneURL = :cloneURL AND pws.commit LIKE :commit', { cloneURL, commit: commit + '%' })
             .orderBy('pws.creationTime', 'DESC')
             .innerJoinAndMapOne('pws.workspace', DBWorkspace, 'ws', "pws.buildWorkspaceId = ws.id and ws.contentDeletedTime = ''")
             .getOne();
@@ -737,7 +746,13 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         return { total, rows };
     }
 
+    public async getWorkspaceCount(type?: String): Promise<Number> {
+        const workspaceRepo = await this.getWorkspaceRepo();
+        const queryBuilder = workspaceRepo.createQueryBuilder("ws")
+            .where("ws.type = :type", { type: type ? type.toString() : "regular" }); // only regular workspaces by default
 
+        return await queryBuilder.getCount();
+    }
 
     public async findAllWorkspaceAndInstances(offset: number, limit: number, orderBy: keyof WorkspaceAndInstance, orderDir: "ASC" | "DESC", query?: AdminGetWorkspacesQuery, searchTerm?: string): Promise<{ total: number, rows: WorkspaceAndInstance[] }> {
         let whereConditions = [];
@@ -827,7 +842,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         const workspaceRepo = await this.getWorkspaceRepo();
         const workspace = await workspaceRepo.findOne(id);
         if (!workspace) {
-             return;
+            return;
         }
 
         const instance = await this.findCurrentInstance(id);
@@ -899,7 +914,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         });
     }
 
-    async findPrebuildInfos(prebuildIds: string[]): Promise<PrebuildInfo[]>{
+    async findPrebuildInfos(prebuildIds: string[]): Promise<PrebuildInfo[]> {
         const repo = await this.getPrebuildInfoRepo();
 
         const query = repo.createQueryBuilder('pi');
@@ -908,7 +923,7 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         if (filteredIds.length === 0) {
             return [];
         }
-        query.andWhere(`pi.prebuildId in (${ filteredIds.map(id => `'${id}'`).join(", ") })`)
+        query.andWhere(`pi.prebuildId in (${filteredIds.map(id => `'${id}'`).join(", ")})`)
 
         const res = await query.getMany();
         return res.map(r => r.info);

components/gitpod-db/src/workspace-db.ts

@@ -34,7 +34,7 @@ export interface WorkspacePortsAuthData {
     workspace: WorkspaceAuthData;
 }
 
-export type WorkspaceInstanceSession = Pick<WorkspaceInstance, "id" | "startedTime"| "stoppingTime" | "stoppedTime">;
+export type WorkspaceInstanceSession = Pick<WorkspaceInstance, "id" | "startedTime" | "stoppingTime" | "stoppedTime">;
 export type WorkspaceSessionData = Pick<Workspace, "id" | "contextURL" | "context" | "type">;
 export interface WorkspaceInstanceSessionWithWorkspace {
     instance: WorkspaceInstanceSession;
@@ -67,7 +67,7 @@ export interface WorkspaceDB {
 
     // Partial update: unconditional, single field updates. Enclose in a transaction if necessary
     updateLastHeartbeat(instanceId: string, userId: string, newHeartbeat: Date, wasClosed?: boolean): Promise<void>;
-    getLastOwnerHeartbeatFor(instance: WorkspaceInstance): Promise<{ lastSeen:Date, wasClosed?: boolean} | undefined>;
+    getLastOwnerHeartbeatFor(instance: WorkspaceInstance): Promise<{ lastSeen: Date, wasClosed?: boolean } | undefined>;
     getWorkspaceUsers(workspaceId: string, minLastSeen: number): Promise<WorkspaceInstanceUser[]>;
     updateInstancePartial(instanceId: string, partial: DeepPartial<WorkspaceInstance>): Promise<WorkspaceInstance>;
 
@@ -85,12 +85,15 @@ export interface WorkspaceDB {
     findWorkspaceAndInstance(id: string): Promise<WorkspaceAndInstance | undefined>;
     findInstancesByPhaseAndRegion(phase: string, region: string): Promise<WorkspaceInstance[]>;
 
+    getWorkspaceCount(type?: String): Promise<Number>;
+    getInstanceCount(type?: string): Promise<number>
+
     findAllWorkspaceInstances(offset: number, limit: number, orderBy: keyof WorkspaceInstance, orderDir: "ASC" | "DESC", ownerId?: string, minCreationTime?: Date, maxCreationTime?: Date, onlyRunning?: boolean, type?: WorkspaceType): Promise<{ total: number, rows: WorkspaceInstance[] }>;
 
     findRegularRunningInstances(userId?: string): Promise<WorkspaceInstance[]>;
     findRunningInstancesWithWorkspaces(installation?: string, userId?: string, includeStopping?: boolean): Promise<RunningWorkspaceInfo[]>;
 
-    isWhitelisted(repositoryUrl : string): Promise<boolean>;
+    isWhitelisted(repositoryUrl: string): Promise<boolean>;
     getFeaturedRepositories(): Promise<Partial<WhitelistedRepository>[]>;
 
     findSnapshotById(snapshotId: string): Promise<Snapshot | undefined>;

components/gitpod-protocol/src/installation-admin-protocol.ts

@@ -23,6 +23,13 @@ export interface InstallationAdmin {
     settings: InstallationAdminSettings;
 }
 
+export interface Data {
+    installationAdmin: InstallationAdmin
+    totalUsers: number
+    totalWorkspaces: number
+    totalInstances: number
+}
+
 export namespace InstallationAdmin {
     export function createDefault(): InstallationAdmin {
         return {

components/installation-telemetry/cmd/send.go

@@ -31,7 +31,7 @@ var sendCmd = &cobra.Command{
 			return err
 		}
 
-		if !data.Settings.SendTelemetry {
+		if !data.InstallationAdmin.Settings.SendTelemetry {
 			log.Info("installation-telemetry is not permitted to send - exiting")
 			return nil
 		}
@@ -51,10 +51,13 @@ var sendCmd = &cobra.Command{
 		}()
 
 		telemetry := analytics.Track{
-			UserId: data.ID,
+			UserId: data.InstallationAdmin.ID,
 			Event:  "Installation telemetry",
 			Properties: analytics.NewProperties().
-				Set("version", versionId),
+				Set("version", versionId).
+				Set("totalUsers", data.TotalUsers).
+				Set("totalWorkspaces", data.TotalWorkspaces).
+				Set("totalInstances", data.TotalInstances),
 		}
 
 		client.Enqueue(telemetry)

components/installation-telemetry/pkg/server/installationAdmin.go

@@ -17,12 +17,19 @@ type InstallationAdminSettings struct {
 	SendTelemetry bool `json:"sendTelemetry"`
 }
 
-type InstallationAdminData struct {
+type Data struct {
+	InstallationAdmin InstallationAdmin `json:"installationAdmin"`
+	TotalUsers        int64             `json:"totalUsers"`
+	TotalWorkspaces   int64             `json:"totalWorkspaces"`
+	TotalInstances    int64             `json:"totalInstances"`
+}
+
+type InstallationAdmin struct {
 	ID       string                    `json:"id"`
 	Settings InstallationAdminSettings `json:"settings"`
 }
 
-func GetInstallationAdminData(config common.Config) (*InstallationAdminData, error) {
+func GetInstallationAdminData(config common.Config) (*Data, error) {
 	resp, err := http.Get(fmt.Sprintf("%s/data", config.Server))
 	if err != nil {
 		return nil, err
@@ -35,7 +42,7 @@ func GetInstallationAdminData(config common.Config) (*InstallationAdminData, err
 		return nil, err
 	}
 
-	var data InstallationAdminData
+	var data Data
 	if err := json.Unmarshal(body, &data); err != nil {
 		return nil, err
 	}

components/server/src/installation-admin/installation-admin-controller.ts

@@ -6,17 +6,25 @@
 
 import { injectable, inject } from 'inversify';
 import * as express from 'express';
-import { InstallationAdminDB } from '@gitpod/gitpod-db/lib';
+import { InstallationAdminDB, UserDB, WorkspaceDB } from '@gitpod/gitpod-db/lib';
+import { Data } from '@gitpod/gitpod-protocol'
 
 @injectable()
 export class InstallationAdminController {
     @inject(InstallationAdminDB) protected readonly installationAdminDb: InstallationAdminDB;
+    @inject(UserDB) protected readonly userDb: UserDB
+    @inject(WorkspaceDB) protected readonly workspaceDb: WorkspaceDB
 
     public create(): express.Application {
         const app = express();
 
         app.get('/data', async (req: express.Request, res: express.Response) => {
-            const data = await this.installationAdminDb.getData();
+            const data: Data = {
+                installationAdmin: await this.installationAdminDb.getData(),
+                totalUsers: await this.userDb.getUserCount(true),
+                totalWorkspaces: await this.workspaceDb.getWorkspaceCount(),
+                totalInstances: await this.workspaceDb.getInstanceCount(),
+            } as Data;
 
             res.status(200).json(data);
         });