Work pool and work queue events - Prefect

Work pool and work queue events track readiness status transitions and field updates. These events are emitted server-side. For more on work pools, see Work pools.

Work pool events

`prefect.work-pool.{status}`

Emitted when a work pool's status transitions.

Status variants

Event name	Description
`prefect.work-pool.ready`	Work pool is ready to accept work
`prefect.work-pool.not-ready`	Work pool is not ready (for example, no online workers)
`prefect.work-pool.paused`	Work pool has been paused

Resource

Label	Description
`prefect.resource.id`	`prefect.work-pool.{uuid}`
`prefect.resource.name`	Work pool name
`prefect.work-pool.type`	Work pool type (for example, `kubernetes`, `process`, `docker`)

Related resources

This event has no related resources.

Payload

This event has no payload.

`prefect.work-pool.updated`

Emitted when one or more work pool fields are changed (excluding status transitions, which emit prefect.work-pool.{status} instead).

Resource

Label	Description
`prefect.resource.id`	`prefect.work-pool.{uuid}`
`prefect.resource.name`	Work pool name
`prefect.work-pool.type`	Work pool type

Related resources

This event has no related resources.

Payload

Field	Type	Description
`updated_fields`	array of strings	Names of fields that changed
`updates`	object	Map of field name to `{"from": <old>, "to": <new>}`

Work queue events

`prefect.work-queue.{status}`

Emitted when a work queue's status transitions.

Status variants

Event name	Description
`prefect.work-queue.ready`	Work queue is ready to dispatch work
`prefect.work-queue.not-ready`	Work queue is not ready
`prefect.work-queue.paused`	Work queue has been paused

Resource

Label	Description
`prefect.resource.id`	`prefect.work-queue.{uuid}`
`prefect.resource.name`	Work queue name

Related resources

Resource ID pattern	Role	When present
`prefect.work-pool.{uuid}`	`work-pool`	When the work queue belongs to a work pool (includes `prefect.work-pool.type` label)

Payload

This event has no payload.

`prefect.work-queue.updated`

Emitted when one or more work queue fields are changed (excluding status transitions).

Resource

Label	Description
`prefect.resource.id`	`prefect.work-queue.{uuid}`
`prefect.resource.name`	Work queue name

Related resources

Resource ID pattern	Role	When present
`prefect.work-pool.{uuid}`	`work-pool`	When the work queue belongs to a work pool (includes `prefect.work-pool.type` label)

Payload

Field	Type	Description
`updated_fields`	array of strings	Names of fields that changed
`updates`	object	Map of field name to `{"from": <old>, "to": <new>}`