main options modification, gc metrics

Author: piotrek98

lib/node/client.ts

@@ -43,7 +43,7 @@ export class Client {
   }
 
   get isCollectMetrics(): boolean {
-    return this.options?.metrics?.collect;
+    return this.options?.collectMetrics;
   }
 
   get isConnected(): boolean {
@@ -53,7 +53,7 @@ export class Client {
   private initSDK(): void {
     this.runtimeData.collect();
 
-    if (this.options.metrics.collect) {
+    if (this.options.collectMetrics) {
       this.metricsProbe.register();
     }
   }

lib/node/metrics.ts

@@ -7,6 +7,7 @@ import { EventLoopMetrics } from "./metrics/event-loop";
 import { HeapMetrics } from "./metrics/heap";
 import { MemoryUsageMetrics } from "./metrics/memory-usage";
 import * as os from "os";
+import { GCObserver } from "./metrics/gc-observer";
 
 const DEFAULT_INTERVAL = 30; //seconds
 
@@ -20,19 +21,22 @@ export class MetricsProbe {
   private readonly heap: HeapMetrics;
   private readonly memoryUsage: MemoryUsageMetrics;
 
+  private readonly gcObserver: GCObserver;
+
   constructor(options: TraceoOptions) {
-    if (!options.metrics.collect) {
+    if (!options?.collectMetrics) {
       return;
     }
 
-    this.interval = options.metrics.interval || DEFAULT_INTERVAL;
+    this.interval = options.scrapMetricsInterval || DEFAULT_INTERVAL;
 
     this.http = new HttpModule("/api/worker/metrics");
 
     this.cpuUsage = new CpuUsageMetrics();
     this.eventLoop = new EventLoopMetrics();
     this.heap = new HeapMetrics();
     this.memoryUsage = new MemoryUsageMetrics();
+    this.gcObserver = new GCObserver();
   }
 
   public register() {
@@ -44,13 +48,15 @@ export class MetricsProbe {
     const eventLoop = this.eventLoop.collect();
     const heap = this.heap.collect();
     const memory = this.memoryUsage.collect();
+    const gc = this.gcObserver.collect();
 
     const metrics: Partial<Metrics> = {
       cpuUsage,
       eventLoopLag: eventLoop,
       heap,
       memory,
       loadAvg: this.loadAvg,
+      gc,
     };
 
     this.http.request({

lib/node/metrics/gc-observer.ts

@@ -0,0 +1,43 @@
+import { IMetrics } from "../../core/interfaces/IMetrics";
+import * as perf_hooks from "node:perf_hooks";
+import { toDecimalNumber } from "../helpers";
+
+type GCObserverType = {
+  duration: {
+    total: number;
+    average: number;
+  };
+};
+
+export class GCObserver implements IMetrics<GCObserverType> {
+  private gcDurations: number[] = [];
+
+  // private GC_MAJOR: number = 0;
+  // private GC_MINOR: number = 0;
+  // private GC_INCREMENTAL: number = 0;
+  // private GC_WEAKCB: number = 0;
+
+  constructor() {
+    const obs = new perf_hooks.PerformanceObserver((list) => {
+      const entry = list.getEntries()[0];
+      // const kind = !entry.detail ? entry["kind"] : entry.detail["kind"];
+
+      this.gcDurations.push(entry.duration);
+    });
+    obs.observe({ entryTypes: ["gc"] });
+  }
+
+  collect(): GCObserverType {
+    const total = this.gcDurations.reduce((prev, curr) => prev + curr, 0);
+    const average = total / this.gcDurations.length;
+
+    this.gcDurations = [];
+
+    return {
+      duration: {
+        total: toDecimalNumber(total),
+        average: toDecimalNumber(average),
+      },
+    };
+  }
+}

lib/transport/metrics.ts

@@ -17,8 +17,11 @@ export interface Metrics {
     max: number;
     mean: number;
     stddev: number;
-    // p50: number;
-    // p90: number;
-    // p99: number;
+  };
+  gc: {
+    duration: {
+      total: number;
+      average: number;
+    };
   };
 }

lib/transport/options.ts

@@ -2,18 +2,16 @@ export interface TraceoOptions {
   appId: number;
   offline?: boolean;
   url: string;
-  metrics?: {
-    /* 
-      Determining if Traceo should collect metrics from the application.
-    */
-    collect?: boolean;
-    /*
-      The number of seconds that the metrics are downloaded. 
-      The minimum value for this field is 15. If the value is set below this value, 
-      then the data will be downloaded just for this time.
-    */
-    interval?: number;
-  };
+  /* 
+    Determining if Traceo should collect metrics from the application.
+  */
+  collectMetrics?: boolean;
+  /*
+    The number of seconds that the metrics are downloaded. 
+    The minimum value for this field is 15. If the value is set below this value, 
+    then the data will be downloaded just for this time.
+  */
+  scrapMetricsInterval?: number;
 }
 
 export interface ErrorMiddlewareOptions {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "traceo-sdk",
-  "version": "0.3.21-beta",
+  "version": "0.3.24-beta",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

test/client.test.ts

@@ -7,10 +7,8 @@ describe("TraceClient", () => {
   const clientOptions: TraceoOptions = {
     appId: 35,
     url: "/",
-    metrics: {
-      collect: true,
-      interval: 15,
-    },
+    collectMetrics: true,
+    scrapMetricsInterval: 15,
   };
 
   beforeEach(() => {