Page MenuHomePhabricator
Create Task
Maniphest T269224

Track outcome of Query Builder queries via embedded query service js
Closed, ResolvedPublic
Actions

Description

In T265243, it was investigated how to track the outcomes of the queries made by the Query Builder. It was concluded that using Hadoop would not be ideal, but that we much easier use the embedded query service results view for tracking.

This embedded query service results view has already tracking of its own in ResultView.js.

We want to add tracking for:

  • Query Builder queries that are successful (even if they returned no matches)
  • Query Builder queries that resulted in a timeout
  • Query Builder queries that resulted in any other error

We can use document.referrer to tell referrers apart.

Acceptance criteria:

  • track the referrers based on a list (no-referrer, query-builder-toolforge, other)
  • for each referrer track success results, error and timeouts

Details

SubjectRepoBranchLines +/-
Check document.URL for query-builder referrer toowikidata/query/guimaster+4 -1
Merging from 94034f916853b177068051bf86ba942f0f6b618a:wikidata/query/gui-deployproduction+5 -5
Make ResultView.js track based on referrer as wellwikidata/query/guimaster+69 -8
Customize query in gerrit

Related Objects
Search...

Event Timeline

Michael created this task.Dec 2 2020, 12:34 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 2 2020, 12:34 PM
Michael mentioned this in T268639: Investigate how to track the number of queries that return a result vs an error over time.Dec 2 2020, 12:35 PM
Michael updated the task description. (Show Details)Dec 2 2020, 1:38 PM
Ladsgroup claimed this task.Dec 3 2020, 7:43 AM
Ladsgroup moved this task from To Do to Doing on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.
Restricted Application added a project: User-Ladsgroup. · View Herald TranscriptDec 3 2020, 7:43 AM
gerritbot added a comment.Dec 3 2020, 10:22 AM

Change 645045 had a related patch set uploaded (by Ladsgroup; owner: Ladsgroup):
[wikidata/query/gui@master] Make ResultView.js track based on referrer as well

https://gerrit.wikimedia.org/r/645045

gerritbot added a project: Patch-For-Review.Dec 3 2020, 10:22 AM
Ladsgroup moved this task from Doing to Peer Review on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.Dec 3 2020, 10:25 AM
gerritbot added a comment.Dec 17 2020, 4:43 PM

Change 645045 merged by jenkins-bot:
[wikidata/query/gui@master] Make ResultView.js track based on referrer as well

https://gerrit.wikimedia.org/r/645045

Ladsgroup moved this task from Peer Review to Done on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.Dec 17 2020, 4:45 PM
Ladsgroup mentioned this in rWDQG040de81dabe0: Make ResultView.js track based on referrer as well.Dec 17 2020, 4:57 PM
Maintenance_bot removed a project: Patch-For-Review.Dec 17 2020, 5:10 PM
Michael moved this task from Done to To Do on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.Dec 17 2020, 7:03 PM

This still needs a few things:

  • the change needs to be deployed
  • we need Grafana boards for it
Ladsgroup added a comment.Dec 17 2020, 7:06 PM
In T269224#6699377, @Michael wrote:

This still needs a few things:

  • the change needs to be deployed
  • we need Grafana boards for it

I was doing it as part of the story itself (maybe a new subtask?) because once the patch is merged we usually call the task (not the story) done.

Michael mentioned this in T270421: Deploy new QueryService UI with added tracking.Dec 17 2020, 7:09 PM
Michael mentioned this in T270424: Create Grafana boards for QueryService UI metrics specific to the QueryBuilder.Dec 17 2020, 7:18 PM
Michael moved this task from To Do to Done on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.
Stashbot added a comment.Dec 21 2020, 8:22 AM

