biigle / kpis
BIIGLE module to collect key performance indicators.
Installs: 1 157
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 1
README
A BIIGLE module to collect key performance indicators.
Installation
- Run
composer require biigle/kpis
. - Add the
KPIS_TOKEN
variable to the.env
file. The value is an authentication token (e.g. generated withpwgen 30 1
). - Copy the Bash script to your webserver, configure the authentication token (and maybe the base URL) inside the script and set up a daily cron job that executes the script with the gzipped webserver logfile of the previous day as argument. Example:
30 0 * * * /path/to/countRequests.sh /path/to/logfiles/$(/bin/date -Idate --date "1 day ago").sql.gz > /path/to/countRequests.log 2>&1
- Run the migrations.
Developing
Take a look at the development guide of the core repository to get started with the development setup.
Want to develop a new module? Head over to the biigle/module template repository.
Contributions and bug reports
Contributions to BIIGLE are always welcome. Check out the contribution guide to get started.