Create the necessary schema and add necessary tracking code to the extension in order to track
For details see the ticket about the Grafana board: T180571
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Addshore | T173572 Add code for tracking the usage of keywords and the overall usage of the extension | |||
| Declined | GoranSMilovanovic | T180570 Grafana board for adaptation of AdvancedSearch beta feature | |||
| Resolved | GoranSMilovanovic | T180571 Shiny Dashboard for usage of the AdvancedSearch extension |
I assume this includes:
WMDE-Analytics-Engineering WMDE-Design @Jan_Dittrich @Lea_WMDE @Bmueller could you confirm this?
number of how many searches are submitted using the new form
Idea is something along the lines of
mw.track( 'advancedSearch.submit', { 'intitle': true, 'incategory': false, ... } );@Addshore Do you think this is feasible? Can the second parameter be an object?
After a quick chat with @Jan_Dittrich, we think it makes also sense to track how many users are actually visiting the new advanced search interface to compare that number with the number of users that actually submitted a search. I've added this to the list of things to track in the task description.
Adding to Tobi’s
visiting the new advanced search interface to compare
…this is basically the same principle we use for checking the turning on/off of the beta features: How many try, how many actually used it.
If you simply want to count you can use a counter, example @ https://github.com/wikimedia/mediawiki-extensions-RevisionSlider/blob/master/modules/ext.RevisionSlider.init.js#L16
Idea is something along the lines of
mw.track( 'advancedSearch.submit', { 'intitle': true, 'incategory': false, ... } );@Addshore Do you think this is feasible? Can the second parameter be an object?
This looks like you are trying to go down the event logging route.
An example can be found @ https://github.com/wikimedia/mediawiki-extensions-Flow/blob/71e04ff364650c61c5089e6eff448bece58e0b88/modules/engine/misc/flow-eventlog.js#L20 with the event. prefix.
And an example schema definition @ https://meta.wikimedia.org/wiki/Schema:FlowReplies
For further docs see https://www.mediawiki.org/wiki/Extension:EventLogging/Programming
After a quick chat with @Jan_Dittrich, we think it makes also sense to track how many users are actually visiting the new advanced search interface to compare that number with the number of users that actually submitted a search. I've added this to the list of things to track in the task description.
Is the URL exactly the same as the regular searchpage url?
If there were a difference we could simply look at the page view count for this.
…this is basically the same principle we use for checking the turning on/off of the beta features: How many try, how many actually used it.
In practise the way it is done is very different though, as counting the number of beta feature turn ofns / offs is actually done using a daily DB query and diffing the results.
AFAIK it is exactly the same URL, Special:Search. So I guess we would add tracking to the extension entrypoint and just count how often the extension is loaded. Does that make sense?
Change 388131 had a related patch set uploaded (by Kai Nissen (WMDE); owner: Kai Nissen (WMDE)):
[mediawiki/extensions/AdvancedSearch@master] Track usage of features
This requires Extension:EventLogging. The schema is hosted on meta can be retrieved from there on any other wiki.
If you want to run this in your local environment:
The new Grafana Dashboard is: Mediawiki Advanced Search.
@Tobi from Grafana, defining a query similar to the one that tracks the number of global users for the TwoColConflict extension:
keepLastValue(daily.betafeatures.global_user_counts.totals.advancedSearch,100)
the "advancedSearch" metric - nor anything similar to it - can be found from the default source (which should be Graphite).
Q1. Are the data from the extension sent to Graphite already?
Q2. This scheme is (a) stored where (database, table), and (2) used for what? @Pablo-WMDE
The extension is not currently deployed in production so you won't find any data in the production graphite.
QWERTY picked up the part for getting the tracking-code in place (https://gerrit.wikimedia.org/r/#/c/388131/) for WMDE-QWERTY-Sprint-2017-11-14
Change 388131 merged by jenkins-bot:
[mediawiki/extensions/AdvancedSearch@master] Track usage of features
Data is now availible:
mysql:research@analytics-slave.eqiad.wmnet [log]> select count(*) from AdvancedSearchRequest_17379859 limit 10; +----------+ | count(*) | +----------+ | 113 | +----------+ 1 row in set (0.00 sec)
Change 399602 had a related patch set uploaded (by Addshore; owner: Addshore):
[mediawiki/extensions/AdvancedSearch@master] Also track filetype option
Change 399602 merged by jenkins-bot:
[mediawiki/extensions/AdvancedSearch@master] Also track filetype option
Change 399628 had a related patch set uploaded (by Addshore; owner: Addshore):
[mediawiki/extensions/AdvancedSearch@wmf/1.31.0-wmf.12] Also track filetype option
Change 399628 abandoned by Addshore:
Also track filetype option
Reason:
Will just wait for the train to run this week.
Change 403113 had a related patch set uploaded (by Addshore; owner: Addshore):
[mediawiki/extensions/AdvancedSearch@master] Update AdvancedSearchRequest Logging Schema version
Change 403113 merged by jenkins-bot:
[mediawiki/extensions/AdvancedSearch@master] Update AdvancedSearchRequest Logging Schema version