Extend description of debugging CLI command on Pro Staging and Production

[NadiyaS]

Purpose of this pull request

Update instructions for using Xdebug to debug Magento CLI commands. Add information about specifying the Xdebug configuration file when debugging on Pro Production and Staging environments.

Affected DevDocs pages

• https://devdocs.magento.com/cloud/howtos/debug.html#debugcli

whatsnew
Updated Xdebug instructions for debugging CLI commands on Magento Cloud Pro Production and Staging environments to specify the required Xdebug php configuration file (php.xdebug.ini) when debugging commands.

[devops-devdocs]

An admin must run tests on this PR before it can be merged.

[meker12]

Instead of creating a separate section, I think it's better to include the information inline in the existing section. However, the instructions in that section were a bit disjointed which makes it hard to integrate new content. I suggest replacing the entire section, starting at line 301 with the content below the ----. If the suggested revision introduced any technical errors or confusion, let's discuss.

---

Debug CLI commands {#debugcli}

When you debug CLI commands, you must configure environment variables to enable Xdebug. These variables are removed when the SSH session ends. If you expect to debug over multiple SSH sessions, add the export commands for the variable configuration to a bash script in the /tmp directory to run each time you start a session.

{:.procedure}
To enable Xdebug for debugging CLI commands:

1. SSH to the environment you want to debug.

2. Configure environment variables:

   export XDEBUG_CONFIG='PHPSTORM'

   export PHP_IDE_CONFIG="serverName=<name of the server that is configured in PHPSTORM>"

   Optionally, add Xdebug runtime options to the environment variable configuration.

   php -d xdebug.profiler_enable=On -d xdebug.max_nesting_level=9999 ...

3. Begin debugging.

   On Starter environments and Pro Integration environments, run the CLI command to debug, for example:

   php bin/magento cache:clean

   On Pro Staging and Production environments, you must specify the path to the Xdebug php configuration file when debugging CLI commands, for example:

   php -c /etc/platform/USERNAME/php.xdebug.ini bin/magento cache:clean

[meker12]

Looks like lines 325 - 336 are indented one space too far.

[NadiyaS]

you are right. There were 4 spaces instead of 3. Fixed

[shrielenee]

@NadiyaS It looks like the linting test failed because there is a listing error:

Run mdl --style=_checks/styles/style-rules-prod --ignore-front-matter --git-recurse -- .
src/cloud/howtos/debug.md:319: MD009 Trailing spaces

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
##[error]Process completed with exit code 1.

[shrielenee]

@NadiyaS Please fix (ask if you have any questions!) and we'll merge. Thanks!

[meker12]

Still waiting for technical review on this one from @arhiopterecs before it can be merged. Thx.

[arhiopterecs]

I think that it’s enough to indicate that the variables are related to the session.
I propose to remove this:
"If you expect to use SSH and debug multiple times, you can put the export commands into a bash script in the /tmp directory to run them each time."

[NadiyaS]

removed

[meker12]

running tests

[ghost]

Hi @NadiyaS, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.