Add more telemetry statistic data

package.json

@@ -1,10 +1,10 @@
 {
   "name": "crust-smanager",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "A storage manager integrated with Crust, IPFS and sWorker(storage inspector) of Crust protocol.",
   "main": "build/src/main.js",
   "repository": "https://github.com/crustio/crust-smanager.git",
-  "author": "Zikun Fan <kun@crust.network>",
+  "author": "Brian Wu <brianwu@crust.network>",
   "engines": {
     "node": ">= 14.16 <15"
   },
@@ -30,7 +30,8 @@
     "sqlite3": "^5.0.2",
     "tslib": "~2.3.0",
     "umzug": "^3.0.0-beta.16",
-    "winston": "^3.3.3"
+    "winston": "^3.3.3",
+    "node-os-utils": "^1.3.7"
   },
   "devDependencies": {
     "@types/bignumber.js": "^5.0.0",

src/sworker/index.ts

@@ -1,6 +1,7 @@
 import axios, { AxiosInstance } from 'axios';
 import qs from 'querystring';
 import {
+  EnclaveIdInfo,
   QuerySealInfoResult,
   SealInfoMap,
   SealInfoResp,
@@ -87,6 +88,13 @@ export default class SworkerApi {
     return parseObj(res.data);
   }
 
+  async getEnclaveIdInfo(): Promise<EnclaveIdInfo> {
+    const res = await this.sworker.get('/enclave/id_info');
+    if (!res || res.status !== 200) {
+      throw new Error(`invalid sworker response: ${res}`);
+    }
+    return parseObj(res.data);
+  }
   /// READ methods
   /**
    * Query local free storage size

src/tasks/node-info-updater-task.ts

@@ -5,7 +5,6 @@ import { AppContext } from '../types/context';
 import { SimpleTask } from '../types/tasks';
 import { formatError } from '../utils';
 import { SLOT_LENGTH } from '../utils/consts';
-import { Dayjs } from '../utils/datetime';
 import { makeIntervalTask } from './task-utils';
 
 // the storage key for 'swork->workReport'

src/tasks/telemetry-task.ts

@@ -5,19 +5,22 @@ import SworkerApi from '../sworker';
 import { AppContext } from '../types/context';
 import { PinStatus } from '../types/database';
 import { NormalizedConfig } from '../types/smanager-config';
-import { WorkloadInfo } from '../types/sworker';
+import { EnclaveIdInfo, WorkloadInfo } from '../types/sworker';
 import { SimpleTask } from '../types/tasks';
 import {
   PinStats,
   QueueInfo,
   SManagerInfo,
   TelemetryData,
   SWorkerStats,
+  OSInfo,
 } from '../types/telemetry';
 import { formatError, getTimestamp, toQuotedList } from '../utils';
 import { Dayjs } from '../utils/datetime';
 import { PendingStatus } from './pull-utils';
 import { makeIntervalTask } from './task-utils';
+import os from 'os';
+import osu from 'node-os-utils';
 
 const ReportSlotDuration = Dayjs.duration({
   hours: 24,
@@ -63,9 +66,11 @@ async function collectStats(
     [timeStart],
   );
   const workload = await getSworkerWorkload(sworkerApi, logger);
+  const enclaveIdInfo = await getSworkerEnclaveIdInfo(sworkerApi, logger);
   let reportWL: SWorkerStats;
   if (workload) {
     reportWL = {
+      id_info: enclaveIdInfo,
       srd: {
         srd_complete: workload.srd.srd_complete,
         srd_remaining_task: workload.srd.srd_remaining_task,
@@ -81,6 +86,8 @@ async function collectStats(
     reportWL = null;
   }
 
+  const osInfo = await collectOSInfo(logger);
+
   return {
     chainAccount: account,
     smangerInfo,
@@ -96,6 +103,7 @@ async function collectStats(
       deletedCount,
     },
     hasSealCoordinator: !!context.sealCoordinator,
+    osInfo
   };
 }
 
@@ -111,6 +119,18 @@ async function getSworkerWorkload(
   }
 }
 
+async function getSworkerEnclaveIdInfo(
+  sworkerApi: SworkerApi,
+  logger: Logger,
+): Promise<EnclaveIdInfo | null> {
+  try {
+    return await sworkerApi.getEnclaveIdInfo();
+  } catch (e) {
+    logger.error('failed to get sworker enclave id_info: %s', formatError(e));
+    return null;
+  }
+}
+
 async function collectQueueInfo(database): Promise<QueueInfo> {
   const { pendingCount } = await database.get(
     `select count(*) as pendingCount from file_record
@@ -164,16 +184,42 @@ async function getPinStats(database, timeStart: number): Promise<PinStats> {
   };
 }
 
+
+async function collectOSInfo(logger: Logger): Promise<OSInfo> {
+
+  try {
+    const kernel = os.release();
+    const uptime = os.uptime();
+    const cpuModel = osu.cpu.model();
+    const cpuCount = osu.cpu.count();
+    const memInfo = await osu.mem.info();
+
+    return {
+      kernel,
+      uptime,
+      cpuInfo: {
+        cpuModel,
+        cpuCount,
+      },
+      memInfo
+    }
+  }catch(err){
+    logger.error(`failed to collect os info: ${err}`);
+  }
+
+  return null;
+}
+
 export async function createTelemetryReportTask(
   context: AppContext,
   loggerParent: Logger,
 ): Promise<SimpleTask> {
-  const reportInterval = Dayjs.duration({
-    hours: 1,
-  }).asMilliseconds();
+  // const reportInterval = Dayjs.duration({
+  //   hours: 1,
+  // }).asMilliseconds();
   return makeIntervalTask(
-    300 * 1000,
-    reportInterval,
+    1 * 1000,
+    2 * 1000,
     'telemetry-report',
     context,
     loggerParent,

src/types/sworker.d.ts

@@ -33,6 +33,15 @@ export interface WorkloadInfo {
   };
 }
 
+export interface EnclaveIdInfo {
+  account: string;
+  attestation_mode: string | null;
+  mrenclave: string;
+  pub_key: string;
+  sworker_version: string;
+  version: string;
+}
+
 export type SealedType = 'valid' | 'lost' | 'pending';
 
 export interface SealInfoData {

src/types/telemetry.d.ts

@@ -10,9 +10,18 @@ export interface TelemetryData {
   cleanupStats: CleanupStats;
   groupInfo: GroupInfo;
   hasSealCoordinator: boolean;
+  osInfo: OSInfo | null;
 }
 
 export interface SWorkerStats {
+  id_info: {
+    account: string;
+    attestation_mode: string | null;
+    mrenclave: string;
+    pub_key: string;
+    sworker_version: string;
+    version: string;
+  };
   files: {
     lost: {
       num: number;
@@ -59,3 +68,19 @@ export interface PinStats {
 export interface CleanupStats {
   deletedCount: number;
 }
+
+export interface OSInfo {
+  kernel: string;
+  uptime: number;
+  cpuInfo: {
+    cpuModel: string;
+    cpuCount: number;
+  };
+  memInfo: {
+    totalMemMb: number;
+    usedMemMb: number;
+    freeMemMb: number;
+    usedMemPercentage: number;
+    freeMemPercentage: number;
+  };
+}