Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hsndmr/cappadocia-viewer-for-laravel
Cappadocia Viewer for Laravel
https://github.com/hsndmr/cappadocia-viewer-for-laravel
Last synced: 24 days ago
JSON representation
Cappadocia Viewer for Laravel
- Host: GitHub
- URL: https://github.com/hsndmr/cappadocia-viewer-for-laravel
- Owner: hsndmr
- License: mit
- Created: 2023-07-30T13:03:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-09T00:56:30.000Z (about 1 year ago)
- Last Synced: 2024-11-19T05:03:48.001Z (about 1 month ago)
- Language: PHP
- Size: 4.21 MB
- Stars: 13
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Cappadocia Viewer for Laravel
[](https://packagist.org/packages/hsndmr/cappadocia-viewer-for-laravel)
[](https://github.com/hsndmr/cappadocia-viewer-for-laravel/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/hsndmr/cappadocia-viewer-for-laravel/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/hsndmr/cappadocia-viewer-for-laravel)
## Installation
Prior to installing this package, ensure that you have already installed [Cappadocia Viewer](https://github.com/hsndmr/cappadocia-viewer/releases/tag/0.1.0)
You can install the package via composer:
```bash
composer require hsndmr/cappadocia-viewer-for-laravel --dev
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="cappadocia-viewer"
```
This is the contents of the published config file:
```php
return [
'server_url' => env('CAPPADOCIA_VIEWER_SERVER_URL', 'http://127.0.0.1:9091'),
'timeout' => env('CAPPADOCIA_VIEWER_TIMEOUT', 3),
'enabled' => env('CAPPADOCIA_VIEWER_ENABLED', true),
'watch_logs' => env('CAPPADOCIA_VIEWER_WATCH_LOGS', true),
'watch_jobs' => env('CAPPADOCIA_VIEWER_WATCH_JOBS', false),
'watch_queries' => env('CAPPADOCIA_VIEWER_WATCH_QUERIES', false),
];
```
## Usage
### Showing Queries
You can show queries by using `cappadocia` helper function.
````php
cappadocia()->watchQueries();
User::latest()->first();
cappadocia()->stopWatchingQueries();
// This query will not be shown in the viewer
User::first()->first();
````
If you want to show all queries, you can add `CAPPADOCIA_VIEWER_WATCH_QUERIES=true` to your .env file.
### Showing Jobs
You can show jobs by using `cappadocia` helper function.
```` php
cappadocia()->watchJobs();
CappadociaViewerJob::dispatchSync('viewer');
cappadocia()->stopWatchingJobs();
// This job will not be shown in the viewer
CappadociaViewerJob::dispatchSync('another viewer');
````
If you are utilizing Laravel Horizon, you can insert `CAPPADOCIA_VIEWER_WATCH_JOBS=true` into your .env file. This will enable you to view all jobs in the viewer
```` php
CappadociaViewerJob::dispatch('viewer');
````
### Showing Logs
Logs are shown by default. If you want to disable it, you can add `CAPPADOCIA_VIEWER_WATCH_LOGS=false` to your .env file.
```` php
Log::info('This log will be shown in the viewer');
````
### Showing Requests
If you want to show requests, you can add `CAPPADOCIA_VIEWER_WATCH_REQUESTS=true` to your .env file. After that, you can see all requests in the viewer.
### Custom Messages
If you want to show custom messages, you can use `cappadocia` helper function.
```` php
cappadocia('This is custom message')
->send([
'custom' => 'data',
]);
cappadocia('This is custom message with Badge')
->setBadge('Badge')
->send([
'custom' => 'data',
]);
````
### Disabling Cappadocia Viewer
To disable the Cappadocia Viewer, you can include `CAPPADOCIA_VIEWER_ENABLED=false` in your .env file. This could be particularly useful if you wish to disable it within a testing environment.
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Hasan Demir](https://github.com/hsndmr)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.