Mentioned in SAL (#wikimedia-operations) [2020-12-21T08:22:49Z] <dcausse@deploy1001> Started deploy [wdqs/wdqs@512d713]: GUI updates (T269224+i18n updates)

Stashbot added a comment.Dec 21 2020, 8:31 AM

Mentioned in SAL (#wikimedia-operations) [2020-12-21T08:31:46Z] <dcausse@deploy1001> Finished deploy [wdqs/wdqs@512d713]: GUI updates (T269224+i18n updates) (duration: 08m 57s)

gerritbot added a comment.Jan 4 2021, 12:46 PM

Change 654222 had a related patch set uploaded (by Ladsgroup; owner: Ladsgroup):
[wikidata/query/gui@master] Check document.URL for query-builder referrer too

https://gerrit.wikimedia.org/r/654222

gerritbot added a project: Patch-For-Review.Jan 4 2021, 12:46 PM
Ladsgroup moved this task from Done to Peer Review on the Wikidata Query Builder (Wikidata Query Builder - sprint 5) board.Jan 4 2021, 12:46 PM

It got deployed and it seems it didn't work. I investigated and this came up. ^

Michael added a comment.Jan 4 2021, 12:51 PM

Ok, then let's try document.URL 👍

If you have a link to share that goes into more detail as to what is available to JS in an iframe, then I would be happy to learn more about it :)

gerritbot added a comment.Jan 4 2021, 12:52 PM

Change 654222 merged by jenkins-bot:
[wikidata/query/gui@master] Check document.URL for query-builder referrer too

https://gerrit.wikimedia.org/r/654222

Maintenance_bot removed a project: Patch-For-Review.Jan 4 2021, 1:10 PM
gerritbot added a comment.Jan 4 2021, 1:30 PM

Change 654228 had a related patch set uploaded (by Ladsgroup; owner: Ladsgroup):
[wikidata/query/gui-deploy@production] Merging from 94034f916853b177068051bf86ba942f0f6b618a:

https://gerrit.wikimedia.org/r/654228

gerritbot added a project: Patch-For-Review.Jan 4 2021, 1:30 PM

Change 654228 merged by Ladsgroup:
[wikidata/query/gui-deploy@production] Merging from 94034f916853b177068051bf86ba942f0f6b618a:

https://gerrit.wikimedia.org/r/654228

Ladsgroup mentioned this in rWDQG94034f916853: Check document.URL for query-builder referrer too.Jan 4 2021, 1:34 PM
Ladsgroup added a comment.Jan 4 2021, 1:35 PM
In T269224#6719125, @Michael wrote:

Ok, then let's try document.URL 👍

If you have a link to share that goes into more detail as to what is available to JS in an iframe, then I would be happy to learn more about it :)

I don't have phd in iframeology but I have a feeling that js for iframe is being run in the context of the main frame meaning document.URL is needed instead of document.referrer.

Michael added a comment.Jan 4 2021, 1:36 PM
In T269224#6719226, @Ladsgroup wrote:
In T269224#6719125, @Michael wrote:

Ok, then let's try document.URL 👍

If you have a link to share that goes into more detail as to what is available to JS in an iframe, then I would be happy to learn more about it :)

I don't have phd in iframeology but I have a feeling that js for iframe is being run in the context of the main frame meaning document.URL is needed instead of document.referrer.

🤞

Maintenance_bot removed a project: Patch-For-Review.Jan 4 2021, 2:10 PM
Lydia_Pintscher moved this task from Wikidata Query Builder - sprint 5 to Wikidata Query Builder - sprint 6 on the Wikidata Query Builder board.Jan 6 2021, 1:40 PM
Lydia_Pintscher edited projects, added Wikidata Query Builder (Wikidata Query Builder - sprint 6); removed Wikidata Query Builder (Wikidata Query Builder - sprint 5).
Lydia_Pintscher moved this task from To Do to Peer Review on the Wikidata Query Builder (Wikidata Query Builder - sprint 6) board.
Lucas_Werkmeister_WMDE subscribed.Jan 11 2021, 4:41 PM
In T269224#6719226, @Ladsgroup wrote:
In T269224#6719125, @Michael wrote:

Ok, then let's try document.URL 👍

If you have a link to share that goes into more detail as to what is available to JS in an iframe, then I would be happy to learn more about it :)

I don't have phd in iframeology but I have a feeling that js for iframe is being run in the context of the main frame meaning document.URL is needed instead of document.referrer.

The example at https://developer.mozilla.org/en-US/docs/Web/API/Document/URL#result seems to show that document.URL returns the URL of the inner document, not the top-level window.

