Baseline API Usage Metrics
Open, HighPublic
Actions

Assigned To

Authored By

	• sdkim
	Jun 28 2021, 1:21 PM

Description

User Story

As the API Platform PM,

I want to understand how existing APIs are being used and by whom

so that I can make decisions on which services to migrate when

T324231: Add monitoring of API endpoints for API gateway
T318805: Collate various API Catalogs
T288667: Create Dashboards for AQS 2.0
T280087: HARDEN API Gateway. Establish consistent strategy for namespaces in the API gateway
T290772: Make logging adhere to common logging schema
T320537: <spike> Usage and traffic data for WMF APIs

Success Criteria

I can see API usage metrics in a data visualization tool for the following dimensions:
- User Agent
- HTTP Method
- HTTP Status
- URI Path
- URI Query
- Content Type
- Response Size
- Any additional identifying data to determine how many individual clients/callers we have, what APIs they use, and how much they use them

References

Product Analytics's Tips on Queries: https://phabricator.wikimedia.org/T284579#7151481

Related Objects
Search...

Status	Assigned	Task
Open	None	T317673 <API Platform> Documentation for API Platform Value Stream Team
Resolved	VirginiaPoundstone	T317677 Update API Platform Phab description and links
Declined	VirginiaPoundstone	T317678 Create MediaWiki Knowledge Hub Wiki for API Platform Team
Open	None	T319330 Document current WMF service usage across the WMF ecosystem
In Progress	None	T306043 <API Platform> API Gateway MVP
Open	None	T326697 Harden API Gateway in preparation for RESTbase deprecation service migration
Resolved	VirginiaPoundstone	T326698 Write One-Pager PRD for Harden API Gateway
Open	pmiazga	T326701 Draft Diagrams of current state of API ecosystem
Declined	VirginiaPoundstone	T318805 Collate various API Catalogs
Resolved	• EChetty	T285561 API Usage Metrics
Open	None	T333217 Service & API product monitoring instrumentation
Open	VirginiaPoundstone	T285674 Baseline API Usage Metrics
Invalid	VirginiaPoundstone	T320537 <spike> Usage and traffic data for WMF APIs

Event Timeline

• sdkim created this task.Jun 28 2021, 1:21 PM

• sdkim edited projects, added API Platform; removed Epic, API Platform (API Platform Roadmap).Jun 28 2021, 5:15 PM

• sdkim closed this task as Invalid.Sep 2 2021, 3:15 PM

• sdkim reopened this task as Open.

@BPirkle point of contact with SRE on requesting metrics to maybe inform this

April 14, 2022

some of the information may be PII so will need to be taken into consideration

@DAbad to Shift this ticket to focus on future-state logging capabilities coming out of the API Gateway

VirginiaPoundstone moved this task from Incoming to Needs Grooming on the API Platform board.Oct 25 2022, 2:54 PM

VirginiaPoundstone moved this task from Needs Grooming to Must do now on the API Platform board.Oct 25 2022, 7:10 PM

VirginiaPoundstone added a parent task: T318805: Collate various API Catalogs.Oct 25 2022, 7:58 PM

VirginiaPoundstone moved this task from Must do now to Sprint 02 on the API Platform board.Dec 1 2022, 10:51 PM

VirginiaPoundstone edited projects, added API Platform (Sprint 02); removed API Platform.

VirginiaPoundstone triaged this task as High priority.Dec 3 2022, 7:53 AM

JArguello-WMF added a subtask: T320537: <spike> Usage and traffic data for WMF APIs.Dec 5 2022, 8:03 PM

Open patch https://gerrit.wikimedia.org/r/c/mediawiki/core/ /864833 is related. It collects only some of the suggested data (path, method, status) and only for MediaWiki REST API. (Path is without parameter replacement, so no risk of PII exposure)

VirginiaPoundstone claimed this task.Dec 15 2022, 3:48 PM

VirginiaPoundstone moved this task from Next Up to In Progress on the API Platform (Sprint 02) board.

VirginiaPoundstone updated the task description. (Show Details)Dec 15 2022, 3:58 PM

VirginiaPoundstone updated the task description. (Show Details)Dec 16 2022, 4:00 PM

VirginiaPoundstone moved this task from In Progress to Blocked/Paused on the API Platform (Sprint 02) board.Jan 9 2023, 7:21 PM

JArguello-WMF moved this task from Sprint 02 to Could do Next on the API Platform board.Jan 10 2023, 6:14 PM

JArguello-WMF edited projects, added API Platform; removed API Platform (Sprint 02).

VirginiaPoundstone added a parent task: T326701: Draft Diagrams of current state of API ecosystem.Jan 11 2023, 6:36 PM

VirginiaPoundstone closed subtask T320537: <spike> Usage and traffic data for WMF APIs as Invalid.Mar 7 2023, 8:34 PM

VirginiaPoundstone mentioned this in T320537: <spike> Usage and traffic data for WMF APIs.

JArguello-WMF moved this task from Could do Next to Incoming on the API Platform board.Apr 10 2023, 4:16 PM

JArguello-WMF moved this task from Incoming to Needs Grooming on the API Platform board.Apr 18 2023, 4:16 PM