PHPackages                             hryvinskyi/magento2-error-reporting - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Logging & Monitoring](/categories/logging)
4. /
5. hryvinskyi/magento2-error-reporting

ActiveMagento2-module[Logging & Monitoring](/categories/logging)

hryvinskyi/magento2-error-reporting
===================================

Advanced error notification system for Magento 2 with spam prevention, and comprehensive error tracking.

1.0.7(3mo ago)31861MITPHPPHP ^8.1

Since Nov 5Pushed 3mo agoCompare

[ Source](https://github.com/hryvinskyi/magento2-error-reporting)[ Packagist](https://packagist.org/packages/hryvinskyi/magento2-error-reporting)[ RSS](/packages/hryvinskyi-magento2-error-reporting/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (6)Versions (9)Used By (0)

Magento 2/Adobe Commerce - Error Email Notification Module
==========================================================

[](#magento-2adobe-commerce---error-email-notification-module)

Advanced error notification system for Magento 2/Adobe Commerce, multiple notification channels, and comprehensive error tracking.

[![Latest Stable Version](https://camo.githubusercontent.com/161afbb5f6902e094590831a6a023a07865779fc78d695a82097163b74db5109/68747470733a2f2f706f7365722e707567782e6f72672f68727976696e736b79692f6d6167656e746f322d6572726f722d7265706f7274696e672f762f737461626c65)](https://packagist.org/packages/hryvinskyi/magento2-error-reporting)[![Total Downloads](https://camo.githubusercontent.com/153dae71bde9f4bb41c9af81b6bbcaaa5329f4b4d875b4c9e2d8ccd3a11ce3ec/68747470733a2f2f706f7365722e707567782e6f72672f68727976696e736b79692f6d6167656e746f322d6572726f722d7265706f7274696e672f646f776e6c6f616473)](https://packagist.org/packages/hryvinskyi/magento2-error-reporting)[![PayPal donate button](https://camo.githubusercontent.com/0d6e4d8b50b5983a58205941b1a581b1305903393b7a39da574e3f60af3c7f5b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70617970616c2d646f6e6174652d79656c6c6f772e737667)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=volodymyr%40hryvinskyi%2ecom&lc=UA&item_name=Magento%202%20Error%20Email%20Notification%20Module&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted "Donate once-off to this project using Paypal")[![Latest Unstable Version](https://camo.githubusercontent.com/0707e064634ae91efd6aa248cad6be2d5b33e49613c9010dfe98df45bdcddaf9/68747470733a2f2f706f7365722e707567782e6f72672f68727976696e736b79692f6d6167656e746f322d6572726f722d7265706f7274696e672f762f756e737461626c65)](https://packagist.org/packages/hryvinskyi/magento2-error-reporting)[![License](https://camo.githubusercontent.com/712f74cad1b35f54636abad24e4256166d4f6adff558d4e8b1257c76417daec9/68747470733a2f2f706f7365722e707567782e6f72672f68727976696e736b79692f6d6167656e746f322d6572726f722d7265706f7274696e672f6c6963656e7365)](https://packagist.org/packages/hryvinskyi/magento2-error-reporting)

Table of Contents
-----------------

[](#table-of-contents)

- [Features](#features)
- [Installation](#installation)
- [Configuration](#configuration)
    - [General Settings](#general-settings)
    - [Error Filtering](#error-filtering)
    - [Spam Prevention / Throttling](#spam-prevention--throttling)
    - [Error Details](#error-details)
    - [Email Notifications](#email-notifications)
    - [Slack Notifications](#slack-notifications)
    - [Microsoft Teams Notifications](#microsoft-teams-notifications)
    - [Telegram Notifications](#telegram-notifications)
    - [WhatsApp Notifications](#whatsapp-notifications)
- [Error Information Captured](#error-information-captured)
    - [For Developers (Detailed Email)](#for-developers-detailed-email)
    - [For Clients (Simplified Email)](#for-clients-simplified-email)
- [Notification Channels](#notification-channels)
- [Author](#author)
- [Support](#support)

Features
--------

[](#features)

### Core Features

[](#core-features)

- **Dual Email System** - Separate detailed emails for developers and simplified emails for clients
- **Multiple Notification Channels** - Email, Slack, Microsoft Teams, Telegram, and WhatsApp support
- **Smart Spam Prevention** - Configurable throttling to prevent notification flooding
- **Configurable Blacklist** - Filter out specific errors using patterns or regex
- **Controller Filtering** - Exclude or include specific controllers for error reporting
- **Severity Levels** - Critical, Error, and Warning levels with configurable minimum threshold per channel
- **Comprehensive Error Data** - Captures exception details, stack traces, request info, user context, post data, and server environment
- **Sensitive Data Protection** - Automatically redacts passwords, credit cards, and other sensitive data
- **Zero External Dependencies** - Works even when database, Redis, or other services are down to ensure error reporting is reliable

Installation
------------

[](#installation)

### Composer (recommended)

[](#composer-recommended)

```
composer require hryvinskyi/magento2-error-reporting
bin/magento module:enable Hryvinskyi_ErrorReporting
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
```

### Manual Installation

[](#manual-installation)

1. Download the module and upload it to `app/code/Hryvinskyi/ErrorReporting`
2. Enable the module and update the database:

```
bin/magento module:enable Hryvinskyi_ErrorReporting
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
```

Configuration
-------------

[](#configuration)

Navigate to `Stores > Configuration > Advanced > Error Reporting` to configure the module settings:

**Demo Image**[![General Configuration](docs/images/configuration.jpg)](docs/images/configuration.jpg)

### General Settings

[](#general-settings)

**Enable Error Reporting**

- Enable or disable automatic error notifications
- When disabled, no errors will be reported through any channel

### Error Filtering

[](#error-filtering)

**Error Blacklist**

- One pattern per line
- Errors matching these patterns will not trigger notifications
- Supports plain text matching (case-insensitive) and regex patterns (wrap in delimiters like /pattern/)
- Lines starting with # or // are treated as comments
- Examples:
    - `NoSuchEntityException`
    - `/vendor\/magento\/module-customer\//i`
    - `Connection refused`

**Exclude Controllers**

- Controller paths to exclude from error reporting
- One per line
- Supports exact paths (e.g. "adminhtml/system\_config/save"), action names (e.g. "catalog\_product\_view"), or regex patterns (e.g. "/^adminhtml/customer/.\*/i")

**Include Only These Controllers**

- Only report errors for these controller paths
- One per line
- Accepts exact paths, action names, or regex patterns
- Leave empty to include all controllers

### Spam Prevention / Throttling

[](#spam-prevention--throttling)

**Throttle Period (Minutes)**

- Minimum time between notifications for the same error
- Value in minutes
- Must be greater than zero

**Max Notifications Per Period**

- Maximum number of notifications to send for the same error within the throttle period
- Must be greater than zero

### Error Details

[](#error-details)

**Include Detailed Information**

- Include stack trace, environment info, and previous exceptions in developer emails

**Include POST Data**

- Include POST request data in error reports
- Sensitive fields are automatically redacted (passwords, credit cards, etc.)

### Email Notifications

[](#email-notifications)

**Demo Image Developer email**[![Developer Email Example](docs/images/developer_email.jpg)](docs/images/developer_email.jpg)

**Demo Image Client email**[![Client Email Example](docs/images/client_email.jpg)](docs/images/client_email.jpg)

**Enable Email Notifications**

- Send error notifications via email

**Minimum Severity Level**

- Only send email notifications for errors at or above this severity level
- Options: Critical, Error, Warning

**Developer Email Addresses**

- Comma-separated list of developer email addresses
- Receives detailed error reports with full stack traces and technical information

**Enable Client Notifications**

- Send simplified notifications to client contacts

**Client Email Addresses**

- Comma-separated list of client email addresses
- Receives simplified error notifications without technical details

**Email Sender**

- Email identity to use as sender
- Select from configured email identities

### Slack Notifications

[](#slack-notifications)

**Demo Image**[![Slack Configuration](docs/images/slack.jpg)](docs/images/slack.jpg)

Send error notifications to Slack channels via incoming webhooks.

**Enable Slack Notifications**

- Send error notifications to Slack

**Minimum Severity**

- Only send notifications for errors at or above this severity level
- Options: Critical, Error, Warning

**Webhook URL** (required)

- Your Slack incoming webhook URL
- Format: `https://hooks.slack.com/services/XXX/YYY/ZZZ`
- Get your webhook URL: Workspace Settings > Apps > Incoming Webhooks > Add to Channel

**Channel Override** (optional)

- Override default channel
- Format: `#errors` or `@username`
- Leave empty to use webhook default

**Bot Username**

- Display name for the bot in Slack

### Telegram Notifications

[](#telegram-notifications)

**Demo Image**[![Telegram Configuration](docs/images/telegram.jpg)](docs/images/telegram.jpg)

Send error notifications to Telegram channels or chats via Telegram Bot API.

**Enable Telegram Notifications**

- Send error notifications to Telegram

**Minimum Severity**

- Only send notifications for errors at or above this severity level
- Options: Critical, Error, Warning

**Bot Token** (required)

- Your Telegram bot token from [@BotFather](https://t.me/botfather)
- Format: `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`
- Create a bot with @BotFather to get your token

**Chat ID** (required)

- The chat ID or channel username where messages will be sent
- Format: `-1001234567890` for channels, or `@channelname`
- To get chat ID:
    1. Add the bot to your chat
    2. Send a message
    3. Use getUpdates method: `https://api.telegram.org/bot/getUpdates`

### Microsoft Teams Notifications

[](#microsoft-teams-notifications)

**Status: ⚠️ NOT TESTED**

Send error notifications to Microsoft Teams channels via incoming webhooks.

**Enable Teams Notifications**

- Send error notifications to Microsoft Teams

**Minimum Severity**

- Only send notifications for errors at or above this severity level
- Options: Critical, Error, Warning

**Webhook URL** (required)

- Your Microsoft Teams incoming webhook URL
- Format: `https://outlook.office.com/webhook/...`
- Get your webhook URL: Channel Menu > Connectors > Incoming Webhook > Configure

### WhatsApp Notifications

[](#whatsapp-notifications)

**Status: ⚠️ NOT TESTED**

Send error notifications to WhatsApp via WhatsApp Business Cloud API.

**Enable WhatsApp Notifications**

- Send error notifications to WhatsApp

**Minimum Severity**

- Only send notifications for errors at or above this severity level
- Options: Critical, Error, Warning

**Access Token** (required)

- Your WhatsApp Business Account access token from Facebook Developer Portal
- Generate it in [Meta for Developers](https://developers.facebook.com/apps) dashboard
- Location: Your app > WhatsApp > API Setup section

**Phone Number ID** (required)

- Your WhatsApp Business Phone Number ID (not the phone number itself)
- Find this in the WhatsApp > API Setup section of your app
- Must be numeric digits only

**Recipient Phone Number** (required)

- The phone number to receive error notifications
- International format without + or spaces (e.g., `1234567890`)
- Must be registered with WhatsApp

**Getting Started:**

- Visit [WhatsApp Cloud API Documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/get-started)
- Requires: Facebook Business Account, WhatsApp Business Account, and Cloud API access

Error Information Captured
--------------------------

[](#error-information-captured)

### For Developers (Detailed Email)

[](#for-developers-detailed-email)

Comprehensive technical information for debugging:

- Exception type, message, file, and line number
- Full stack trace
- Previous exceptions chain
- Request details (URL, method, headers, POST data)
- Client information (IP address, user agent, referer)
- User context (guest, customer, or admin with details)
- Store context (store name, code, URL)
- Server environment (PHP version, memory usage, peak memory)

### For Clients (Simplified Email)

[](#for-clients-simplified-email)

Non-technical error notification for stakeholders:

- General error notification
- Timestamp and location
- Reassurance that the issue is being addressed
- Clean, non-technical presentation
- No stack traces or technical details

Notification Channels
---------------------

[](#notification-channels)

The module supports multiple notification channels, each with independent configuration:

### Channel Configuration Examples

[](#channel-configuration-examples)

#### Slack Setup (Recommended)

[](#slack-setup-recommended)

1. Go to your Slack workspace
2. Navigate to: Workspace Settings > Apps > Incoming Webhooks
3. Click "Add to Channel"
4. Copy the webhook URL
5. Paste into Magento configuration

#### Telegram Setup

[](#telegram-setup)

1. Create a bot with [@BotFather](https://t.me/botfather)
2. Get your bot token
3. Add the bot to your channel/chat
4. Get the chat ID using `getUpdates` API
5. Configure in Magento

#### Microsoft Teams Setup

[](#microsoft-teams-setup)

**⚠️ Status: NOT TESTED - Use at your own risk**

1. Open your Teams channel
2. Click on channel menu (three dots)
3. Select Connectors > Incoming Webhook
4. Click Configure
5. Copy the webhook URL
6. Paste into Magento configuration

#### WhatsApp Setup

[](#whatsapp-setup)

**⚠️ Status: NOT TESTED - Use at your own risk**

1. Create a Facebook Business Account
2. Set up WhatsApp Business Account
3. Get access to WhatsApp Cloud API
4. Generate access token from Meta for Developers
5. Get Phone Number ID from API Setup
6. Configure in Magento

Author
------

[](#author)

**Volodymyr Hryvinskyi**

- Email:
- GitHub:

Support
-------

[](#support)

For issues, feature requests, or questions, please contact the author or submit an issue on GitHub.

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance80

Actively maintained with recent releases

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~11 days

Recently: every ~20 days

Total

8

Last Release

106d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e254b6c28f67e639b2beb3f21a80f2b4ff9efc5ee782943d497b73523f630c1d?d=identicon)[hryvinskyi](/maintainers/hryvinskyi)

---

Top Contributors

[![hryvinskyi](https://avatars.githubusercontent.com/u/9294098?v=4)](https://github.com/hryvinskyi "hryvinskyi (20 commits)")

### Embed Badge

![Health badge](/badges/hryvinskyi-magento2-error-reporting/health.svg)

```
[![Health](https://phpackages.com/badges/hryvinskyi-magento2-error-reporting/health.svg)](https://phpackages.com/packages/hryvinskyi-magento2-error-reporting)
```

###  Alternatives

[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8044.5M33](/packages/smile-elasticsuite)[dotdigital/dotdigital-magento2-extension

Dotdigital for Magento 2

50374.2k18](/packages/dotdigital-dotdigital-magento2-extension)[swissup/module-search-mysql-legacy

Legacy mysql search for magento 2.4

10483.0k](/packages/swissup-module-search-mysql-legacy)[mage-os/module-admin-activity-log

The Admin Activity extension makes it easy to track all admin activity with comprehensive audit logging.

261.4k](/packages/mage-os-module-admin-activity-log)[fredden/magento2-module-javascript-error-reporting

A Magento 2 module which captures JavaScript errors for later review by website administrators

3138.1k](/packages/fredden-magento2-module-javascript-error-reporting)[mage-os/module-inventory-reservations-grid

Add a grid with the list of inventory reservations.

126.8k](/packages/mage-os-module-inventory-reservations-grid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)