Blackfire has built-in support for Magento Cloud projects.
The Blackfire Agent is already installed and enabled by default on all Magento Cloud accounts.
To activate the Blackfire Probe on integration branches, add the
PHP extension in your
.magento.app.yaml project file:
1 2 3 runtime: extensions: - blackfire
The Blackfire Probe can be installed and enabled by developers on Integration branches, and can be installed on Staging and Production branches with a request to Magento.
Set the Blackfire server credentials as environment variables, for each branch on which you want to configure Blackfire.
To auto-fill server credentials in the command below, log in first
magento-cloud variable:create integration env:BLACKFIRE_SERVER_ID=XXXX magento-cloud variable:create integration env:BLACKFIRE_SERVER_TOKEN=XXXX
Learn more about builds in the dedicated documentation.
Follow these steps to enable Blackfire builds on each of your MagentoCloud
environments each time a branch is deployed (after a
To auto-fill token credentials and environment UUID in the command below, log in first
magento-cloud integration:add --type=webhook --url='https://TOKEN_USER:TOKEN_PASSWORD@blackfire.io/api/v2/builds/env/ENV_UUID/magentocloud'
The command asks several questions. Hit the
Enter key to accept the default
for all of them. If you get a permission error, ask a project admin to
upgrade your account or ask someone who is an admin to run this command.
Now, whenever you push to a Magento Cloud environment, Blackfire will automatically trigger a build for this specific environment. In addition, Blackfire scenarios will be run for all your pull-requests.
If you are using Github, Bitbucket or Gitlab and if you have setup the synchronization with Magento Cloud, don’t forget to configure the corresponding notification channel. That way, Blackfire can update the status of your pull-requests / merge-requests.