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.

The 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:

A language extension;
An agent to communicate with Blackfire's servers (as you chose a quick install, you will use a shared agent instead of installing one on your machine);
A profiling client (a browser extension or a CLI tool).

Install the Agent ¶

BLACKFIRE_CLIENT_ID="CLIENT_ID" \
BLACKFIRE_CLIENT_TOKEN="CLIENT_TOKEN" \
BLACKFIRE_SERVER_ID="SERVER_ID" \
BLACKFIRE_SERVER_TOKEN="SERVER_TOKEN" \
bash -c "$(curl -L https://installer.blackfire.io/installer.sh)"

This installs the APT package for the Blackfire Agent. It might prompt for your password to grant root privileges.

Install the Python Probe ¶

Install pip:
```
sudo apt install python-pip
```
Install the blackfire package:
```
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 pip3 installed for Python >= 3.0.
Ensure blackfire-python command is in your $PATH.
Blackfire pip package installs the blackfire-python command, which can be used for zero configuration profiling.

The folder where blackfire-python is installed may vary depending on your Python environment (e.g. pyenv, virtualenv).
Note that the folder blackfire-python is installed in must be in your $PATH.
If you previously installed Blackfire bootstrap configuration hook (blackfire_bootstrap.pth, in versions <= 1.4.5), you must uninstall it by running the following command:
```
python -m blackfire uninstall-bootstrap
```

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, 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).

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
If you are using Blackfire On-Premises, setup the Extension Collector:
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).

Start Profiling ¶

Start profiling via: