Page MenuHomePhabricator
Create Task
Maniphest T320537

<spike> Usage and traffic data for WMF APIs
Closed, InvalidPublic
Actions

Description

In order to determine how the API Platform can provide value for the Movement, we need to understand how all WMF maintained APIs are currently being used.

Steps:

  • 1. Talk to Metrics about what is currently available.
  • 2. From that conversation, get more explicit requirements from the product side
  • 3. Establsih a

Our goal is to provide transparent, equitable access to our data and knowledge as part of the 2030 WMF strategic direction.

List of known APIs to gather observable data from (in order of priority)

  • Action API
  • RESTbase
  • MediaWiki REST API
  • Wikidata Query Service (WDQS)
  • Wikidata API
  • EventGate
  • EventStreams
  • Maps Service
  • Push Notifications Service
  • Mobile View API
  • Image Recommendation Service
  • Kask Service
  • ORES Service
  • Proton Service
  • Trending Edits
  • Thumbor
  • Image suggestion API

Acceptance criteria

  • Usage and traffic data that describes who/what is using them, what they use them for, how much they use them, and from where geographically are they used
  • Raw data and visualized data when possible

Collaboratively gathering the following information:

  • Catalog of all know API services supported by technology department
  • Current routing and directional (NSEW) information for each independently deployed API service and/or endpoint
  • Type of protocol (REST, SOAP, RPC, SparQL, etc) for each
  • Known application dependencies
  • Technical and product ownership, if known
  • Repository for each service
  • Documentation for each service
Research Doc

API Platform Knowldge Hub, API Catalog

Related Objects
Search...

Event Timeline

VirginiaPoundstone reassigned this task from VirginiaPoundstone to hnowlan.Oct 11 2022, 4:40 PM
VirginiaPoundstone created this task.
VirginiaPoundstone updated the task description. (Show Details)
VirginiaPoundstone updated the task description. (Show Details)Oct 11 2022, 4:43 PM
VirginiaPoundstone moved this task from Incoming to Must do now on the API Platform board.Oct 11 2022, 6:10 PM
hnowlan added a comment.Oct 13 2022, 1:59 PM

For most/all of these dashboards be aware of the variable selectors at the top of the page - data will frequently be shown per datacentre, for holistic numbers take measurements from both eqiad and codfw. For many of these services the numbers are not fully representative - for example a page might be requested from mobileapps once but served by restbase many times over a period of time.

Action API/REST API - not sure how we differentiate between these, will need to do a bit of digging

Restbase dashboard: https://grafana-rw.wikimedia.org/d/000000068/restbase?orgId=1

WDQS: https://grafana-rw.wikimedia.org/d/000000489/wikidata-query-service?orgId=1&refresh=1m

For Wikidata API I am assuming this means Wikibase: https://grafana.wikimedia.org/d/MR93RkVWk/wikibase-api?orgId=1&refresh=5m

Eventgate: https://grafana.wikimedia.org/d/ZB39Izmnz/eventgate?orgId=1

Eventstreams: https://grafana.wikimedia.org/d/znIuUcsWz/eventstreams?orgId=1&refresh=1m

Maps - this is a bit of a vague one, tiles per second might be of interest on this dashboard? https://grafana-rw.wikimedia.org/d/000000305/maps-performances?orgId=1

Push Notifications: https://grafana.wikimedia.org/d/NQO_pqvMk/push-notifications

Mobileapps: https://grafana.wikimedia.org/d/5CmeRcnMz/mobileapps?orgId=1

Which recommendation service?

Kask/Sessionstore: https://grafana.wikimedia.org/d/000001590/sessionstore?orgId=1

ORES: https://grafana.wikimedia.org/d/vAN_bQemz/ores-advanced-metrics?orgId=1&refresh=1m

Proton: https://grafana.wikimedia.org/d/U4TuF-lMk/proton?orgId=1

Trending edits: Not sure what this is

Thumbor: qps panels here https://grafana.wikimedia.org/d/Pukjw6cWk/thumbor?orgId=1&refresh=30s

image-suggestion: https://grafana.wikimedia.org/d/SUZQ6rWVz/image-suggestion?orgId=1

hnowlan added a project: Platform Team Workboards (Platform Engineering Reliability).Oct 13 2022, 1:59 PM
hnowlan moved this task from Backlog to Doing 🔨 on the Platform Team Workboards (Platform Engineering Reliability) board.
hnowlan moved this task from Doing 🔨 to In review on the Platform Team Workboards (Platform Engineering Reliability) board.
VirginiaPoundstone closed this task as a duplicate of T319330: Document current WMF service usage across the WMF ecosystem.Oct 14 2022, 11:08 PM
VirginiaPoundstone reopened this task as In Progress.Oct 14 2022, 11:10 PM
VirginiaPoundstone triaged this task as Medium priority.
VirginiaPoundstone moved this task from Must do now to Backlog on the API Platform board.
VirginiaPoundstone moved this task from Backlog to QA/Review on the API Platform board.Oct 25 2022, 4:24 PM
VirginiaPoundstone added a comment.EditedOct 25 2022, 7:06 PM

