http://wiki.koha-community.org/wiki/KohaUsageStat_RFC
Created attachment 26203 [details] [review] work in progress
*** Bug 6293 has been marked as a duplicate of this bug. ***
Created attachment 26346 [details] [review] Package updates: * POD doc * hardcoding hea.koha-community.org as the URL where the stats must be sent * fixing some typos * adding all sysprefs we want to upload
Created attachment 26352 [details] [review] Bug 11926: URI-encode data sent to statistics server
Created attachment 31369 [details] [review] Bug 11926: Add a cronjob
Created attachment 31370 [details] [review] Bug 11926: Add new sysprefs and fix encoding issues
Created attachment 31373 [details] [review] Bug 11926: Add the items table
Created attachment 32024 [details] [review] Bug 11926: Render community koha statistic usages Goals: - Collecting Koha usage statistics - Rendering stats on a community website - Having a big bicture of how koha is used 3 parts in the project: - this patch in koha - hea-ws which collects data - hea-app which renders data Installation: 1/ Fill systempreferences: UsageStatsLastUpdateTime UsageStatsID UsageStatsShare UsageStatsLibraryName 2/ Setup a cron in your crontab (ex: at 3:00 every first of the month): 0 3 1 * * export KOHA_CONF=/home/koha/etc/koha-conf.xml; export PERL5LIB=/home/koha/src; perl /home/koha/src/C4/UsageStats.pm
Created attachment 32025 [details] [review] Bug 11926: Package updates * POD doc * hardcoding hea.koha-community.org as the URL where the stats must be sent * fixing some typos * adding all sysprefs we want to upload.
Created attachment 32026 [details] [review] Bug 11926: URI-encode data sent to statistics server
Created attachment 32027 [details] [review] Bug 11926: Add a cronjob
Created attachment 32028 [details] [review] Bug 11926: Add new sysprefs and fix encoding issues
Created attachment 32029 [details] [review] Bug 11926: Add the items table
Created attachment 32030 [details] [review] Bug 11926: DB changes This patch adds the syspref in the database.
I added the changes to updatedb.pl and syspref.sql into a specific patch to make easier the installation.
This cans be signed off.
Created attachment 32262 [details] [review] Bug 11926: Render community koha statistic usages Goals: - Collecting Koha usage statistics - Rendering stats on a community website - Having a big bicture of how koha is used 3 parts in the project: - this patch in koha - hea-ws which collects data - hea-app which renders data Installation: 1/ Fill systempreferences: UsageStatsLastUpdateTime UsageStatsID UsageStatsShare UsageStatsLibraryName 2/ Setup a cron in your crontab (ex: at 3:00 every first of the month): 0 3 1 * * export KOHA_CONF=/home/koha/etc/koha-conf.xml; export PERL5LIB=/home/koha/src; perl /home/koha/src/C4/UsageStats.pm Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32263 [details] [review] Bug 11926: Package updates * POD doc * hardcoding hea.koha-community.org as the URL where the stats must be sent * fixing some typos * adding all sysprefs we want to upload. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32264 [details] [review] Bug 11926: URI-encode data sent to statistics server Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32265 [details] [review] Bug 11926: Add a cronjob Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32266 [details] [review] Bug 11926: Add new sysprefs and fix encoding issues Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32267 [details] [review] Bug 11926: Add the items table Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32268 [details] [review] Bug 11926: DB changes This patch adds the syspref in the database. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
The patch needs something : Bug 11926: Add a cronjob It adds the cronjob script with permissions 644 instead of 755
Some ideas for improvements: - Country is a free text field, so it's not really clear what to enter there. Should we maybe point to a list of codes to use (ISO?) so that we get cleaner data? - Add information about data privacy on the HEA website. Are logs (IP addresses) regularly deleted? How long is data kept? Which data is stored exactly, etc. - Add a bit more documentation - are LibraryName and LibraryURL mandatory? If not, I think it would be nice to mark them as optional in the pref description. - Mention the cronjob in the pref descriptions? I did a few follow-ups - addressing Fridolin's last comment and some other things found by the QA scrpt.
Created attachment 32455 [details] [review] Bug 11926: Render community koha statistic usages Goals: - Collecting Koha usage statistics - Rendering stats on a community website - Having a big bicture of how koha is used 3 parts in the project: - this patch in koha - hea-ws which collects data - hea-app which renders data Installation: 1/ Fill systempreferences: UsageStatsLastUpdateTime UsageStatsID UsageStatsShare UsageStatsLibraryName 2/ Setup a cron in your crontab (ex: at 3:00 every first of the month): 0 3 1 * * export KOHA_CONF=/home/koha/etc/koha-conf.xml; export PERL5LIB=/home/koha/src; perl /home/koha/src/C4/UsageStats.pm Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32456 [details] [review] Bug 11926: Package updates * POD doc * hardcoding hea.koha-community.org as the URL where the stats must be sent * fixing some typos * adding all sysprefs we want to upload. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32457 [details] [review] Bug 11926: URI-encode data sent to statistics server Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32458 [details] [review] Bug 11926: Add a cronjob Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32459 [details] [review] Bug 11926: Add new sysprefs and fix encoding issues Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32460 [details] [review] Bug 11926: Add the items table Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32461 [details] [review] Bug 11926: DB changes This patch adds the syspref in the database. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz>
Created attachment 32462 [details] [review] Bug 11926: Follow-up - remove SearchEngine pref / fix POD Patch set reintroduced the formerly removed system preference, just removing it again. Also fixes complaints of the QA script about POD in the new module.
Created attachment 32463 [details] [review] Bug 11926: Follow-up - Fix new cronjob's file permissions
Created attachment 32464 [details] [review] [PASSED QA] Bug 11926: Render community koha statistic usages Goals: - Collecting Koha usage statistics - Rendering stats on a community website - Having a big bicture of how koha is used 3 parts in the project: - this patch in koha - hea-ws which collects data - hea-app which renders data Installation: 1/ Fill systempreferences: UsageStatsLastUpdateTime UsageStatsID UsageStatsShare UsageStatsLibraryName 2/ Setup a cron in your crontab (ex: at 3:00 every first of the month): 0 3 1 * * export KOHA_CONF=/home/koha/etc/koha-conf.xml; export PERL5LIB=/home/koha/src; perl /home/koha/src/C4/UsageStats.pm Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32465 [details] [review] [PASSED QA] Bug 11926: Package updates * POD doc * hardcoding hea.koha-community.org as the URL where the stats must be sent * fixing some typos * adding all sysprefs we want to upload. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32466 [details] [review] [PASSED QA] Bug 11926: URI-encode data sent to statistics server Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32467 [details] [review] [PASSED QA] Bug 11926: Add a cronjob Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32468 [details] [review] [PASSED QA] Bug 11926: Add new sysprefs and fix encoding issues Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32469 [details] [review] [PASSED QA] Bug 11926: Add the items table Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32470 [details] [review] [PASSED QA] Bug 11926: DB changes This patch adds the syspref in the database. Signed-off-by: Chris Cormack <chris@bigballofwax.co.nz> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Created attachment 32471 [details] [review] Bug 11926: Follow-up - remove SearchEngine pref / fix POD Patch set reintroduced the formerly removed system preference, just removing it again. Also fixes complaints of the QA script about POD in the new module.
Created attachment 32472 [details] [review] Bug 11926: Follow-up - Fix new cronjob's file permissions
Created attachment 32582 [details] [review] Bug 11926 [Follow-up] HEA - Render community koha statistic usages This follow-up makes some language and spelling corrections to the system preference descriptions. I have updated the preferences heading to read "Share anonymous usage statistics" in order to emphasize the anonymous aspect. I have also updated the main preference name from "UsageStatsShare" to "UsageStats" so that it is alphabetized first in the list of "UsageStats*" preferences. I think this will make it clearer to the Koha administrator what feature they are configuring.
Patches pushed to master. Nice feature! Thanks everyone
Hi Mason, The patch set applies cleanly on 3.16.x (only 2 conflicts on installer/data/mysql/updatedatabase.pl and koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/admin.pref, very easy to fix). You can backport it on 3.16.x if you like.