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:
v2 version is the one you want to use. If you have
automation based on the previous version, select
v1, which is still
supported until the Aug, 31th 2021.
If you are upgrading from v1, please read the upgrade guide.
To start using Blackfire, we are going to install the following:
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
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
sudo apt update
sudo apt install blackfire
This command asks for some Blackfire server credentials, log in or sign up now to get them:
or Sign UpLearn more about the agent configuration file.
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.
/var/log/blackfire/agent.log. Change the log file or the log level in the agent configuration file.
sudo apt install python-pip
pip install blackfire --user
If you have multiple versions of Python installed on your system, it is possible that
you have multiple versions of the
pip binary installed as well.
For example, you can have
pip2 installed for Python >= 2.0, and
for Python >= 3.0.
blackfire-python command is in your
pip package installs the
which can be used for zero configuration profiling.
The folder where
blackfire-python is installed may vary
depending on your Python environment (e.g.
Note that the folder
blackfire-python is installed in must be
If you previously installed Blackfire bootstrap configuration hook
blackfire_bootstrap.pth, in versions <=
you must uninstall it by running the following command:
python -m blackfire uninstall-bootstrap
You can now enable monitoring for your environments.
To profile applications, use the Python SDK.
For on-demand profiling, you need to install a profiling client:
Profile from a browser via our browser extensions (Web applications only).
Profile from the command line via the
(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 via: