Symfony PHP

Symfony HttpClient is a PHP HTTP client that sends HTTP requests and integrates well with web services. Integrating Blackfire with Symfony HttpClient lets you profile programmatically your websites, HTTP APIs, or web services.

Installation

First, add Blackfire PHP SDK as a dependency on your project.

Profiling

The Blackfire PHP SDK provides a Symfony HttpClient decorator that eases the profiling of requests made via HttpClient:

1
2
3
4
5
6
7
8
use Blackfire\Bridge\Symfony\BlackfiredHttpClient;
use Blackfire\Client;
use Blackfire\ClientConfiguration;
use Symfony\Component\HttpClient\HttpClient;

$blackfire = new BlackfireClient(new ClientConfiguration($clientId, $clientToken));

$httpClient = new BlackfiredHttpClient(HttpClient::create(), $blackfire);

Whenever you want to profile a request, set the blackfire extra option to true:

1
2
3
4
5
$response = $httpClient->request('GET', 'https://www.symfony.com/blog/', [
    'extra' => [
        'blackfire' => true,
    ],
]);

If you execute this script, a profile will be created on your Blackfire account and tests defined in your .blackfire.yaml if any will be executed as well.

If you want to better control the profile configuration, like the number of samples or the title of the profile, pass a \Blackfire\Profile\Configuration instance as the blackfire extra option value:

1
2
3
4
5
6
7
8
9
$config = new \Blackfire\Profile\Configuration();
$config->setSamples(10);
$config->setTitle('Blog Home');

$response = $httpClient->request('GET', 'https://www.symfony.com/blog/', [
    'extra' => [
        'blackfire' => $config,
    ],
]);

When running this script, you will get one profile which will be the aggregation of the 10 HTTP requests executed.

Learn more about profiling configuration settings in the PHP SDK documentation.