refactor: measure -> measurement
[poolifier.git] / src / pools / worker.ts
index 7bf86848690538010dd9acbf3cb2cee2bb411c26..ba9393ab9ba8241e5f1a1184165d42055b859835 100644 (file)
@@ -1,3 +1,4 @@
+import type { EventLoopUtilization } from 'node:perf_hooks'
 import type { CircularArray } from '../circular-array'
 import type { Queue } from '../queue'
 
@@ -46,45 +47,85 @@ export interface Task<Data = unknown> {
    */
   readonly data?: Data
   /**
-   * UUID of the message.
+   * Timestamp.
+   */
+  readonly timestamp?: number
+  /**
+   * Message UUID.
    */
   readonly id?: string
 }
 
 /**
- * Worker tasks usage statistics.
+ * Measurement statistics.
+ *
+ * @internal
+ */
+export interface MeasurementStatistics {
+  /**
+   * Measurement aggregation.
+   */
+  aggregation: number
+  /**
+   * Measurement average.
+   */
+  average: number
+  /**
+   * Measurement median.
+   */
+  median: number
+  /**
+   * Measurement history.
+   */
+  history: CircularArray<number>
+}
+
+/**
+ * Task statistics.
  *
  * @internal
  */
-export interface TasksUsage {
+export interface TaskStatistics {
   /**
    * Number of tasks executed.
    */
-  run: number
+  executed: number
+  /**
+   * Number of tasks executing.
+   */
+  executing: number
   /**
-   * Number of tasks running.
+   * Number of tasks queued.
    */
-  running: number
+  queued: number
   /**
-   * Tasks runtime.
+   * Number of tasks failed.
    */
-  runTime: number
+  failed: number
+}
+
+/**
+ * Worker usage statistics.
+ *
+ * @internal
+ */
+export interface WorkerUsage {
   /**
-   * Tasks runtime history.
+   * Tasks statistics.
    */
-  runTimeHistory: CircularArray<number>
+  tasks: TaskStatistics
   /**
-   * Average tasks runtime.
+   * Tasks runtime statistics.
    */
-  avgRunTime: number
+  runTime: MeasurementStatistics
   /**
-   * Median tasks runtime.
+   * Tasks wait time statistics.
    */
-  medRunTime: number
+  waitTime: MeasurementStatistics
   /**
-   * Number of tasks errored.
+   * Event loop utilization.
    */
-  error: number
+  elu: EventLoopUtilization | undefined
 }
 
 /**
@@ -123,9 +164,9 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
    */
   readonly worker: Worker
   /**
-   * Worker node tasks usage statistics.
+   * Worker node worker usage statistics.
    */
-  tasksUsage: TasksUsage
+  workerUsage: WorkerUsage
   /**
    * Worker node tasks queue.
    */