Instrument IP address copy action metric
Closed, ResolvedPublic5 Estimated Story Points
Actions

Assigned To

Authored By

	• Niharika
	Apr 7 2021, 2:04 PM

Description

Motivation

There's more context for why we want to do this in T273021: Collect metrics for IP usage and an investigation on how we could do this in T273091: Investigate: Measure how often IP addresses are copied [8H].

What we want to capture

Capture how often an IP address is copied on one of the page-types below
Capture the page type on which the copy action happened (this will give us a sense of which pages are more important in this workflow for editors to scrutinize IP edits, T263637)
- History pages (action=history)
- Special:RecentChanges
- Special:Log
- Special:Investigate
- Special:Contributions

What we don't want to capture

IP addresses being copied
User identification of the user doing the copy action

How we want to log this

We will use statsd/Graphite for this. Helpful links:

QA prerequisites

The EventLogging and WikimediaEvents extensions are installed
The following lines are in your LocalSettings.php:

LocalSettings.php`

$wgWMEStatsdBaseUri = '/beacon/statsv';
$wgWMEIPAddressCopyActionEnabled = true;

QA steps

Log out
Make an edit to a page
View the history of that page (click the "View history" tab)
Copy the IP address of the most recent edit
Observe that an HTTP request has been made to /beacon/statsv?MediaWiki.ipinfo_address_copy.action_history=1c after a brief delay
Visit Special:RecentChanges
Copy the IP address of the most recent edit
Observe that an HTTP request has been made to /beacon/statsv?MediaWiki.ipinfo_address_copy.special_recentchanges=1c after a brief delay
View the contributions from that IP by visiting /wiki/Special:Contributions/...
Copy the IP address from the content of that page
Observe that an HTTP request has been made to /beacon/statsv?MediaWiki.ipinfo_address_copy.special_contributions=1c after a brief delay

Details

Subject	Repo	Branch	Lines +/-
wikimediaEvents: Enable IP address copy action instrument on all wikis	operations/mediawiki-config	master	+7 -0
beta: Enable IP address copy action instrument	operations/mediawiki-config	master	+5 -0
Add IP address copy action instrument	mediawiki/extensions/WikimediaEvents	master	+156 -1

Customize query in gerrit

Related Objects

Mentioned In: T296469: Log when a user copies an IP address
T289395: Break down copy action metrics by wiki [S]
T288308: Track IP address copy actions on certain pages
T273091: Investigate: Measure how often IP addresses are copied [8H]
Mentioned Here: rEWMV5844e15ab831: Replace deprecated UserSaveOptions hook
rMWc8cb4108f4be: Branch commit for wmf/1.37.0-wmf.18
rOMWC0a14eb418288: wikimediaEvents: Enable IP address copy action instrument on all wikis
rMW53c539f4ba89: Merge "Hard-deprecate Title::isNamespaceProtected"
T263637: Determine on which pages IPInfo should be available
T273021: Collect metrics for IP usage
T273091: Investigate: Measure how often IP addresses are copied [8H]

Event Timeline

• Niharika triaged this task as Medium priority.Apr 7 2021, 2:04 PM

• Niharika created this task.

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 7 2021, 2:04 PM

• Niharika updated the task description. (Show Details)Apr 7 2021, 3:43 PM

• Niharika updated the task description. (Show Details)Apr 7 2021, 4:33 PM

jwang subscribed.Apr 8 2021, 4:38 PM

• Niharika updated the task description. (Show Details)Apr 13 2021, 7:11 PM

• Niharika updated the task description. (Show Details)

• Niharika updated the task description. (Show Details)Apr 14 2021, 4:28 PM

ARamirez_WMF set the point value for this task to 5.Apr 14 2021, 4:34 PM

ARamirez_WMF moved this task from Triage/To be Estimated to Cards ready for development on the Anti-Harassment board.

• Niharika merged a task: T275634: Instrumentation for IP address copy action.Apr 21 2021, 1:58 PM

• Niharika added a subscriber: Tchanders.

ARamirez_WMF moved this task from Cards ready for development to The Letter Song on the Anti-Harassment board.May 25 2021, 4:12 PM

ARamirez_WMF edited projects, added Anti-Harassment (The Letter Song); removed Anti-Harassment.

• Niharika mentioned this in T273091: Investigate: Measure how often IP addresses are copied [8H].May 26 2021, 12:43 PM

• wikitrent claimed this task.May 27 2021, 3:47 PM

• wikitrent moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (The Letter Song) board.May 27 2021, 5:12 PM

• wikitrent moved this task from In Progress 💪 to Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) on the Anti-Harassment (The Letter Song) board.Jun 8 2021, 4:00 PM

ARamirez_WMF removed • wikitrent as the assignee of this task.Jun 8 2021, 4:09 PM

ARamirez_WMF added a subscriber: • wikitrent.

In T273091#6848696, @Niharika wrote:

[…] Aggregating by userid would be useful to figure out how many users do lookups on IPs, […]

From the task description:

What we don't want to capture: User identification of the user doing the copy action.

Based on the second part, I assume the former has since been reframed, but I just wanted to state explicitly that indeed I think the standard today for new instrumentation is to avoid user names/user IDs and instead use either uncorrelated "analytics session" IDs, or server-side hashed ids from a dedicated salt (see take WikimediaEvents' PageViews and VectorPrefDiffInstrumentation for good examples of this). The point being that this ensures 1) accidental disclose is unlikely to leak PII, and 2) our audience has confidence in staff and invited researchers not using the data for purposes other than what was declared ahead of time, 3) new questions that are too dissimilar naturally have to go through re-review and ensure use of a statistically valid approach.

Discussion happening here: https://wikimedia.slack.com/archives/CH6DDTDNG/p1623074938034500

phuedx claimed this task.Jul 19 2021, 4:08 PM

phuedx moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (The Letter Song) board.

Change 705678 had a related patch set uploaded (by Phuedx; author: Phuedx):

[mediawiki/extensions/WikimediaEvents@master] WIP Add IP address copy action instrument

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

gerritbot added a project: Patch-For-Review.Jul 20 2021, 1:15 PM

phuedx moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (The Letter Song) board.Jul 20 2021, 5:51 PM

phuedx moved this task from Code Review 🔍 to In Progress 💪 on the Anti-Harassment (The Letter Song) board.Jul 22 2021, 7:06 AM

phuedx moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (The Letter Song) board.Jul 22 2021, 3:33 PM

Change 705678 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Add IP address copy action instrument

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

ReleaseTaggerBot added a project: MW-1.37-notes (1.37.0-wmf.16; 2021-07-26).Jul 23 2021, 3:00 PM

Maintenance_bot removed a project: Patch-For-Review.Jul 23 2021, 3:10 PM

In T279540#7232918, @gerritbot wrote:

Change 705678 merged by jenkins-bot:

[mediawiki/extensions/WikimediaEvents@master] Add IP address copy action instrument

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

FYI: I ~~moved your cheese~~ renamed the metric added in this patch as part of https://gerrit.wikimedia.org/r/707619. (The original hasn't gone out yet, but just in case you wrote it down somewhere).

phuedx moved this task from Code Review 🔍 to QA/Testing 🐞 on the Anti-Harassment (The Letter Song) board.Jul 26 2021, 1:38 PM

Thanks for the note, @Krinkle.

Here are the metrics that we should expect to be tracked when the original change and @Krinkle's ride the train this week:

MediaWiki.ipinfo_address_copy.action_history when the user copies an IP address when viewing the history of a page
MediaWiki.ipinfo_address_copy.special_ + the lowercase canonical name of the special page when the user copies an IP address on one of the special pages listed in the description

phuedx moved this task from QA/Testing 🐞 to In Progress 💪 on the Anti-Harassment (The Letter Song) board.Jul 26 2021, 6:47 PM

phuedx updated the task description. (Show Details)Jul 26 2021, 7:01 PM

phuedx moved this task from In Progress 💪 to QA/Testing 🐞 on the Anti-Harassment (The Letter Song) board.Jul 27 2021, 3:49 PM

Change 708488 had a related patch set uploaded (by Phuedx; author: Phuedx):

[operations/mediawiki-config@master] beta: Enable IP address copy action instrument

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

gerritbot added a project: Patch-For-Review.Jul 28 2021, 9:58 AM

Change 708488 merged by jenkins-bot:

[operations/mediawiki-config@master] beta: Enable IP address copy action instrument

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

@imaigwilo: I've just double-checked and this should now be available to test on the Beta Cluster.

Thanks @phuedx , I was able to perform the test steps accordingly for the following pages.
The Http request loaded, please confirm the verbiage is what you expected, it is different from your notes.
MediaWiki version 1.37.0-alpha (53c539f)

History pages (action=history)

Screen Shot 2021-07-29 at 10.43.53 AM.png (1×2 px, 608 KB)

Special:RecentChanges

Screen Shot 2021-07-29 at 10.55.37 AM.png (1×1 px, 779 KB)

Special:Contributions

Screen Shot 2021-07-29 at 11.05.09 AM.png (1×2 px, 491 KB)

@Niharika Note: There where some pages I could not track the user IP address copy, see below:

Special:Log example: https://en.wikipedia.beta.wmflabs.org/wiki/Special:Log
IP address did not show on page:

Special:Investigate example: https://en.wikipedia.beta.wmflabs.org/Special:Investigate
Page not found:

• imaigwilo moved this task from QA/Testing 🐞 to Done: Q1 (2021-22) on the Anti-Harassment (The Letter Song) board.Jul 29 2021, 6:13 PM

In T279540#7246988, @imaigwilo wrote:

The Http request loaded, please confirm the verbiage is what you expected, it is different from your notes.

Thanks, @imaigwilo. It looks like the difference between my notes and what you observed is the URL path and the counter. prefix from the bucket name. That's purely my mistake and not indicative of a bug. I'll update my notes.

phuedx updated the task description. (Show Details)Jul 30 2021, 9:18 AM

Thanks @imaigwilo.

For Special:Log, I see some IPs in the Global IP block log - https://meta.wikimedia.beta.wmflabs.org/wiki/Special:Log/gblblock maybe you could check for that?

For Special:Investigate, you won't see it on between a since the extension (Checkuser) that creates that special page is not on beta. It will only be test-able once in production.

Is it okay if I move this into the QA column until the change has been tested in production?

I was able to test using the Global IP block log - https://meta.wikimedia.beta.wmflabs.org/wiki/Special:Log/gblblock, below is the screen shot of IP address copy network logging

Screen Shot 2021-07-30 at 10.22.05 PM.png (1×2 px, 495 KB)

And yes it is okay I have moved this ticket back to QA column till all changes is tested in Production.
Thanks @Niharika

• imaigwilo moved this task from Done: Q1 (2021-22) to QA/Testing 🐞 on the Anti-Harassment (The Letter Song) board.Aug 2 2021, 2:47 PM

Change 710313 had a related patch set uploaded (by Phuedx; author: Phuedx):

[operations/mediawiki-config@master] wikimediaEvents: Enable IP address copy action instrument on all wikis

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

Change 710313 merged by jenkins-bot:

[operations/mediawiki-config@master] wikimediaEvents: Enable IP address copy action instrument on all wikis

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

Mentioned in SAL (#wikimedia-operations) [2021-08-05T18:18:56Z] <urbanecm@deploy1002> Synchronized wmf-config/InitialiseSettings.php: 0a14eb418288ad8ea25c206d20f2bed589de8107: wikimediaEvents: Enable IP address copy action instrument on all wikis (T279540) (duration: 01m 07s)

@Niharika I get the page below in prod when I try to view the page below. https://en.wikipedia.org/wiki/Special:Investigate
Do you know who is in the Checkusers group, that I can work with to test this in prod. Thank you.

Screen Shot 2021-08-05 at 5.47.16 PM.png (938×2 px, 293 KB)

jwang mentioned this in T288308: Track IP address copy actions on certain pages.Aug 5 2021, 10:32 PM

We tested this on test.wikipedia.org.

On the IP & User agents tab:

special_investigate.png (1×1 px, 259 KB)

On the Timeline tab:

special_investigate_timeline.png (1×1 px, 341 KB)

The URL it logs to is https://test.wikipedia.org/beacon/statsv?MediaWiki.ipinfo_address_copy.special_investigate=1c

Test Environment: https://test.wikipedia.org MediaWiki 1.37.0-wmf.18 (rMWc8cb4108f4be) 02:06, 10 August 2021. WikimediaEvents 1.2.0 (5844e15) 13:57, 30 July 2021.
Test Browser: Firefox 78

• Niharika closed this task as Resolved.Aug 16 2021, 11:15 PM

dom_walden mentioned this in T289395: Break down copy action metrics by wiki [S].Oct 26 2021, 3:20 PM

phuedx mentioned this in T296469: Log when a user copies an IP address.Nov 25 2021, 11:09 AM

• Niharika moved this task from Backlog to Closed on the IP Info board.Aug 8 2022, 7:59 PM

	F34590513: special_investigate_timeline.png
	Aug 11 2021, 2:06 PM

	F34585628: Screen Shot 2021-08-05 at 5.47.16 PM.png
	Aug 5 2021, 9:52 PM

	F34573763: Screen Shot 2021-07-30 at 10.22.05 PM.png
	Aug 2 2021, 2:44 PM

	F34569620: Screen Shot 2021-07-29 at 10.55.37 AM.png
	Jul 29 2021, 6:12 PM

	F34569667: Screen Shot 2021-07-29 at 10.43.53 AM.png
	Jul 29 2021, 6:12 PM

	F34569631: Screen Shot 2021-07-29 at 11.05.09 AM.png
	Jul 29 2021, 6:12 PM

Instrument IP address copy action metricClosed, ResolvedPublic5 Estimated Story PointsActions