feat/added data point type to default metrics

Author: piotr-szewczyk

packages/node-core/src/types/opentelemetry.ts

@@ -115,6 +115,10 @@ export interface SumMetricData extends BaseMetricData {
     readonly dataPoints: DataPoint<number>[];
     readonly isMonotonic: boolean;
 }
+export interface TimeSeriesMetricData extends BaseMetricData {
+    readonly dataPointType: DataPointType.TIME_SERIES;
+    readonly dataPoints: DataPoint<number>[];
+}
 export interface GaugeMetricData extends BaseMetricData {
     readonly dataPointType: DataPointType.GAUGE;
     readonly dataPoints: DataPoint<number>[];
@@ -136,7 +140,7 @@ export interface ExponentialHistogramMetricData extends BaseMetricData {
 /**
  * Represents an aggregated metric data.
  */
-export type MetricData = SumMetricData | GaugeMetricData | HistogramMetricData | ExponentialHistogramMetricData;
+export type MetricData = SumMetricData | GaugeMetricData | TimeSeriesMetricData | HistogramMetricData | ExponentialHistogramMetricData;
 export interface ScopeMetrics {
     scope: InstrumentationScope;
     metrics: MetricData[];
@@ -167,7 +171,11 @@ export enum DataPointType {
      * A sum metric data point has a single numeric value and a
      * monotonicity-indicator.
      */
-    SUM = 3
+    SUM = 3,
+    /**
+     * A value correlated to time when occur
+     */
+    TIME_SERIES = 4
 }
 /**
  * Represents an aggregated point data with start time, end time and their

packages/node/src/metrics/default/cpu-usage.ts

@@ -1,5 +1,5 @@
 import * as os from "os";
-import { IMetrics, AverageCpuMetricType, InstrumentType, ValueType, MetricType } from "@traceo-sdk/node-core";
+import { IMetrics, AverageCpuMetricType, InstrumentType, ValueType, MetricType, utils, DataPointType } from "@traceo-sdk/node-core";
 
 export class CpuUsageMetrics implements IMetrics {
   private measureStart: AverageCpuMetricType;
@@ -22,7 +22,8 @@ export class CpuUsageMetrics implements IMetrics {
         type: InstrumentType.TIME_SERIES,
         valueType: ValueType.DOUBLE
       },
-      dataPoints: [{ value: cpuUsage }]
+      dataPointType: DataPointType.TIME_SERIES,
+      dataPoints: [{ value: cpuUsage, startTime: [utils.currentUnix()] }]
     }];
   }
 

packages/node/src/metrics/default/event-loop.ts

@@ -1,4 +1,4 @@
-import { utils, IMetrics, EventLoopMetricType, MetricType, InstrumentType, ValueType } from "@traceo-sdk/node-core";
+import { utils, IMetrics, EventLoopMetricType, MetricType, InstrumentType, ValueType, DataPointType } from "@traceo-sdk/node-core";
 
 let perf_hooks;
 try {
@@ -38,7 +38,8 @@ export class EventLoopMetrics implements IMetrics {
         type: InstrumentType.TIME_SERIES,
         valueType: ValueType.DOUBLE
       },
-      dataPoints: [{ value: data[metric] }]
+      dataPointType: DataPointType.TIME_SERIES,
+      dataPoints: [{ value: data[metric], startTime: [utils.currentUnix()] }]
     }));
 
     return response;

packages/node/src/metrics/default/heap.ts

@@ -1,4 +1,4 @@
-import { utils, IMetrics, MetricType, InstrumentType } from "@traceo-sdk/node-core";
+import { utils, IMetrics, MetricType, InstrumentType, DataPointType } from "@traceo-sdk/node-core";
 
 /**
  * https://www.geeksforgeeks.org/node-js-v8-getheapstatistics-method/
@@ -13,15 +13,18 @@ export class HeapMetrics implements IMetrics {
     return [
       {
         descriptor: { name: "heap_used", type: InstrumentType.TIME_SERIES },
-        dataPoints: [{ value: this.usedHeap }]
+        dataPointType: DataPointType.TIME_SERIES,
+        dataPoints: [{ value: this.usedHeap, startTime: [utils.currentUnix()] }]
       },
       {
         descriptor: { name: "heap_total", type: InstrumentType.TIME_SERIES },
-        dataPoints: [{ value: this.totalHeap }]
+        dataPointType: DataPointType.TIME_SERIES,
+        dataPoints: [{ value: this.totalHeap, startTime: [utils.currentUnix()] }]
       },
       {
         descriptor: { name: "heap_rss", type: InstrumentType.TIME_SERIES },
-        dataPoints: [{ value: this.rss }]
+        dataPointType: DataPointType.TIME_SERIES,
+        dataPoints: [{ value: this.rss, startTime: [utils.currentUnix()] }]
       },
     ];
   }

packages/node/src/metrics/default/memory-usage.ts

@@ -1,18 +1,20 @@
 import * as os from "os";
-import { IMetrics, utils, MetricType, InstrumentType } from "@traceo-sdk/node-core";
+import { IMetrics, utils, MetricType, InstrumentType, DataPointType } from "@traceo-sdk/node-core";
 
 export class MemoryUsageMetrics implements IMetrics {
   constructor() { }
 
   public collect(): MetricType {
     return [
       {
-        descriptor: { name: "memory_usage_mb", type: InstrumentType.TIME_SERIES, unit: "mb", },
-        dataPoints: [{ value: this.usedMemory }]
+        descriptor: { name: "memory_usage_mb", type: InstrumentType.TIME_SERIES, unit: "mb" },
+        dataPointType: DataPointType.TIME_SERIES,
+        dataPoints: [{ value: this.usedMemory, startTime: [utils.currentUnix()] }]
       },
       {
-        descriptor: { name: "memory_usage_percentage", type: InstrumentType.TIME_SERIES, unit: "mb", },
-        dataPoints: [{ value: this.percentageUsage }]
+        descriptor: { name: "memory_usage_percentage", type: InstrumentType.TIME_SERIES, unit: "mb" },
+        dataPointType: DataPointType.TIME_SERIES,
+        dataPoints: [{ value: this.percentageUsage, startTime: [utils.currentUnix()] }]
       }
     ];
   }

packages/node/src/metrics/index.ts

@@ -2,7 +2,7 @@ import { CpuUsageMetrics } from "./default/cpu-usage";
 import { EventLoopMetrics } from "./default/event-loop";
 import { HeapMetrics } from "./default/heap";
 import { MemoryUsageMetrics } from "./default/memory-usage";
-import { transport, CAPTURE_ENDPOINT, utils, MetricType, InstrumentType, ValueType, INodeClient } from "@traceo-sdk/node-core";
+import { transport, CAPTURE_ENDPOINT, utils, MetricType, InstrumentType, ValueType, INodeClient, DataPointType } from "@traceo-sdk/node-core";
 import * as os from "os";
 
 /**
@@ -79,9 +79,10 @@ export class MetricsRunner {
       descriptor: {
         name: "load_avg",
         type: InstrumentType.OBSERVABLE_GAUGE,
-        valueType: ValueType.DOUBLE
+        valueType: ValueType.DOUBLE,
       },
-      dataPoints: [{ value: load }]
+      dataPointType: DataPointType.GAUGE,
+      dataPoints: [{ value: load, startTime: [utils.currentUnix()] }]
     }]
   }
 }