Skip to content

Add Prometheus & `topology` docs for Usage Ping

Matthias Käppler requested to merge 220143-topology-usage-ping-docs into master

What does this MR do?

This adds admin and developer documentation for a new Usage Ping element: topology.

I also added two new sections:

  • one about querying Prometheus as part of Usage Ping
  • one about testing your changes that involve data pulled from Prometheus

Related issues

Closes #220143 (closed)

Epic: &3209

MRs:

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

  • Optional: 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.

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 Russell Dickenson

Merge request reports