Bug 23898 - New data to share on HEA
Summary: New data to share on HEA
Status: Needs Signoff
Alias: None
Product: Koha
Classification: Unclassified
Component: Architecture, internals, and plumbing (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Arthur Suzuki
QA Contact: Testopia
URL:
Keywords:
: 23897 (view as bug list)
Depends on:
Blocks:
 
Reported: 2019-10-25 12:42 UTC by Paul Poulain
Modified: 2025-01-27 15:19 UTC (History)
4 users (show)

See Also:
Change sponsored?: Sponsored
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments
Bug 23898: Share more data to HEA : test plan (2.58 KB, patch)
2025-01-15 15:41 UTC, Arthur Suzuki
Details | Diff | Splinter Review
Bug 23898: Share new data to HEA (2.86 KB, patch)
2025-01-15 15:41 UTC, Arthur Suzuki
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Paul Poulain 2019-10-25 12:42:41 UTC
Some ideas of thing that could be shared on HEA for statistics purposes:

- adding some statistics like "intranetuserjs yes/no" => yes if there's something, no if it's empty ? (intranetuserjs, opacuserjs, opac & intranet css, opacheader, opacnav, opacbottom).
- For sysprefs *XSLT* => we could send "empty/default/local".
Comment 1 Jonathan Druart 2019-10-25 13:14:49 UTC
*** Bug 23897 has been marked as a duplicate of this bug. ***
Comment 2 Victor Grousset/tuxayo 2020-05-06 18:21:26 UTC
Similar sysprefs to consider also. Maybe in a followup bug.

AmazonAssocTag
IntranetCirculationHomeHTML
IntranetFavicon
IntranetmainUserblock
IntranetNav
IntranetReportsHomeHTML
IntranetSlipPrinterJS
intranetstylesheet
OpacCustomSearch
OPACHoldsIfAvailableAtPickupExceptions
OpacLoginInstructions
OpacMainUserBlock
OpacMoreSearches
OPACResultsSidebar
OPACSearchForTitleIn
ProcessingFeeNote
RestrictedPageContent
RoutingListNote
SpineLabelFormat
XSLTDetailsDisplay
Comment 3 Katrin Fischer 2020-05-06 21:06:18 UTC
(In reply to Victor Grousset/tuxayo from comment #2)
> Similar sysprefs to consider also. Maybe in a followup bug.
> 
> AmazonAssocTag
> IntranetCirculationHomeHTML
> IntranetFavicon
> IntranetmainUserblock
> IntranetNav
> IntranetReportsHomeHTML
> IntranetSlipPrinterJS
> intranetstylesheet
> OpacCustomSearch
> OPACHoldsIfAvailableAtPickupExceptions
> OpacLoginInstructions
> OpacMainUserBlock
> OpacMoreSearches
> OPACResultsSidebar
> OPACSearchForTitleIn
> ProcessingFeeNote
> RestrictedPageContent
> RoutingListNote
> SpineLabelFormat
> XSLTDetailsDisplay

I don't think we will gain much from sharing these if anything at all and they are all likely to include very library specific information. I think we should not share them.
Comment 4 Katrin Fischer 2020-05-06 21:07:13 UTC
Empty or 'used' might work, but not sure about the information gain and it might scare people of thinking we share the actual content.
Comment 5 Jonathan Druart 2020-05-07 08:30:44 UTC Comment hidden (obsolete)
Comment 6 Victor Grousset/tuxayo 2020-05-08 14:11:44 UTC
(In reply to Katrin Fischer from comment #4)
> Empty or 'used' might work, but not sure about the information gain and it
> might scare people of thinking we share the actual content.

+1
Comment 7 Arthur Suzuki 2025-01-15 15:41:10 UTC
Created attachment 176577 [details] [review]
Bug 23898: Share more data to HEA : test plan

It would be nice to get more data about which functionnality are used
or not.
This could be achieved with sharing some systempreferences.
However some of the systempreferences may hold some private
information.
This patch propose a way to share some syspref usage without sharing
their values.

Test plan :
- apply test patch
- prove t/db_dependent/UsageStats.t -> fail
- apply code patch
- prove t/db_dependent/UsageStats.t -> green

Once this patch is applied to a production environment with HEA
enabled, more systempreferences will be shared but those which values
are meant to be private will only send "Empty" or "Used" value instead
of the actual value.
This will help the community find out about unused or rarely used
functionnality and debug some specific systempreference combinations
which may cause an issue.

(this commit holds the tests)
Comment 8 Arthur Suzuki 2025-01-15 15:41:22 UTC
Created attachment 176578 [details] [review]
Bug 23898: Share new data to HEA

Test plan :
Apply test patch
prove t/db_dependent/UsageStats.t -> fail
apply patch
prove t/db_dependent/UsageStats.t -> green

After patch is applied to a production environment with HEA sharing
enabled,
more data will be shared to the community.
Those data will help us clean some unused functionnality or debug some
rare case where systempreferences configuration might be broken.
Comment 9 Fridolin Somers 2025-01-27 15:19:29 UTC
OpacMainUserBlock is not a system preference anymore