PhpStorm 2020.2 Help

Profiling with Zend debugger

Besides interactive debugging, PhpStorm integration with Zend Debugger also supports profiling. PhpStorm provides visual representation of profiling data generated by Zend Debugger.

Before profiling with Zend Debugger, download, install and configure the components of the PHP development environment. Normally, these are a PHP engine, a web server, and the Zend Debugger tool.

Enable profiling with Zend debugger

Configure Zend Debugger

  1. Download and install the Zend Debugger tool.

  2. Integrate Zend Debugger with the PHP engine.

  3. Integrate Xdebug with PhpStorm.

Configure the way to toggle the profiler from the browser

To specify the GET/POST or COOKIE parameters, do one of the following:

  • Generate the bookmarklets to toggle the debugger through. These bookmarklets will appear on the toolbar of your browser. They provide control over the debugger cookie, through them you will activate and deactivate the debugger.
    1. Enable the Bookmarks toolbar in your browser by doing one of the following depending on the browser type:

      • In Firefox, choose View | Toolbar | Bookmarks Toolbar.

      • In Chrome, choose Bookmarks | Show bookmarks bar.

    2. In the Settings/Preferences dialog Ctrl+Alt+S, navigate to Languages & Frameworks | PHP | Debug.

    3. On the Debug page, that opens, click the Use debugger bookmarklets to initiate debugger from your favorite browser link.

    4. On the Zend Debugger & Xdebug bookmarklets page that opens, check the debugging engine settings and click Generate. The bookmarks for listed debugging-related actions are generated.

    5. Drag the generated links to the bookmark toolbar in your browser.

  • Specify the values manually.

Analyze Zend debugger profiling data

When integration with the Zend Debugger profiler is enabled, PhpStorm provides visual representation of profiler snapshots. PhpStorm opens a separate editor tab with four views where the data are presented based on different criteria.

With Zend Debugger, profiling is supported within a zero configuration debugging session.

Initiating a zero configuration Zend Debugger session

  1. Generate the bookmarklets to toggle the debugger through. These bookmarklets will appear on the toolbar of your browser. They provide control over the debugger cookie, through them you will activate and deactivate the debugger.
    1. Enable the Bookmarks toolbar in your browser by doing one of the following depending on the browser type:

      • In Firefox, choose View | Toolbar | Bookmarks Toolbar.

      • In Chrome, choose Bookmarks | Show bookmarks bar.

    2. In the Settings/Preferences dialog Ctrl+Alt+S, navigate to Languages & Frameworks | PHP | Debug.

    3. On the Debug page, that opens, click the Use debugger bookmarklets to initiate debugger from your favorite browser link.

    4. On the Zend Debugger & Xdebug bookmarklets page that opens, check the debugging engine settings and click Generate. The bookmarks for listed debugging-related actions are generated.

    5. Drag the generated links to the bookmark toolbar in your browser.

  2. Toggle the Start Listen PHP Debug Connections button start listening php debug connections on the PhpStorm toolbar so that it changes to stop listening php debug connections. After that PhpStorm starts listening to the port of the debugging engine used in the current project. Debugging ports are set at the PhpStorm level on the Languages & Frameworks | PHP | Debug page of the Settings/Preferences dialog Ctrl+Alt+S .

  3. Open the starting page of your application in the browser, choose the Start debugger bookmark to activate the debugging engine from the browser, re-load the current page (the starting page of the application), and then return to PhpStorm.

    Establishing a Zero-Configuration debugging session may fail with no breakpoints hit and therefore the script not suspended. This may happen if the path mappings are not configured or configured erroneously, or if you have not set any breakpoints. In the latter case, you can do any of the following:

    • Set a breakpoint by clicking the gutter at the desired executable line of code. See Breakpoints for details.

    • In the Settings/Preferences dialog Ctrl+Alt+S, go to Languages & Frameworks | PHP | Debug and in the External Connections area, select the Break at First Line in PHP Scripts checkbox.

    • Enable the Run | Break at First Line in PHP Scripts option from the main menu.

    To have PhpStorm display a notification if the script is not suspended, select the Notify if debug session was finished without being paused checkbox in the Advanced Settings area on the Languages & Frameworks | PHP | Debug page of the Settings dialog.

  4. In the dialog, that opens, select the incoming connection to profile and click Accept. The Incoming Connection from Zend Debugger dialog appears only once, when you accept connection from this host for the first time.

    PhpStorm presents the collected profiling data in a separate editor tab with the name of the selected profiler output file.

Examine the profiling data

When you request on the accumulated profiling data, PhpStorm opens its visualized presentation in a separate editor tab. The tab is named after the file that implements the page you are currently profiling and consists of several views. Switch between the views to analyze the profiling data based on various criteria of analysis.

  • In the Execution Statistics view, examine the summary information about execution metrics of every called function.

  • In the Call Tree view, explore the execution paths of all called functions.

  • To explore the execution paths of a specific function, select the function in the Call Tree view and view its callees in the Callees view.

  • To explore all the paths that can result in calling a specific function, select the function in the Call Tree view and examine its possible callers in the Callers view.

Last modified: 18 September 2020