Create New CLI command: Collect Magento Information

[vrann]

In order to understand the environment configuration of Magento, administrator should collect information about the settings from the different sources: config files, installed services, Admin UI.

Providing CLI command which will output all basic Magento settings can help to understand the particular deployment situation faster and better. CLI command can provide following information:

• Information about Magento version
• number of core business entities
• info on the configuration of the caches, queues, etc
• number of web nodes and db nodes

[adragus-inviqa]

Why would the app know - or care - about the number of web nodes available? Ditto for caches and queues. Is this some sort of command that prints helpful information for support? Is that the intention?

[convenient]

This sounds very much like the good old backup.sh bash script i've received a few times from support@magento.com. It's never proved very useful as it made many assumptions of how magento was organised on the file system.

Is this the same intended use case?

[vrann]

@adragus-inviqa @convenient The intent of this command is to provide the most informative information to the DevOps about the current setup so that he can grasp fast the circumstances in which platform is running. We can discuss more on what makes sense as an output for this tool. As a good example of such functionality I can give docker infoand docker inspect

[convenient]

@vrann I get it, I think this will be a difficult task for getting settings and stuff as a CLI command may only provide info on the CLI php settings, and may not be able to get nginx or apache or varnish configuration for example?

Or am I missing something? (I'm still jet lagged from Imagine so possible)

[adragus-inviqa]

docker info only gives you information that docker knows. Sure, such a command could be useful, but you can't really expect M2 to know about its pipeline. But anything in env.php or from phpinfo() or various core_config data? Sure.

[nshiff]

For what it's worth, n98-magerun2 implements a portion of this functionality.

[nshiff@mage2 dev_m]$ ./n98-magerun2.phar sys:info

                              
  Magento System Information  
                              

+------------------+------------------------------------------------------------------------------+
| name             | value                                                                        |
+------------------+------------------------------------------------------------------------------+
| Name             | Magento                                                                      |
| Version          | 2.1.4                                                                        |
| Edition          | Community                                                                    |
| Application Mode | developer                                                                    |
| Session          | files                                                                        |
| Crypt Key        | x                                             |
| Install Date     | Wed, 22 Feb 2017 15:06:05 +0000                                              |
| Cache Backend    | Cm_Cache_Backend_File                                                        |
| Vendors          | Magento, Amasty, HE, Yotpo, IWD, Knowband, LiveChat, MagePal, Astound, Yireo |
| Attribute Count  | 167                                                                          |
| Customer Count   | 495                                                                          |
| Category Count   | 44                                                                           |
| Product Count    | 933                                                                          |
+------------------+------------------------------------------------------------------------------+