biigle/kpis

BIIGLE module to collect key performance indicators.

v1.3.0 2026-08-04 12:38 UTC

GPL-3.0-only

• Martin Zurowietz

• biigle
• biigle-module

Published on Packagist.org on 2026-08-04 12:38 UTC

README

A BIIGLE module to collect key performance indicators.

Installation

1. Run composer require biigle/kpis.
2. Add the KPIS_TOKEN variable to the .env file. The value is an authentication token (e.g. generated with pwgen 30 1).
3. Add the KPIS_SCORPION_TOKEN variable to the .env file. The value is the authentication token for the Scorpion API to submit KPIs to. Optionally, set KPIS_SCORPION_SERVICE if the service name should differ from the default BIIGLE.
4. 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
   

5. 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.