Page MenuHomePhabricator

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

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

Event Timeline

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

VirginiaPoundstone triaged this task as Medium priority.
VirginiaPoundstone moved this task from Must do now to Backlog on the API Platform board.

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 How are we doing with this one? Is there anything else you need from @hnowlan? Do you have the traffic info you needed?

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