Download the PHP package elegantly/laravel-kpi without Composer
On this page you can find all versions of the php package elegantly/laravel-kpi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elegantly/laravel-kpi
More information about elegantly/laravel-kpi
Files in elegantly/laravel-kpi
Package laravel-kpi
Short Description Advanced KPI for your Laravel application
License MIT
Homepage https://github.com/elegantengineeringtech/laravel-kpi
Informations about the package laravel-kpi
Store, analyse and retrieve KPI over time in your Laravel App
This package provides a way to store kpis from your app in your database and then retreive them easily in different ways. It is espacially usefull to tracks things related to your models like:
- the number of users
- the number of subscribed users
- the total revenue ...
It's a perfect tool for building dashboard ans display stats/charts.
Installation
You can install the package via composer:
You should publish and run the migrations with:
You can publish the config file with:
This is the contents of the published config file:
Usage
This package is not a query builder, it's based on a kpis
table where you will store all your kpis. With this approach, your kpis from the past (like the number of users you had a year ago) will not be altered if you permanently delete a model.
Retreiving kpis will also be much more efficient when asking for computed values that often require join like "users who have purchased last week" for example.
1. Defining a KPI
As said above, you will have to store the kpis you need in the database.
A KPI is represented by a KpiDefinition
class.
2. Snapotting your KPIs
There are two ways to snapshot a KPI:
- Schedule the
kpis:snapshot
command - Manual snaphot
This package assumes that you want to snapshot every KPI at a regular interval. For exemple: capturing the number of active user every minute.
To do that, you should schedule the command kpis:snapshot
to run at regular interval in your app.
Every KPI are not always snashotted at the same interval so you will need to schedule the command multiple times:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Quentin Gabriele
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-kpi with dependencies
elegantly/laravel-money Version ^2.0.1
illuminate/contracts Version ^11.0
spatie/laravel-package-tools Version ^1.16
spatie/php-structure-discoverer Version ^2.2