Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 38 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,65 +2,65 @@ Laritor Client Package
------------------------------------------------
![Laritor Image](/art/laritor-og.png "Laritor Image")

[Laritor](https://laritor.com) is a full-stack observability platform built for Laravel.
[Laritor](https://laritor.com) is a full-stack observability platform for Laravel applications.

It gives you everything you need to understand what’s happening inside your application. From slow requests and
database queries to failed jobs, exceptions, and server resource usage.
This is a client package for sending application telemetry to Laritor.

### ❤️ Why Developers Love Laritor
## Requirements
- PHP: `^7.4 | ^8.0 | ^8.1 | ^8.2 | ^8.3 | ^8.4 | ^8.5`
- Laravel: `^9 | ^10 | ^11 | ^12`

- **Find performance bottlenecks in seconds:** See exactly which queries, cache calls, or external requests are slowing your app.
- **Debug errors with full context:**. Every exception is captured with a complete request timeline, logs, database queries, and related events.
- **Monitor servers like a pro:** Track CPU, memory, and disk usage alongside your Laravel metrics — no extra server monitoring tool needed.
- **Stay ahead of production issues:** Get instant alerts for slow requests, failed jobs, unhealthy servers, or custom health checks.
- **Reduce time-to-fix dramatically:** No more guessing — pinpoint the problem and deploy a fix faster.

### 📄 Documentation
Full setup instructions, customization options, and API details are available at:

👉 [Laritor's Documentation](https://laritor.com/docs)

### 🚀 QuickStart

##### Step 1: Install the Package
## Installation
```
composer require binarybuilds/laritor-client
```
##### Step 2: Configure Environment Variables
Add the following variables to your .env file.

## Configuration
Add the following to your `.env`:
```
LARITOR_ENABLED=true
LARITOR_INGEST_ENDPOINT=your-ingest-endpoint
LARITOR_BACKEND_KEY=laritor-key
```
##### Step 3: Sync After Each Deployment

Run this command after every deployment to sync scheduled tasks, database schema changes,
custom health checks, and server updates with Laritor.
Add it to the end of your deployment scripts.
Environment variables:
- `LARITOR_ENABLED`: Enable/disable the client.
- `LARITOR_INGEST_ENDPOINT`: Laritor ingest URL for your account.
- `LARITOR_BACKEND_KEY`: Backend key for authentication.

## Usage
Sync after each deployment to push scheduled tasks, schema changes, and health checks.
```
php artisan laritor:sync
```
##### Step 4: (Optional) Collect Server Metrics
To collect server metrics such as CPU, memory, and disk usage, schedule this command to run every minute.

Optional: collect server metrics (CPU, memory, disk) by scheduling this every minute.
```
php artisan laritor:send-metrics
```

### ⚙️ Customization
You can customize and control the data shared with Laritor.
See the [customization guide](https://laritor.com/docs/customization) for details.
## Documentation
Setup details, configuration options, and API references:
- [Laritor Documentation](https://laritor.com/docs)

## 🔐 Security Vulnerabilities

If you discover a security vulnerability in this package, do not use the public issue tracker or disclose it publicly.
Please refer to our [Security Policy](https://github.com/binarybuilds/laritor-client/security/policy).
## Development
Run tests:
```
composer test
```

## 💬 Support
📧 Email: [support@laritor.com](mailto:support@laritor.com)
Static analysis:
```
vendor/bin/phpstan
```

💬 Join: [Laritor Discord](https://discord.laritor.com)
## Security
If you discover a security vulnerability, do not use the public issue tracker or disclose it publicly.
Please refer to our [Security Policy](https://github.com/binarybuilds/laritor-client/security/policy).

## 📜 License
## Support
Email: [support@laritor.com](mailto:support@laritor.com)
Discord: [Laritor Discord](https://discord.laritor.com)

This package is open-sourced software licensed under the [MIT license](LICENSE.md).
## License
This package is open-sourced software licensed under the [MIT license](LICENSE.md).
Binary file modified art/laritor-og.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.