Weave Code
At a glance
Frequently asked questions about Arkhe Watcher
- How does Arkhè Watcher differ from Laravel Telescope or Pulse?
- Arkhè Watcher is a lightweight, in-app monitoring solution that integrates directly with Arkhè Main’s admin panel, eliminating the need for separate applications or servers. Unlike Telescope or Pulse, it doesn’t require additional infrastructure like queue workers or WebSocket servers. It’s designed for simplicity and tight Laravel ecosystem integration, particularly for teams already using Arkhè Main.
- Can I use Arkhè Watcher without Arkhè Main?
- No, Arkhè Watcher is tightly coupled with Arkhè Main (version 3.2+) and relies on its navigation system, middleware, and UI components. Attempting to use it without Arkhè Main would require significant customization, which isn’t officially supported. It’s best suited for Laravel apps already leveraging Arkhè’s admin panel.
- What Laravel versions and PHP requirements does Arkhè Watcher support?
- Arkhè Watcher requires PHP 8.3+ and is designed for Laravel applications using Arkhè Main 3.2 or higher. It leverages Livewire 4 and Flux 2, which are already included in Arkhè Main. Ensure your Laravel version is compatible with Arkhè Main’s requirements for smooth integration.
- How do I install and configure Arkhè Watcher?
- Installation is straightforward: run `composer require adhocrat-io/arkhe-watcher` followed by `php artisan arkhe:watcher:install`. This publishes the config file, runs migrations to create the `watcher_entries` table, and sets up the UI. Configuration is done via `config/watcher.php`, where you can enable/disable telemetry types (e.g., requests, exceptions, jobs) and set retention policies.
- Does Arkhè Watcher support filtering or sampling of telemetry data?
- The current documentation doesn’t explicitly mention built-in filtering or sampling mechanisms like excluding specific routes (e.g., `/api/*`). However, you can configure retention policies via `config/watcher.php` to manage data volume. For advanced filtering, you may need to extend the package or query the `watcher_entries` table directly in your application logic.
- How does Arkhè Watcher handle performance overhead in high-traffic applications?
- Arkhè Watcher is designed for low overhead, storing telemetry in a single `watcher_entries` table without requiring external services. However, it may introduce latency during peak traffic, especially if tracking high-volume operations like requests or jobs. There’s no clear mention of async processing or sampling in the current documentation, so monitor database write load during testing.
- Can I customize the Flux UI dashboard to match my app’s styling?
- Yes, Arkhè Watcher uses Flux 2 and Livewire 4, which integrate with your existing Tailwind CSS setup. The installer adds an `@source` directive to `resources/css/app.css` to ensure Tailwind scans the package’s Blade views. If styling mismatches occur, override the Flux/Livewire components in `resources/views/vendor/arkhe-watcher` or extend your Tailwind config.
- Is it possible to export Arkhè Watcher data to third-party services like Sentry or Datadog?
- The package stores telemetry in a single `watcher_entries` table, which could theoretically be queried or exported to third-party services. However, there’s no built-in integration for Sentry, Datadog, or other APMs. You’d need to write custom logic to ingest data from this table or extend the package’s functionality.
- How does Arkhè Watcher handle sensitive data in exceptions or request payloads?
- Arkhè Watcher sanitizes sensitive data before storage to prevent information leakage, though the exact sanitization rules aren’t detailed in the documentation. For critical applications, review the `watcher_entries` table structure and consider additional sanitization logic in your application code. The Flux UI also inherits Arkhè Main’s permission model, restricting access to authorized users only.
- What are the alternatives to Arkhè Watcher for Laravel monitoring?
- Alternatives include Laravel Telescope (for standalone monitoring), Laraowl (which requires a separate server), and third-party APMs like Sentry or Datadog. If you’re not using Arkhè Main, packages like Laravel Debugbar or custom solutions with tools like Monolog may be more flexible. Arkhè Watcher stands out for its zero-overhead, in-app approach and seamless integration with Arkhè’s admin panel.
Weaver
How can I help you explore Laravel packages today?