Skip to main content

Interface: IWorkerHeartbeat

worker.v1.IWorkerHeartbeat

Properties of a WorkerHeartbeat.

Implemented by

Properties

activityPollerInfo

Optional activityPollerInfo: null | IWorkerPollerInfo

WorkerHeartbeat activityPollerInfo


activityTaskSlotsInfo

Optional activityTaskSlotsInfo: null | IWorkerSlotsInfo

WorkerHeartbeat activityTaskSlotsInfo


currentStickyCacheSize

Optional currentStickyCacheSize: null | number

Current cache size, expressed in number of Workflow Executions.


deploymentVersion

Optional deploymentVersion: null | IWorkerDeploymentVersion

WorkerHeartbeat deploymentVersion


elapsedSinceLastHeartbeat

Optional elapsedSinceLastHeartbeat: null | IDuration

Elapsed time since the last heartbeat from the worker.


heartbeatTime

Optional heartbeatTime: null | ITimestamp

Timestamp of this heartbeat, coming from the worker. Worker should set it to "now". Note that this timestamp comes directly from the worker and is subject to workers' clock skew.


hostInfo

Optional hostInfo: null | IWorkerHostInfo

Worker host information.


localActivitySlotsInfo

Optional localActivitySlotsInfo: null | IWorkerSlotsInfo

WorkerHeartbeat localActivitySlotsInfo


nexusPollerInfo

Optional nexusPollerInfo: null | IWorkerPollerInfo

WorkerHeartbeat nexusPollerInfo


nexusTaskSlotsInfo

Optional nexusTaskSlotsInfo: null | IWorkerSlotsInfo

WorkerHeartbeat nexusTaskSlotsInfo


plugins

Optional plugins: null | IPluginInfo[]

Plugins currently in use by this SDK.


sdkName

Optional sdkName: null | string

WorkerHeartbeat sdkName


sdkVersion

Optional sdkVersion: null | string

WorkerHeartbeat sdkVersion


startTime

Optional startTime: null | ITimestamp

Worker start time. It can be used to determine worker uptime. (current time - start time)


status

Optional status: null | WorkerStatus

Worker status. Defined by SDK.


taskQueue

Optional taskQueue: null | string

Task queue this worker is polling for tasks.


totalStickyCacheHit

Optional totalStickyCacheHit: null | number

A Workflow Task found a cached Workflow Execution to run against.


totalStickyCacheMiss

Optional totalStickyCacheMiss: null | number

A Workflow Task did not find a cached Workflow execution to run against.


workerIdentity

Optional workerIdentity: null | string

Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.


workerInstanceKey

Optional workerInstanceKey: null | string

Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.


workflowPollerInfo

Optional workflowPollerInfo: null | IWorkerPollerInfo

WorkerHeartbeat workflowPollerInfo


workflowStickyPollerInfo

Optional workflowStickyPollerInfo: null | IWorkerPollerInfo

WorkerHeartbeat workflowStickyPollerInfo


workflowTaskSlotsInfo

Optional workflowTaskSlotsInfo: null | IWorkerSlotsInfo

WorkerHeartbeat workflowTaskSlotsInfo