General custom module troubleshooting help

This article talks about general tools to help in troubleshooting custom modules in Adobe Commerce.

Issue

If you realize there is an issue with the features from your custom module, and you get no obvious error messages that state the issue, then you will want to consult your instance's logs.

Solution

Check the logs to see if there are entries with custom module's name in the error. Depending on the errors involved, the solution may present itself, or you may need to include your helpful Adobe Commerce log information if you want to open a Support Ticket. See the following paragraphs for the info about logs' location and possible solutions.

Adobe Commerce (all deployment methods), Magento Open Source, all 2.X versions

1. Logs locations:
   • Adobe Commerce on cloud infrastructure Starter plan architecture logs in our support knowledge base.
   • Adobe Commerce on cloud infrastructure Pro plan architecture logs in our support knowledge base.
2. Depending on the errors you find, if you want to enable, disable, or uninstall a custom module, these articles detail those actions:
   • Enable or disable modules in our developer documentation.
   • Uninstall modules in our developer documentation.

Adobe Commerce on cloud infrastructure, all versions

1. Logs locations: Adobe Commerce on cloud infrastructure logs in our developer documentation.
2. Depending on the errors you find, if you want to enable, disable, or uninstall a custom module, these articles in our developer documentation detail those actions:
   • Install, manage, and upgrade extensions.
   • Component deployment failure.

Related reading

In our developer documentation:

• Module overview
• Errors installing optional sample data
• Exception handling
• Exceptions during installation
• Run the Module Manager
• Module configuration files
• Out of memory errors