feat: add crash report (#694)

Author: marknguyen1302

cortex-js/package.json

@@ -56,7 +56,7 @@
     "rxjs": "^7.8.1",
     "sqlite": "^5.1.1",
     "sqlite3": "^5.1.7",
-    "systeminformation": "^5.22.10",
+    "systeminformation": "^5.22.11",
     "typeorm": "^0.3.20",
     "ulid": "^2.3.0",
     "update-notifier": "^5.0.0",

cortex-js/src/app.module.ts

@@ -7,15 +7,17 @@ import { DatabaseModule } from './infrastructure/database/database.module';
 import { ChatModule } from './usecases/chat/chat.module';
 import { AssistantsModule } from './usecases/assistants/assistants.module';
 import { ExtensionModule } from './infrastructure/repositories/extensions/extension.module';
-import { ModelRepositoryModule } from './infrastructure/repositories/models/model.module';
 import { CortexModule } from './usecases/cortex/cortex.module';
 import { ConfigModule } from '@nestjs/config';
 import { env } from 'node:process';
 import { SeedService } from './usecases/seed/seed.service';
 import { FileManagerModule } from './infrastructure/services/file-manager/file-manager.module';
 import { AppLoggerMiddleware } from './infrastructure/middlewares/app.logger.middleware';
+import { TelemetryModule } from './usecases/telemetry/telemetry.module';
+import { APP_FILTER } from '@nestjs/core';
+import { GlobalExceptionFilter } from './infrastructure/exception/global.exception';
+import { UtilModule } from './util/util.module';
 import { EventEmitterModule } from '@nestjs/event-emitter';
-import { DownloadManagerModule } from './download-manager/download-manager.module';
 import { EventsController } from './infrastructure/controllers/events.controller';
 import { AssistantsController } from './infrastructure/controllers/assistants.controller';
 import { ChatController } from './infrastructure/controllers/chat.controller';
@@ -44,8 +46,8 @@ import { ProcessController } from './infrastructure/controllers/process.controll
     CortexModule,
     ExtensionModule,
     FileManagerModule,
-    ModelRepositoryModule,
-    DownloadManagerModule,
+    TelemetryModule,
+    UtilModule,
   ],
   controllers: [
     AssistantsController,
@@ -57,7 +59,13 @@ import { ProcessController } from './infrastructure/controllers/process.controll
     ProcessController,
     EventsController,
   ],
