avenyra / module-graph-ql-logger
A utility module to enable GraphQl request logs for Magento 2.
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Type:magento2-module
pkg:composer/avenyra/module-graph-ql-logger
Requires
- php: ^8.1 || ^8.2 || ^8.3
- avenyra/module-base: 1.0.*
- magento/framework: ^103.0
- magento/module-graph-ql: ^100.4
README
Avenyra GraphQL Logger is a utility module for Magento 2 that logs incoming GraphQL requests. It is built for debugging headless storefronts, mobile apps, and third-party integrations without turning your logs into a liability.
Features
-
Logs GraphQL request metadata
- Query
- Variables
- Request URL
-
Configurable redaction of sensitive data
- Variable keys
- Query literal values
-
Optional cached GET logging (disabled by default)
-
Authorization-based filtering
- Log only requests whose
Authorizationheader matches configured tokens - Optional force log to capture those requests even when global logging is disabled
- Log only requests whose
-
Lightweight and non-invasive
- Hooks into Magento’s GraphQL logger pool
- Writes to a dedicated log file under
var/log
Requirements
- PHP 8.1+
- Magento 2.4.5+
Installation
Via Composer (Recommended)
composer require avenyra/module-graph-ql-logger php bin/magento module:enable Avenyra_GraphQlLogger php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento setup:static-content:deploy php bin/magento cache:flush
Log location
Logs are written to var/log/graphql_queries.log by default (relative to Magento BP).
Security and privacy
The module attempts to minimize sensitive data in logs:
- Variables array is sanitized using the configurable redaction list (redacted values are replaced with
***REDACTED***).
Performance
- Logging all GraphQL requests can generate heavy I/O on busy sites. Keep cached logging off unless needed.
Notes
This logger is intended as a developer and operations tool. If you enable logging in production, ensure you have a data retention and access policy that meets your compliance requirements (PCI, GDPR, etc.).
Support
Found a bug or issue? Please open an issue on GitHub.
Author
Avenyra Solutions