performances_monitoring.md

Performances Monitoring

For heavy work there is multiple solutions to improve speed (TODO add link to multithreading cookbook) and memory consumption.

While developing custom tasks you might want to see how well your PHP code behaves, and one solution is to use Blackfire to analyse call graphs with timings & memory analysis.

Setup

If you're using the official PHP docker image, you can add the Blackfire probe to your container (Official documentation).

Then, with your own credentials, execute inside your container

blackfire config --client-id=$CLIENT_ID --client-token=$CLIENT_TOKEN

You can also pass those ids during the run call.

Usage

Just prefix blackfire run while executing your PHP commands inside your container, and Blackfire will provide you an URL with the resulting call graph. Be careful to cleanup the cache before calling Blackfire, to avoid any noise.

$ ./bin/console c:c --env=test

 // Clearing the cache for the test environment with debug true                                                         

                                                                                                                        
 [OK] Cache for the "test" environment (debug=true) was successfully cleared.                                           
                                                                                                                        

$ blackfire --client-id=xxx-xxx-xxx-xxx-xxx --client-token=xxxxxxxxxxx run php bin/console --env=test cleverage:process:execute test.simple_process
Starting process 'test.simple_process'...
Process 'test.simple_process' executed successfully

Blackfire Run completed
Graph URL https://blackfire.io/profiles/xxx-xxx-xxx-xxx-xxx/graph
No tests! Create some now https://blackfire.io/docs/cookbooks/tests
No recommendations

Wall Time     102ms
I/O Wait        n/a
CPU Time        n/a
Memory       5.35MB
Network         n/a     n/a     n/a
SQL             n/a     n/a