-  providers: [SeedService],
+  providers: [
+    SeedService,
+    {
+      provide: APP_FILTER,
+      useClass: GlobalExceptionFilter,
+    },
+  ],
 })
 export class AppModule implements NestModule {
   configure(consumer: MiddlewareConsumer): void {

cortex-js/src/command.module.ts

@@ -27,6 +27,9 @@ import { FileManagerModule } from './infrastructure/services/file-manager/file-m
 import { PSCommand } from './infrastructure/commanders/ps.command';
 import { KillCommand } from './infrastructure/commanders/kill.command';
 import { PresetCommand } from './infrastructure/commanders/presets.command';
+import { TelemetryModule } from './usecases/telemetry/telemetry.module';
+import { TelemetryCommand } from './infrastructure/commanders/telemetry.command';
+import { UtilModule } from './util/util.module';
 import { EmbeddingCommand } from './infrastructure/commanders/embeddings.command';
 import { BenchmarkCommand } from './infrastructure/commanders/benchmark.command';
 import { EventEmitterModule } from '@nestjs/event-emitter';
@@ -50,6 +53,8 @@ import { ServeStopCommand } from './infrastructure/commanders/sub-commands/serve
     AssistantsModule,
     MessagesModule,
     FileManagerModule,
+    TelemetryModule,
+    UtilModule,
     DownloadManagerModule,
   ],
   providers: [
@@ -80,6 +85,9 @@ import { ServeStopCommand } from './infrastructure/commanders/sub-commands/serve
     // Shortcuts
     RunCommand,
 
+    // Telemetry
+    TelemetryCommand,
+
     // Serve
     ServeStopCommand,
   ],

cortex-js/src/command.ts

@@ -2,10 +2,32 @@
 import { CommandFactory } from 'nest-commander';
 import { CommandModule } from './command.module';
 import updateNotifier from 'update-notifier';
-import packageJson from '@/../package.json';
+import packageJson from './../package.json';
+import { TelemetryUsecases } from './usecases/telemetry/telemetry.usecases';
+import { TelemetrySource } from './domain/telemetry/telemetry.interface';
+import { AsyncLocalStorage } from 'async_hooks';
+import { ContextService } from './util/context.service';
+
+export const asyncLocalStorage = new AsyncLocalStorage();
 
 async function bootstrap() {
-  await CommandFactory.run(CommandModule, ['warn', 'error']);
+  let telemetryUseCase: TelemetryUsecases | null = null;
+  let contextService: ContextService | null = null;
+  const app = await CommandFactory.createWithoutRunning(CommandModule, {
+    logger: ['warn', 'error'],
+    errorHandler: async (error) => {
+      await telemetryUseCase!.createCrashReport(error, TelemetrySource.CLI);
+      process.exit(1);
+    },
+    serviceErrorHandler: async (error) => {
+      await telemetryUseCase!.createCrashReport(error, TelemetrySource.CLI);
+      process.exit(1);
+    },
+  });
+  telemetryUseCase = await app.resolve(TelemetryUsecases);
+  contextService = await app.resolve(ContextService);
+  telemetryUseCase!.sendCrashReport();
+  await contextService!.init(async () => CommandFactory.runApplication(app));
   const notifier = updateNotifier({
     pkg: packageJson,
     updateCheckInterval: 1000 * 60 * 60, // 1 hour

cortex-js/src/domain/repositories/telemetry.interface.ts

@@ -0,0 +1,22 @@
+import {
+  CrashReportAttributes,
+  Telemetry,
+  TelemetrySource,
+} from '../telemetry/telemetry.interface';
+
+export abstract class TelemetryRepository {
+  abstract readCrashReports(
+    callback: (Telemetry: Telemetry) => void,
+  ): Promise<void>;
+  abstract createCrashReport(
+    crashReport: CrashReportAttributes,
+    source?: TelemetrySource,
+  ): Promise<void>;
+  abstract getLastCrashReport(): Promise<Telemetry | null>;
+  abstract markLastCrashReportAsSent(): Promise<void>;
+  abstract sendTelemetryToOTelCollector(
+    endpoint: string,
+    telemetry: Telemetry,
+  ): Promise<void>;
+  abstract sendTelemetryToServer(telemetry: Telemetry): Promise<void>;
+}

cortex-js/src/domain/telemetry/crash-report.interface.ts

@@ -0,0 +1,16 @@
+export interface TelemetryResource {
+  timestamp: number;
+  osName: string;
+  osVersion: string;
+  appVersion: string;
+  architecture: string;
+}
+
+export interface CrashReportAttributes {
+  timestamp: number;
+  modelId: string;
+  operation: string;
+  params: any;
+  contextLength: number;
+  tokenPerSecond: number;
+}

cortex-js/src/domain/telemetry/telemetry.interface.ts

@@ -0,0 +1,92 @@
+// TODO. move openTelemetry interfaces to dto
+export interface TelemetryResource {
+  osName: string;
+  osVersion: string;
+  architecture: string;
+  appVersion: string;
+  'service.name'?: string;
+  source?: TelemetrySource;
+  cpu?: string;
+  gpus?: string;
+  // todo: consider about sessionId
+  // sessionId: string;
+}
+
+export interface CrashReportEvent {
+  modelId?: string;
+  sessionId: string;
+  stack?: string;
+}
+
+export interface Resource {
+  attributes: Attribute[];
+}
+
+export enum TelemetrySource {
+  CLI = 'cli',
+  CORTEX_SERVER = 'cortex-server',
+  CORTEX_CPP = 'cortex-cpp',
+}
+
+export interface TelemetryEvent {
+  resource: Resource;
+  scopeLogs: ScopeLog[];
+}
+
+interface StringValue {
+  stringValue: string;
+}
+
+interface ObjectValue {
+  kvlist_value: {
+    values: {
+      key: string;
+      value: StringValue;
+    }[];
+  };
+}
+
+export interface Attribute {
+  key: string;
+  value: StringValue | ObjectValue;
+}
+
+interface ScopeLog {
+  scope: object;
+  logRecords: TelemetryLog[];
+}
+
+export interface TelemetryLog {
+  traceId: string;
+  startTimeUnixNano?: string;
+  endTimeUnixNano?: string;
+  severityText: string;
+  body: {
+    stringValue: string;
+  };
+  attributes: Attribute[];
+}
+
+export interface CrashReportPayload {
+  modelId?: string;
+  endpoint?: string;
+  command?: string;
+}
+
+export interface CrashReportAttributes {
+  stack?: string;
+  message: string;
+  payload: CrashReportPayload;
+}
+
+export interface TelemetryEventMetadata {
+  createdAt: string;
+  sentAt: string | null;
+}
+
+export interface Telemetry {
+  metadata: TelemetryEventMetadata;
+  event: {
+    resourceLogs: TelemetryEvent[];
+  };
+}

cortex-js/src/infrastructure/commanders/chat.command.ts

@@ -8,6 +8,8 @@ import { ChatCliUsecases } from './usecases/chat.cli.usecases';
 import { exit } from 'node:process';
 import { PSCliUsecases } from './usecases/ps.cli.usecases';
 import { ModelsUsecases } from '@/usecases/models/models.usecases';
+import { SetCommandContext } from './decorators/CommandContext';
+import { ContextService } from '@/util/context.service';
 import { ModelStat } from './types/model-stat.interface';
 
 type ChatOptions = {
@@ -26,12 +28,14 @@ type ChatOptions = {
     message: 'Message to send to the model',
   },
 })
+@SetCommandContext()
 export class ChatCommand extends CommandRunner {
   constructor(
     private readonly inquirerService: InquirerService,
     private readonly chatCliUsecases: ChatCliUsecases,
     private readonly modelsUsecases: ModelsUsecases,
     private readonly psCliUsecases: PSCliUsecases,
+    readonly contextService: ContextService,
   ) {
     super();
   }

cortex-js/src/infrastructure/commanders/cortex-command.commander.ts

@@ -9,6 +9,9 @@ import { PSCommand } from './ps.command';
 import { KillCommand } from './kill.command';
 import pkg from '@/../package.json';
 import { PresetCommand } from './presets.command';
+import { TelemetryCommand } from './telemetry.command';
+import { SetCommandContext } from './decorators/CommandContext';
+import { ContextService } from '@/util/context.service';
 import { EmbeddingCommand } from './embeddings.command';
 import { BenchmarkCommand } from './benchmark.command';
 import chalk from 'chalk';
@@ -25,12 +28,17 @@ import { printSlogan } from '@/utils/logo';
     PSCommand,
     KillCommand,
     PresetCommand,
+    TelemetryCommand,
     EmbeddingCommand,
     BenchmarkCommand,
   ],
   description: 'Cortex CLI',
 })
+@SetCommandContext()
 export class CortexCommand extends CommandRunner {
+  constructor(readonly contextService: ContextService) {
+    super();
+  }
   async run(): Promise<void> {
     printSlogan();
     console.log('\n');

cortex-js/src/infrastructure/commanders/decorators/CommandContext.ts

@@ -0,0 +1,34 @@
+type Constructor = new (...args: any[]) => any;
+
+export const SetCommandContext = () => {
+  return (constructor: Constructor) => {
+    const classMethods = Object.getOwnPropertyNames(constructor.prototype);
+
+    classMethods.forEach((methodName) => {
+      if (methodName !== 'run') return;
+      const originalMethod = constructor.prototype[methodName];
+      if (typeof originalMethod === 'function') {
+        constructor.prototype[methodName] = async function (...args: any[]) {
+          if (this.contextService) {
+            const parentCommandName = this.command.parent
+              ? this.command.parent.name()
+              : '';
+            const comamndName = this.command.name();
+            this.contextService.set(
+              'command',
+              `${parentCommandName} ${comamndName}`,
+            );
+            if (parentCommandName === 'models') {
+              const modelId = args[0]?.[0];
+              if (modelId) {
+                this.contextService.set('model', modelId);
+              }
+            }
+          }
+          const result = await originalMethod.apply(this, args);
+          return result;
+        };
+      }
+    });
+  };
+};