Tracking issue: Code host API usage expectations

Open Issue created 3 years ago by Warren Gifford

Created by: indradhanush

Plan

Create a tool to calculate the expected number of API requests based on the following factors:

Type of code host
Total number of repositories
Total number of organizations and / or teams
Total number of users

Depending on the code host and the feature set supported on each the answer may be different. A tool would be helpful for our customers and customer engineers to know what to expect and detect any deviations from the expectation early.

Code hosts to be supported in the tool:

GitHub

Stretch goals:

Gitlab
Bitbucket

Here is a list of customer issues we have received in the past which justifies the need for such a tool to quickly answer and understand customers' issues and expectations:

While there are multiple sources of API requests, permissions syncing is a big part of it. The planning doc for scaling repository permissions syncing has some existing literature on expected number of API requests when cached permissions syncing is enabled which will be helpful to get started but needs verification.