Thanks for all this @hnowlan
Is there a way to see who is driving what traffic? I need to know what bots, apps, and other caller/consumers are using what. This will help me gather requirements and strategize in general about what we can do to be useful to the movement. If there is a way to see the who in these dashboards, then maybe I just need a 15 minute meeting for a tutorial.

Also recommendations was Image recommendations. I'll see if I can learn more about trending edits.

VirginiaPoundstone updated the task description. (Show Details)Oct 25 2022, 7:07 PM
VirginiaPoundstone moved this task from QA/Review to Sprint 01 on the API Platform board.Oct 25 2022, 7:09 PM
VirginiaPoundstone edited projects, added API Platform (Sprint 01); removed API Platform.
JArguello-WMF edited projects, added API Platform (Sprint 02); removed API Platform (Sprint 01).Dec 1 2022, 3:03 PM
JArguello-WMF moved this task from Next Up to In code Review/ Tech Input on the API Platform (Sprint 02) board.
JArguello-WMF subscribed.Dec 1 2022, 3:53 PM

@VirginiaPoundstone How are we doing with this one? Is there anything else you need from @hnowlan? Do you have the traffic info you needed?

JArguello-WMF added a parent task: T285674: Baseline API Usage Metrics.Dec 5 2022, 8:03 PM
JArguello-WMF reassigned this task from hnowlan to VirginiaPoundstone.Dec 8 2022, 5:48 PM
JArguello-WMF added a subscriber: hnowlan.
JArguello-WMF updated the task description. (Show Details)Dec 8 2022, 5:52 PM
hnowlan moved this task from In review to Watching on the Platform Team Workboards (Platform Engineering Reliability) board.Dec 12 2022, 2:35 PM
VirginiaPoundstone updated the task description. (Show Details)Dec 13 2022, 7:40 PM
VirginiaPoundstone mentioned this in T285674: Baseline API Usage Metrics.Dec 15 2022, 3:58 PM
VirginiaPoundstone added a comment.EditedDec 16 2022, 4:07 PM

Current research and tools

RESTbase external overview Grafana: https://grafana.wikimedia.org/d/000000577/restbase-external-overview?orgId=1

https://stats.wikimedia.org/#/all-projects

Code search tool:
https://codesearch.wmcloud.org/search/?q=metrics%2Fpageviews&i=nope&files=&excludeFiles=&repos=
https://codesearch.wmcloud.org/search/?q=metrics%2Funique-devices&i=nope&files=&excludeFiles=&repos=

https://www.mediawiki.org/wiki/Extension:ApiFeatureUsage

API backend summary Grafana:
https://grafana.wikimedia.org/d/000000002/api-backend-summary?orgId=1&refresh=5m

API requests Breakdown Grafana:
https://grafana.wikimedia.org/d/000000559/api-requests-breakdown?orgId=1

https://gerrit.wikimedia.org/g/mediawiki/core/+/0a23ed1b1f0c88ca5853c32a3ec0d3fd0cdbb83b/includes/api/ApiBase.php#1706

https://datahub.wikimedia.org/dataset/urn:li:dataset:(urn:li:dataPlatform:hive,wmf.aqs_hourly,PROD)/Schema?is_lineage_mode=false&schemaFilter=

JArguello-WMF moved this task from Sprint 02 to Sprint 03 on the API Platform board.Jan 10 2023, 6:22 PM
JArguello-WMF edited projects, added API Platform (Sprint 03); removed API Platform (Sprint 02).
JArguello-WMF moved this task from Next Up to In code Review/ Tech Input on the API Platform (Sprint 03) board.Jan 10 2023, 6:31 PM
VirginiaPoundstone moved this task from Sprint 03 to Sprint 05 on the API Platform board.Jan 11 2023, 2:57 AM
VirginiaPoundstone edited projects, added API Platform (Sprint 05); removed API Platform (Sprint 03).
VirginiaPoundstone moved this task from Sprint 05 to Sprint 06 on the API Platform board.Feb 1 2023, 2:33 AM
VirginiaPoundstone edited projects, added API Platform (Sprint 06); removed API Platform (Sprint 05).
VirginiaPoundstone closed this task as Invalid.Mar 7 2023, 8:34 PM
VirginiaPoundstone updated the task description. (Show Details)

Marked invalid: older duplicate ticket: https://phabricator.wikimedia.org/T285674

Aklapper added a comment.Mar 8 2023, 1:55 PM

@VirginiaPoundstone: Feel free to Edit Related Tasks... → Close As Duplicate in the upper right corner in such cases. Thanks!

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