Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julienbourdeau/route-usage
Log what routes were used and when. Easily figure out if one hasn't been called in a long time (and delete it! 🥳)
https://github.com/julienbourdeau/route-usage
Last synced: about 2 months ago
JSON representation
Log what routes were used and when. Easily figure out if one hasn't been called in a long time (and delete it! 🥳)
- Host: GitHub
- URL: https://github.com/julienbourdeau/route-usage
- Owner: julienbourdeau
- License: mit
- Created: 2019-10-15T22:26:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-17T11:32:47.000Z (about 3 years ago)
- Last Synced: 2024-03-15T09:38:50.012Z (6 months ago)
- Language: PHP
- Homepage:
- Size: 58.6 KB
- Stars: 274
- Watchers: 6
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Route Usage for Laravel
[](https://packagist.org/packages/julienbourdeau/route-usage)
[](https://travis-ci.org/julienbourdeau/route-usage)
This package keeps track of all requests to know what controller method, and when it was called. The goal is not to build some sort of analytics but to find out if there are unused endpoints or controller method.
After a few years, any projects have dead code and unused endpoint. Typically, you removed a link on your frontend, nothing ever links to that old `/special-page`. You want to remove it, but you're not sure.
Have look at the `route_usage` table and figure out when this page was accessed for the last time. Last week? Better keep it for now. 3 years ago? REMOVE THE CODE! 🥳
## Installation
You can install the package via composer:
```bash
composer require julienbourdeau/route-usage
```
Run migrations to create the new `route_usage` table.
```bash
php artisan migrate
```
Publish configuration
```bash
php artisan vendor:publish --provider="Julienbourdeau\RouteUsage\RouteUsageServiceProvider"
```
## Usage
To access the route usage, you can do it in your terminal with the command.
```bash
php artisan usage:route
```
To access the HTML table, you'll first need to define who can access it. By default,
it's available only on `local` environment.
In your `AuthServiceProvide`, in the `boot` method, define who can access this page:
```php
Gate::define('viewRouteUsage', function ($user) {
return $user->isSuperAdmin();
});
```
Then, head over to `yourapp.tld/route-usage`.
## Configuration
### excluding-regex
Here you may specify regex to exclude routes from being logged.
Typically, you want may want to exclude routes from packages or dev controllers.
The value must be a valid regex or anything falsy.
## Notes
* I only logs request with a 2xx or 3xx HTTP response. I don't think the rest makes sense. Your opinion is welcome!
* In the very first version, I was incrementing a `count` attribute. I removed it because I think it gives a wrong information. If it was used a lot because but last access was a year ago, it gives a false sense of importance to this unused route.
## Road to 1.0 release
**Less SQL queries**
I'll like to reduce the number of SQL queries performed. Typically, if a route
is called, we don't need to log usage for the next 5 minutes. I'm thinking we could
use some cache or split the data: attributes in mysql but last used date in Redis.
💡 Feel free to open an issue to discuss your ideas.
**More package to ignore**
Today, we ignore routes from Nova or Debugbar because there is nothing you can
do about these routes. I'd like to support more packages out of the box.
📦 What package would you like to see added?
## About
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
### Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
### Credits
- [Julien Bourdeau](https://github.com/julienbourdeau)
- [All Contributors](../../contributors)
### Laravel Package Boilerplate
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.