Installing Blackfire

Installing and updating Blackfire should be a quick process. This document will guide you through the steps.

For a better experience, you should or Sign Up.

Tell us what you want to do:

I want to Blackfire

which uses

for the language.

To start using Blackfire, we are going to install the following:

A language extension;
An agent to communicate with Blackfire's servers;
A profiling client (a browser extension or a CLI tool).

Configure the Debian Repository ¶

Blackfire uses a custom Debian repository to distribute its packages; it is compatible with most Debian-based distributions like Ubuntu and Linux-Mint.

wget -q -O - https://packages.blackfire.io/gpg.key | sudo dd of=/usr/share/keyrings/blackfire-archive-keyring.asc

Add the repository to Debian source list:

echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/blackfire-archive-keyring.asc] http://packages.blackfire.io/debian any main" | sudo tee /etc/apt/sources.list.d/blackfire.list

Update the repositories:
```
sudo apt update
```

Install the Packages ¶

Install the blackfire package:
```
sudo apt install blackfire
```

Configure and Run the Agent ¶
An agent has been detected An upgrade is available No agents have been detected

This command asks for some Blackfire server credentials, log in or sign up now to get them:

or Sign Up
Learn more about the agent configuration file.
Restart the agent service:
```
sudo systemctl restart blackfire-agent
```
During the agent installation, a new blackfire-agent service was created to start, stop, and restart it. Whenever you modify the agent configuration, restart it.
If something goes wrong, check out the log file generated by default in /var/log/blackfire/agent.log. Change the log file or the log level in the agent configuration file.

Install the PHP Probe ¶

Install the blackfire-php package:
```
sudo apt install blackfire-php
```
Restart your web server or PHP-FPM and check that there are no errors in the logs. To debug problems, you can change the log level and the log file in the Probe configuration.

Known incompatibilities

PHP will likely crash when Blackfire is used when one of the following extensions is also enabled: XHProf, Pinba, and Suhosin.

If XDebug is installed, the PHP engine may not behave as expected; consider disabling it when profiling.

If pcov extension is installed, Blackfire will not behave as expected; consider disabling it when profiling.

Enable Monitoring

You can now enable monitoring for your environments.

Install a Profiling Client ¶
Chrome Extension Installed Chrome Extension Upgrade Available Chrome Extension Not Installed

To profile applications, you need to use a profiling client:

Profile from a browser via our browser extensions (Web applications only).

Your browser is not supported. Please switch to Firefox or Google Chrome to be able to profile from a browser.
You are currently using Google Chrome.
Install the Blackfire Extension from the Google Chrome Web Store:

Install the Extension
1. Once the extension is installed, right click on the Extension icon in Chrome Menu and choose Options;
2. Change the Collector option to your Blackfire instance then click Save.
Congratulations! You can start profiling your applications from this browser as the Extension is already installed.
You are currently using Firefox.

Install the Blackfire extension from the Mozilla Add-On website:

Install the Extension
Profile from the command line via the blackfire tool (Web applications, APIs, command line tools, daemons, and more).

Configure it with your personal credentials:
```
blackfire client:config --client-id=CLIENT_ID --client-token=CLIENT_TOKEN
```

Start Profiling ¶

Start profiling via: