X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=b6dddd1d59ac24916dd8ab49591dc31c1edfa93a;hb=0cf6016cb529d6b7450438380e4deaa431fc61e3;hp=05b559850c3a16f4d682f25acaf42e20a3f982e0;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 05b55985..b6dddd1d 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,6 @@ +import type { EventLoopUtilization } from 'node:perf_hooks' import type { CircularArray } from '../circular-array' +import type { Queue } from '../queue' /** * Callback invoked if the worker has received a message. @@ -37,47 +39,93 @@ export type ExitHandler = ( */ export interface Task { /** - * Input data that will be passed to the worker. + * Task name. + */ + readonly name?: string + /** + * Task input data that will be passed to the worker. */ 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 +} + +/** + * 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 + readonly 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 + 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 } /** @@ -88,14 +136,14 @@ export interface IWorker { * Register an event listener. * * @param event - The event. - * @param handler - The event listener. + * @param handler - The event handler. */ on: ((event: 'message', handler: MessageHandler) => void) & ((event: 'error', handler: ErrorHandler) => void) & ((event: 'online', handler: OnlineHandler) => void) & ((event: 'exit', handler: ExitHandler) => void) /** - * Register a listener to the exit event that will only performed once. + * Register a listener to the exit event that will only be performed once. * * @param event - `'exit'`. * @param handler - The exit handler. @@ -116,11 +164,11 @@ export interface WorkerNode { */ readonly worker: Worker /** - * Worker node tasks usage statistics. + * Worker node worker usage statistics. */ - tasksUsage: TasksUsage + workerUsage: WorkerUsage /** * Worker node tasks queue. */ - readonly tasksQueue: Array> + readonly tasksQueue: Queue> }