README

A reusable Laravel package to send alerts via multiple channels (e.g., mail, telegram) based on alert type and channel combinations — stored in the database for easy admin management.

✨ Features

Alert types like System, User (customizable)
Channel support: mail, telegram, discord (more to come)
Dynamically manage recipients from the database
Supports Laravel Notifications and queues
Uses a Facade: Alert::send(...)
Includes an optional dashboard with filters and search
Logs each alert sent per recipient and status

✅ Requirements

Mandatory

Laravel >= 11
PHP >= 8.1
Database migrations

Optional

Tailwind CSS (for UI)
Livewire (for UI)

📷 Screenshots

Mail

Light mode

Dark mode

📦 Installation

composer require fantismic/alert-system

Publish migrations

php artisan vendor:publish --tag=alert-system-migrations
php artisan migrate

Publish configuration:

php artisan vendor:publish --tag=alert-system-config

You can define:

Which Blade layout to use for the Livewire UI

Which environments (envs) are allowed to send alerts

Set telegram token

Set telegram proxy

Set global cooldown

You can set as many telegram bots as you like here, or leave only one and use different addresses to different groups for the same bot.

Publish seeders (optional):

php artisan vendor:publish --tag=alert-system-seeders
php artisan db:seed --class=AlertTypesTableSeeder
php artisan db:seed --class=AlertChannelsTableSeeder

📁 Tables

This package creates the following tables:

alert_types
alert_channels
alert_recipients
alert_logs

Example:

Type	Channel	Address
System	mail	admin@example.com
System	telegram	@sysadmin_channel

🚀 Usage

use Fantismic\AlertSystem\Facades\Alert;

Alert::send('Healthcheck', '🔥 CPU is on fire');

use Fantismic\AlertSystem\Facades\Alert;

Alert::send('System', 'The disk is almost full', [
    'host' => 'web-01',
    'threshold' => '95%',
], [
    'mailSubject' => '🚨 Disk Alert',
    'cooldown' => 0,
]);

This will:

Look up all recipients for the given type
Send via all associated channels (mail, telegram)
Log success/failure per recipient

🧠 Signature

Alert::send(
    string $type,
    string $message,
    array $details = [],
    array $options = [] // mailSubject, cooldown
): void

🛠️ Customization

Email Templates

After publishing the views:

php artisan vendor:publish --tag=alert-system-views

You'll find the default template at:

resources/views/vendor/alert-system/mail/error_alerts/default.blade.php

Use Blade logic to customize per type (e.g., error_alerts.system.blade.php).

🖥️ Admin UI

📍 Routes

Path	Route Name
/admin/alerts/dashboard	alerts.dashboard
/admin/alerts/types	alerts.types
/admin/alerts/channels	alerts.channels
/admin/alerts/recipients	alerts.recipients

Uses web and auth middleware by default.

💡 Features

Create, edit, delete alert types, channels, and recipients
View alert logs in a searchable, filterable table
Filter by status (success/failure), type, channel
View alert detail in a modal
Export alert logs to CSV
Dark mode support

📊 Logs

Each time an alert is sent, a log is created in the alert_logs table.

🧾 Columns

Column	Description
id	Primary key
type	Alert type name
channel	Channel name (mail/telegram)
address	Recipient address
bot	Bot (if applicable)
subject	Subject used
message	Message used
details	JSON-encoded extra details
status	`success` or `failure`
error_message	Error if status is `failure`
sent_at	Timestamp
created_at	Timestamp
updated_at	Timestamp

🧱 Model

You can use the model directly for custom dashboards:

use Fantismic\AlertSystem\Models\AlertLog;

$recent = AlertLog::latest()->take(10)->get();

fantismic / alert-system

Maintainers

Details