X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=86f5121dd1d73239c925c51319b6ff8bdc9b2a03;hb=465b29401ecddad49070d3b0df4e55dc3902788c;hp=35d2c0abaa331ecad6e9a0404deaa90c00ef7d4c;hpb=2cf93bc8e7b3d9c6c642288939732edd7cd9142d;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 35d2c0ab..86f5121d 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -6,7 +6,7 @@ import type { Queue } from '../queue' */ export type MessageHandler = ( this: Worker, - m: unknown + message: unknown ) => void /** @@ -14,7 +14,7 @@ export type MessageHandler = ( */ export type ErrorHandler = ( this: Worker, - e: Error + error: Error ) => void /** @@ -27,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 { @@ -46,9 +46,9 @@ export interface Task { */ readonly data?: Data /** - * Submission timestamp. + * Timestamp. */ - readonly submissionTimestamp?: number + readonly timestamp?: number /** * Message UUID. */ @@ -56,55 +56,90 @@ export interface Task { } /** - * Worker tasks usage statistics. + * Measurement statistics. * * @internal */ -export interface TasksUsage { +export interface MeasurementStatistics { /** - * Number of tasks executed. + * Measurement aggregate. */ - run: 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 /** - * Average tasks runtime. + * Number of executing tasks. */ - avgRunTime: number + executing: number /** - * Median tasks runtime. + * Number of queued tasks. */ - medRunTime: number + readonly queued: number /** - * Tasks wait time. + * Maximum number of queued tasks. */ - waitTime: number + readonly maxQueued: number + /** + * Number of failed tasks. + */ + failed: number +} + +/** + * Worker usage statistics. + * + * @internal + */ +export interface WorkerUsage { /** - * Tasks wait time history. + * Tasks statistics. */ - waitTimeHistory: CircularArray + tasks: TaskStatistics /** - * Average tasks wait time. + * Tasks runtime statistics. */ - avgWaitTime: number + runTime: MeasurementStatistics /** - * Median tasks wait time. + * Tasks wait time statistics. */ - medWaitTime: number + waitTime: MeasurementStatistics /** - * Number of tasks errored. + * Tasks event loop utilization statistics. */ - error: number + elu: EventLoopUtilizationMeasurementStatistics } /** @@ -134,7 +169,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 { @@ -143,9 +178,9 @@ export interface WorkerNode { */ readonly worker: Worker /** - * Worker node tasks usage statistics. + * Worker node worker usage statistics. */ - tasksUsage: TasksUsage + usage: WorkerUsage /** * Worker node tasks queue. */