Download the PHP package daltcore/laravel-metrics without Composer
On this page you can find all versions of the php package daltcore/laravel-metrics. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download daltcore/laravel-metrics
More information about daltcore/laravel-metrics
Files in daltcore/laravel-metrics
Informations about the package laravel-metrics
Laravel Metrics
This package helps you to manage your application metrics (e.g. Time, Count, Money)
Table of Contents
- Installation
- Usage
- Create Metrics
- Metrics usage
- Start Metrics
- Stop Metrics
- Once Metrics
- Statistics
- Methods
- user()
- admin()
- startAt()
- endAt()
- betweenAt()
- period
- getBuilder()
- Results
- count()
- sum()
- avg()
- min()
- max()
- Methods
Installation
Require this package with composer:
After updating composer, add the ServiceProvider to the providers array in config/app.php
Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider
Laravel 5.x:
Copy the package config to your local config with the publish command:
You may use the metrics:table
command to generate a migration with the proper table schema:
And then migrate:
Usage
Create Metrics
You can crete new Metrics (default CountMetrics), but you can change it to TimeMetrics with parameter --time
Creating TimeMetrics example:
This will create new class in app/Metrics/
folder
Metrics usage
Now you can start watching your Metrics. You need to add trait Metricable
to your Model (e.g. User), that you want watching
Start metrics
To start Metrics:
In CountMetrics first parameter -
$user
(The user to which the metrics belongs, defaultnull
), second parameter -admin
(The user who called the metrics, defaultnull
), third parameter -$count
(How much to increase the metrics. For example, you can use money metrics. default1
)In TimeMetrics only two parameters -
$user
and$admin
or
Stop metrics
To stop Metrics:
or
Once metrics
To fire once Metrics:
Statistics
To get statistics you can use MetricsStatistics
class
Example:
Methods
user
Filter statistics by $user
(user Model, array of users or Collection of users)
$user
- The user to which the metrics belongs.
admin
Filter by admin like by user
admin
- The user who called the metrics.
startAt
Filter from $start_at
date
The metrics stats calculating by
end_at
field (when metrics stops)
endAt
Filter to $end_at
date
The metrics stats calculating by
end_at
field (when metrics stops)
betweenAt
Filter from $start_at
to $end_at
date
The metrics stats calculating by
end_at
field (when metrics stops)
period
Calculating statistics grouped by periods
getBuilder
return Builder to your custom calculating
Results
to get results
count
return Count of all filtered Metrics in DB
return Collection of Metrics
sum
return Sum of all filtered Metrics in DB
if this is TimeMetrics - total seconds for metrics
avg
return Average of all filtered Metrics in DB
if this is TimeMetrics - average seconds for metrics
min
return Min of all filtered Metrics in DB
if this is TimeMetrics - min seconds for metrics
max
return Max of all filtered Metrics in DB
if this is TimeMetrics - max seconds for metrics