Blackfire can profile any code that you need to run on the command line thanks
to the blackfire
utility that is bundled with the Blackfire Agent.
Profiling a PHP script is a matter of prefixing your command with blackfire
run
:
1 2 | $ blackfire run php my-script.php
$ blackfire run php my-script.php --your-script-options and arguments
|
At the end of the execution, blackfire
outputs the URL where the profile
can be found (this can be hidden by passing the -q
option.)
To get more accurate results, you can also take several samples via the
--samples
option (only do that if you are sure that two successive calls to
your script does the same thing without unwanted side effects):
1 | $ blackfire --samples 10 run php my-script.php
|
You can integrate Blackfire results into your own tools by using the --json
option to get a JSON representation of a profile:
1 | $ blackfire --json run php my-script.php
|
Note
The JSON output is displayed on STDOUT
, while regular output (e.g.
progress, profile summary…) is displayed on STDERR
.
The resources consumed are available under the envelope
entry; keys are the
dimensions:
When using blackfire run
within a Premium or Enterprise subscription, you
can share the profiling result with your team. In order to do so, you will need
to specify the targeted environment with
the --env
option:
1 | $ blackfire --env <env-uuid> run php my-script.php
|
Blackfire automatically instruments your code, but sometimes, you might want to focus the profiling on only part of the code. That’s possible when opting for manual instrumentation via the PHP SDK.
After instrumenting your code, use the blackfire
utility as above to
profile your application. When not using Blackfire, all calls are converted to
no-ops.
Consumers and Daemons are special as they run for a very long time (or
indefinitely for daemons). In that case, using automatic instrumentation and
the blackfire
utility cannot work. Fortunately, the PHP SDK provides an abstraction that lets you profile
consumers and daemons.