Weave Code
Monitoring Laravel Package
becklyn/monitoring
Integrates monitoring features for Becklyn apps: injects an uptime-monitor HTML comment with your project name, optionally embeds TrackJS via Twig, and registers a @monitoring namespace for the Becklyn assets bundle.
Our integration into our monitoring services
Frequently asked questions about Monitoring
- Does this package work with Laravel 10.x and PHP 8.2+?
- No, the package was last updated in 2018 and may not support modern Laravel/PHP versions. Testing in a staging environment is critical. You may need to fork or patch dependencies like Symfony components for compatibility.
- How do I install and configure the package?
- Run `composer require becklyn/monitoring` and publish the config with `php artisan vendor:publish --tag=monitoring-config`. Set `project_name` and optionally `trackjs` token in `config/monitoring.php`. No further setup is needed for basic IP scrubbing.
- Will this break if I use Laravel Mix/Vite instead of Laravel’s default asset pipeline?
- Yes, the `@monitoring` asset namespace relies on Laravel’s asset system. For Vite or custom pipelines, you’ll need to manually include the JS or adjust the asset compilation process to recognize the namespace.
- Is the IP scrubbing GDPR/CCPA compliant?
- The package scrubs IPs (e.g., 192.168.1.*) by default, which helps with compliance, but it may not cover all edge cases like IPv6 or proxied requests. For stricter requirements, consider supplementing with Laravel’s `Log::maskPii()` or a dedicated PII redaction tool.
- Can I use this with Sentry or another error monitoring tool instead of TrackJS?
- No, the package hardcodes TrackJS integration via Twig’s `monitoring_embed()`. To use Sentry or Rollbar, you’d need to fork the package or manually include their scripts in your Twig templates.
- How reliable is the HTML uptime monitor comment for tracking?
- The `<!-- uptime monitor -->` comment is a passive method and works well for basic uptime checks, but it’s not foolproof. False negatives can occur if HTML responses are minified or modified post-generation. For critical monitoring, pair it with a dedicated uptime service.
- Are there security risks using this package?
- Yes, due to its archived status, dependencies like Symfony may have unpatched vulnerabilities. Audit dependencies with `composer why-not` and consider isolating the package in a non-production environment until compatibility is confirmed.
- Does the package support structured logging (e.g., JSON) or only plaintext?
- The IP scrubbing works with plaintext logs by default. For structured logging (e.g., JSON), you’ll need to manually integrate it with Laravel’s logging channels or extend the package to support `Log::structured()`.
- What are modern alternatives to this package?
- For IP scrubbing, use Laravel’s built-in `Log::maskPii()` or packages like `spatie/laravel-logging`. For error monitoring, consider Sentry, Rollbar, or Laravel’s Telescope. For uptime checks, dedicated services like Pingdom or UptimeRobot are more reliable.
- How do I fork and maintain this package if needed?
- Fork the repository on GitHub, update dependencies (e.g., Symfony, PHP) to match your Laravel version, and test thoroughly. Replace TrackJS with a configurable error monitoring script in the Twig template. Document changes for your team.
Weaver
How can I help you explore Laravel packages today?