ogeagleeye / monitor-laravel
OGEagleEye monitoring SDK for Laravel 9–13
Package info
github.com/muazzambaaboo/ogeagleeye-monitor-laravel
pkg:composer/ogeagleeye/monitor-laravel
Requires
- php: >=8.0
- illuminate/console: ^9.0|^10.0|^11.0|^12.0|^13.0
- illuminate/contracts: ^9.0|^10.0|^11.0|^12.0|^13.0
- illuminate/http: ^9.0|^10.0|^11.0|^12.0|^13.0
- illuminate/support: ^9.0|^10.0|^11.0|^12.0|^13.0
- ogeagleeye/monitor-php: ^1.0
Requires (Dev)
- orchestra/testbench: ^8.0|^9.0|^10.0|^11.0
- pestphp/pest: ^2.0|^3.0|^4.0
- pestphp/pest-plugin-laravel: ^2.0|^3.0|^4.0
This package is not auto-updated.
Last update: 2026-08-14 11:29:24 UTC
README
Laravel SDK for OGEagleEye (Laravel 9–13). Ask your system admin for:
- Ingest key (
oge_…) - Events endpoint (e.g.
https://your-host/api/v1/events)
Requirements
- PHP 8.0+
- Laravel 9–13
Install
Prefer the 1.x line (1.0.1+). Tag 0.3.0 is superseded — use ^1.0 so Composer resolves the log-capture release.
composer require ogeagleeye/monitor-laravel:^1.0 php artisan vendor:publish --tag=OGEagleEye-config
ogeagleeye/monitor-php is installed automatically as a dependency.
Setup
- Get the ingest key and endpoint from your system admin.
- Add to
.env:
OGEAGLEEYE_KEY=oge_YOUR_KEY_FROM_ADMIN OGEAGLEEYE_ENDPOINT=https://your-host/api/v1/events OGEAGLEEYE_ENABLED=true
Optional:
OGEAGLEEYE_ENVIRONMENT=production OGEAGLEEYE_RELEASE=1.0.0
The service provider is auto-discovered. After env is set, exceptions, HTTP failures, and Laravel Log::info / Log::error (and other levels at or above OGEAGLEEYE_LOG_LEVEL, default info) are reported automatically — no extra code required.
Optional log controls:
OGEAGLEEYE_CAPTURE_LOGS=true OGEAGLEEYE_LOG_LEVEL=info
Heartbeat
Heartbeats are opt-in. Error/event reporting does not send them. Until this app sends heartbeats, the OGEagleEye panel shows Heartbeat: none.
Enable auto-scheduling in .env:
OGEAGLEEYE_HEARTBEAT_AUTO=true # optional: OGEAGLEEYE_HEARTBEAT_CRON=* * * * *
Ensure this app’s Laravel scheduler cron is running:
* * * * * cd /path/to/this-app && php artisan schedule:run >> /dev/null 2>&1
Or send one manually:
php artisan ogeagleeye:heartbeat
Scanning
Scans run on this app’s server (not on the OGEagleEye platform). The SDK checks local files, then POSTs a scan_result to your endpoint. The platform stores Scan reports and can alert on critical findings.
This is an integrity + PHP heuristics helper — not an antivirus.
php artisan ogeagleeye:scan php artisan ogeagleeye:scan app public --reset-baseline php artisan ogeagleeye:scan --no-heuristics
Schedule on this project’s host (in routes/console.php):
$schedule->command('ogeagleeye:scan')->dailyAt('02:15');
Ensure Laravel’s scheduler cron is installed so the command actually runs. More detail: docs/scanning.md.