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 .

Tell us what you want to do:

I want to Blackfire
on
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).
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 Go Probe

  1. Import the Blackfire module in your code base:
    import github.com/blackfireio/go-blackfire
  2. Update your code to enable profiling in your Go applications.

Check that there are no errors in the logs. To debug problems, change the log level and the log file in the Probe configuration.

Enable Monitoring

You can now enable monitoring for your environments.

To profile applications, use the Go SDK.

For on-demand profiling, you need to install a profiling client:

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

Start profiling via: