Skip to content

Explain error budgets on the stage group dashboards

Bob Van Landuyt requested to merge bvl-group-error-budget-docs into master

What does this MR do?

This adds a short explanation on the error budgets visible on the stage group dashboards.

It tries to explain in broad strokes how it is calculated, and links to the project documenting the work that still needs to be done.

In gitlab-com/gl-infra/scalability#952 (closed) we'll be updating the handbook with how these budgets will be used organisationally. This aims to tell developers where the number comes from.

In the future (after gitlab-com/gl-infra/scalability#967 (closed) and gitlab-com/gl-infra/scalability#966 (closed)), we should also add how folks can proceed to investigate where a problem lies. But I don't quite know how that's going to go yet. For now, we only have information on a single component (puma).

Related issues

Related to gitlab-com/gl-infra/scalability#945 (closed), budgets added in gitlab-com/runbooks!3388 (merged)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Bob Van Landuyt

Merge request reports

Loading