opengento/module-webapi-logger

This module allows you to analyze all the webapi rest done call toward your Magento.

4.0.0 2024-07-22 19:52 UTC

Requires

• php: ^8.1
• magento/framework: *
• magento/module-webapi: *
• psr/log: *

Requires (Dev)

• magento/magento-coding-standard: ^5
• magento/marketplace-eqp: ^4.0
• roave/security-advisories: dev-latest

Suggests

• opengento/logger: This module will sets a new Gelf logger handler for Magento2.

MIT

• Danilo Argentiero
• Riccardo Ugolini
• Matthieu Vion
• Opengento Team
• Thomas Klein

• log
• php
• module
• logger
• extension
• free
• webapi
• magento
• magento2

README

This module allows you to analyze all the webapi rest done call toward your Magento.

• Fork
• Setup
  • Composer installation
  • Setup the module
• Features
• Settings
• Documentation
• Support
• Authors
• License

Fork

This is a forked version from the following repository: https://github.com/ghostunicorns/module-webapi-logs.
It also contains changes from the following fork: https://github.com/magentix/module-webapi-logs.

As the original repository does not seems to be maintained anymore, we offer an improved and optimized version here.

Setup

Magento 2 Open Source or Commerce edition is required.

Composer installation

Run the following composer command:

composer require opengento/module-webapi-logger

Setup the module

Run the following magento command:

bin/magento setup:upgrade

If you are in production mode, do not forget to recompile and redeploy the static resources.

Features

Settings

The configuration for this module is available in Stores > Configuration > System > Webapi Logs.

Documentation

Go to Reports > Webapi Logs > Show Logs

You can select an entry to see more details about the request and the response

If you disable the Secret Mode this module will logs everything passes in the webapi calls (tokens and passwords too!), then remember to clean logs by clicking the Delete All Logs button:

It is now possible to log the webapi request and response to filesystem or any handler that follow the PSR Log.
You can register your handlers to Opengento\WebapiLogger\Logger. The module use the debug level to log the request and response.

Support

Raise a new request to the issue tracker.

Authors

• GhostUnicorns - Original Work - www.ghostunicorns.com
• Contributors - Contributor -
• Opengento Community - Maintainer -

License

This project is licensed under the MIT License - see the LICENSE details.

That's all folks!