Michael added a comment.Jan 12 2021, 4:35 PM
In T269224#6736658, @Lucas_Werkmeister_WMDE wrote:

The example at https://developer.mozilla.org/en-US/docs/Web/API/Document/URL#result seems to show that document.URL returns the URL of the inner document, not the top-level window.

Ok, so adding document.URL there should not have made any difference. So, maybe the query service UI wasn't actually deployed after we added the code for document.referrer?

Is there a way to check which version of the QueryService UI is deployed in production? For example, can I see the git commit hash somewhere or something similar?

Ladsgroup added a comment.Jan 12 2021, 4:38 PM
In T269224#6740202, @Michael wrote:
In T269224#6736658, @Lucas_Werkmeister_WMDE wrote:

The example at https://developer.mozilla.org/en-US/docs/Web/API/Document/URL#result seems to show that document.URL returns the URL of the inner document, not the top-level window.

Ok, so adding document.URL there should not have made any difference. So, maybe the query service UI wasn't actually deployed after we added the code for document.referrer?

I double checked and we getting data aligns with the second deployment (and not the first).

Is there a way to check which version of the QueryService UI is deployed in production? For example, can I see the git commit hash somewhere or something similar?

Yes, https://github.com/wikimedia/wikidata-query-deploy/commits/master

Lucas_Werkmeister_WMDE added a comment.Jan 13 2021, 4:03 PM
In T269224#6740250, @Ladsgroup wrote:

Is there a way to check which version of the QueryService UI is deployed in production? For example, can I see the git commit hash somewhere or something similar?

Yes, https://github.com/wikimedia/wikidata-query-deploy/commits/master

Well, that doesn’t tell you that much, since the Git author date might be a long time before the commit was actually deployed. Checking the time when something was merged on Gerrit would probably be more representative.

But now that we’re supposed to have faster deployments thanks to microsites, should we try to revert the URL part and see if it affects the data?

Ladsgroup added a subscriber: Lydia_Pintscher.Jan 18 2021, 8:54 PM
In T269224#6744325, @Lucas_Werkmeister_WMDE wrote:
In T269224#6740250, @Ladsgroup wrote:

Is there a way to check which version of the QueryService UI is deployed in production? For example, can I see the git commit hash somewhere or something similar?

Yes, https://github.com/wikimedia/wikidata-query-deploy/commits/master

Well, that doesn’t tell you that much, since the Git author date might be a long time before the commit was actually deployed. Checking the time when something was merged on Gerrit would probably be more representative.

https://gerrit.wikimedia.org/r/q/project:wikidata/query/deploy but in one or two cases the deployer bypassed gerrit and pushed directly to the repo

But now that we’re supposed to have faster deployments thanks to microsites, should we try to revert the URL part and see if it affects the data?

If @Lydia_Pintscher is fine we potentially lose a day or two of data, I'm fine.

Lydia_Pintscher added a comment.Jan 19 2021, 4:34 PM

Sure.

Ladsgroup mentioned this in rWDQG7a948f7c44bc: Revert "Check document.URL for query-builder referrer too".Jan 20 2021, 6:06 PM
Ladsgroup moved this task from Peer Review to ❌ Blocked on the Wikidata Query Builder (Wikidata Query Builder - sprint 6) board.Jan 20 2021, 9:18 PM

Okay, reverted and deployed. Looks good so far but will keep an eye on it in the next two days.

Lydia_Pintscher moved this task from Wikidata Query Builder - sprint 6 to ❌ Blocked on the Wikidata Query Builder board.Jan 21 2021, 8:31 AM
Lydia_Pintscher edited projects, added Wikidata Query Builder; removed Wikidata Query Builder (Wikidata Query Builder - sprint 6).
Ladsgroup moved this task from ❌ Blocked to Done on the Wikidata Query Builder board.Jan 26 2021, 5:45 PM
Lydia_Pintscher closed this task as Resolved.Jan 27 2021, 8:54 AM
Maintenance_bot moved this task from Incoming to Done on the User-Ladsgroup board.Jan 27 2021, 9:15 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits