Installation

Follow these steps to install and configure the Laritor client in your Laravel application.

✅ Step 1: Install the Package

Run the following command to add the Laritor client to your project:

composer require binarybuilds/laritor-client

🔐 Step 2: Configure Environment Variables

Add the following variables to your .env file:

LARITOR_ENABLED=true
LARITOR_INGEST_ENDPOINT=your-ingest-url
LARITOR_BACKEND_KEY=your-backend-key

Replace your-ingest-url and your-backend-key with the values provided in your Laritor dashboard during setup.

🔄 Step 3: Sync After Deployment

Run the Laritor sync command after every deployment. This ensures scheduled tasks, database schema changes, custom health checks, and server metadata are up to date in Laritor.

php artisan laritor:sync

💡 You can automate this by adding it to your post-deploy hook or CI/CD pipeline.

📈 Step 4 (Optional): Collect Server Metrics

To monitor CPU, memory, and disk usage, schedule the following command to run every minute via Laravel Scheduler or your system cron:

php artisan laritor:send-metrics

🚀 That’s It!

Once you’ve completed the steps above, your Laravel application will start sending events to Laritor.

You can now:

• View incoming events in your Laritor dashboard
• Customize what data gets tracked using filters and environment settings
• Set up alerts, dashboards, and more!

👉 Next: Customization & Filtering →