Install Adobe Commerce Observability

This functionality is automatically available on Adobe Commerce as a Cloud Service (SaaS) projects. Adobe Commerce on-premises and Cloud infrastructure (PaaS) projects can install separate modules to provide this functionality.

Installation prerequisites

• Adobe Commerce on Cloud Infrastructure or on-premises: 2.4.5+
• PHP 8.1+
• Magento Open Source is not supported.

Installation

To install the observability module in Adobe Commerce:

1. Install the module:

   Copy
   composer require magento/module-out-of-process-observability=^1.1.0 --with-dependencies
   Copied to your clipboard
   composer require magento/module-out-of-process-observability=^1.1.0 --with-dependencies

2. Enable the installed module:

   Copy
   bin/magento module:enable Magento_OutOfProcessObservability
   Copied to your clipboard
   bin/magento module:enable Magento_OutOfProcessObservability

3. For on-premises installations, run the following command to upgrade Adobe Commerce and clear the cache.

   Copy
   bin/magento setup:upgrade && bin/magento cache:clean
   Copied to your clipboard
   bin/magento setup:upgrade && bin/magento cache:clean

Set up the message queue

The message queue must be configured and running to use observability. The message queue is used to send observability data asynchronously, ensuring that the main application flow is not blocked by observability operations. Consumers can be configured to run by cron jobs or as workers.

You can start the consumer to process logs, metrics, or tracing by running one or more of the following commands:

Copy
bin/magento queue:consumers:start commerce.observability.log --single-thread
Copied to your clipboard
bin/magento queue:consumers:start commerce.observability.log --single-thread

Copy
bin/magento queue:consumers:start commerce.observability.metrics --single-thread
Copied to your clipboard
bin/magento queue:consumers:start commerce.observability.metrics --single-thread

Copy
bin/magento queue:consumers:start commerce.observability.trace --single-thread
Copied to your clipboard
bin/magento queue:consumers:start commerce.observability.trace --single-thread

You can also run the the following command to trigger the cron jobs manually:

Copy
bin/magento cron:run
Copied to your clipboard
bin/magento cron:run

Last updated 12/2/2025

Was this helpful?

Yes

No