X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=c92478d4a8436512853384f65ccce026f6528a19;hb=bb8907c8d1a6fc3f2d03c3d47406cdde29693fea;hp=d10a27c9171c978ce44e7b9f6a1d2a9fb66131db;hpb=a3ae469eebfcc990a251133beb01378599313233;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index d10a27c9..c92478d4 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,3 @@ -import type { EventLoopUtilization } from 'node:perf_hooks' import type { CircularArray } from '../circular-array' import type { Queue } from '../queue' @@ -7,7 +6,7 @@ import type { Queue } from '../queue' */ export type MessageHandler = ( this: Worker, - m: unknown + message: unknown ) => void /** @@ -15,7 +14,7 @@ export type MessageHandler = ( */ export type ErrorHandler = ( this: Worker, - e: Error + error: Error ) => void /** @@ -28,13 +27,13 @@ export type OnlineHandler = (this: Worker) => void */ export type ExitHandler = ( this: Worker, - code: number + exitCode: number ) => void /** * Message object that is passed as a task between main worker and worker. * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface Task { @@ -47,9 +46,9 @@ export interface Task { */ readonly data?: Data /** - * Submission timestamp. + * Timestamp. */ - readonly submissionTimestamp?: number + readonly timestamp?: number /** * Message UUID. */ @@ -57,65 +56,117 @@ export interface Task { } /** - * Worker tasks usage statistics. + * Measurement statistics. * * @internal */ -export interface TasksUsage { +export interface MeasurementStatistics { /** - * Number of tasks executed. + * Measurement aggregate. */ - ran: number + aggregate: number /** - * Number of tasks running. + * Measurement average. */ - running: number + average: number /** - * Tasks runtime. + * Measurement median. */ - runTime: number + median: number /** - * Tasks runtime history. + * Measurement history. */ - runTimeHistory: CircularArray + history: CircularArray +} + +/** + * Event loop utilization measurement statistics. + * + * @internal + */ +export interface EventLoopUtilizationMeasurementStatistics { + idle: MeasurementStatistics + active: MeasurementStatistics + utilization: number +} + +/** + * Task statistics. + * + * @internal + */ +export interface TaskStatistics { + /** + * Number of executed tasks. + */ + executed: number + /** + * Number of executing tasks. + */ + executing: number + /** + * Number of queued tasks. + */ + readonly queued: number /** - * Average tasks runtime. + * Maximum number of queued tasks. */ - avgRunTime: number + readonly maxQueued: number /** - * Median tasks runtime. + * Number of failed tasks. */ - medRunTime: number + failed: number +} + +/** + * Worker information. + * + * @internal + */ +export interface WorkerInfo { /** - * Tasks wait time. + * Worker Id. */ - waitTime: number + id: number | undefined /** - * Tasks wait time history. + * Started flag. */ - waitTimeHistory: CircularArray + started: boolean +} + +/** + * Worker usage statistics. + * + * @internal + */ +export interface WorkerUsage { /** - * Average tasks wait time. + * Tasks statistics. */ - avgWaitTime: number + tasks: TaskStatistics /** - * Median tasks wait time. + * Tasks runtime statistics. */ - medWaitTime: number + runTime: MeasurementStatistics /** - * Number of tasks errored. + * Tasks wait time statistics. */ - error: number + waitTime: MeasurementStatistics /** - * Event loop utilization. + * Tasks event loop utilization statistics. */ - elu: EventLoopUtilization | undefined + elu: EventLoopUtilizationMeasurementStatistics } /** * Worker interface. */ export interface IWorker { + /** + * Worker Id. + */ + id?: number + threadId?: number /** * Register an event listener. * @@ -139,7 +190,7 @@ export interface IWorker { * Worker node interface. * * @typeParam Worker - Type of worker. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. * @internal */ export interface WorkerNode { @@ -148,9 +199,13 @@ export interface WorkerNode { */ readonly worker: Worker /** - * Worker node tasks usage statistics. + * Worker node worker info. + */ + info: WorkerInfo + /** + * Worker node worker usage statistics. */ - tasksUsage: TasksUsage + usage: WorkerUsage /** * Worker node tasks queue. */