Download the PHP package binaryhype/kiroku without Composer
On this page you can find all versions of the php package binaryhype/kiroku. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download binaryhype/kiroku
More information about binaryhype/kiroku
Files in binaryhype/kiroku
Package kiroku
Short Description This is my package kiroku
License MIT
Homepage https://github.com/binaryhype/kiroku
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kiroku
Kiroku – Exception forwarding for Laravel
Kiroku is a lightweight Laravel package that automatically forwards exceptions from your application to an external HTTP API. It enriches the exception with request and app context and supports optional queueing with retries/backoff. Use it to centralize error reporting in your own systems.
- Sends exception details to a configurable API endpoint with a Bearer token
- Includes request context (URL, method, IP, headers, sanitized input)
- Optional queueing with retries/backoff to avoid blocking requests
- One-liner setup for automatic reporting in Laravel 11/12
- Artisan command to send a test exception
Requirements
- PHP ^8.2
- Laravel ^12.0 (works with the streamlined bootstrap/app.php)
Installation
Install via Composer:
Publish the config file:
Configuration
Kiroku reads its configuration from config/kiroku.php (published file). Set the following environment variables in your .env:
Config reference (config/kiroku.php):
Quick start (automatic exception reporting)
With Laravel 11/12, wire Kiroku into the Exceptions configuration in your bootstrap/app.php:
From now on, every reportable exception will be sent to your configured API. If KIROKU_QUEUE_ENABLED=true, Kiroku will dispatch a queued job (with retries/backoff). Otherwise, it will send the HTTP request immediately.
What gets sent
Kiroku posts JSON to your API containing:
- Exception: code, message, file, line, trace, exception_class
- Request (if available): url, method, ip, user_agent, headers, input (with password, password_confirmation, token, _token removed)
- App: app name, app url, environment, timestamp
Manual usage
You can also log a specific exception manually:
A facade alias Kiroku is also registered, so you can import BinaryHype\Kiroku\Facades\Kiroku if you prefer.
CLI: Send a test exception
Run the built-in test command to verify your configuration:
You should see a success message on 200 OK responses, or an error message if the API rejects the request.
Queueing details
When queueing is enabled, Kiroku dispatches BinaryHype\Kiroku\Jobs\SendExceptionToApiJob with:
- 3 tries
- Backoff: [10, 30, 60] seconds
To prevent infinite loops, an internal container flag is used while processing.
Testing locally
This package uses Pest. To run the package tests:
Changelog
Please see CHANGELOG for recent changes.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Tobias Kokesch
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of kiroku with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^10.0||^11.0||^12.0