A newer version of this documentation is available: View the Latest Version

Heartbeat

The pipeline heartbeat is a logic to execute steps, create and update pipelines.

The logic execution is available as a CLI command.

CLI Command

bin/magento pipeline:heartbeat

Example

Progress of a pending pipeline execution using the CLI command.

bin/magento pipeline:status
bin/magento pipeline:details 22
bin/magento pipeline:heartbeat
bin/magento pipeline:details 22
bin/magento pipeline:status

Output

bin/magento pipeline:status
output pending pipeline progress status 1
bin/magento pipeline:details 22
output pipeline details 22
bin/magento pipeline:heartbeat
bin/magento pipeline:details 22
output pipeline heartbeat details 22
bin/magento pipeline:status
output pending pipeline progress status 2
  • The heartbeat determines the next existing step to be processed and queues it for execution.

  • In our example, we use the step with the ID 174.

  • A PipelineRunner / Magento consumer must be running for actual processing in the message queue, which processes the steps held in reserve.