Documentation for Delivery Metrics
Context
Delivery developed an in-house solution Delivery metrics to handle delivery team's metrics. It is a service that implements a specialized Prometheus Pushgateway designed to be used from our CI jobs, as well as an API scraper for publishing metrics based on our pipelines. It can easily keep track of histograms by implementing an HTTP API around Prometheus metrics.
Problem
Currently, Delivery Metrics documentation is minimal, mainly contained on the https://gitlab.com/gitlab-org/release-tools/-/tree/master/metrics README and code itself. Some information might be scattered in meeting agendas or slack messages.
We currently are missing an SSOT for Delivery Metrics documentation that gathers all the knowledge of the service, how it works, how it is run, how it is deployed, and any architecture graph of the various interactions.
Exit Criteria
Gather information about Delivery Metrics architecture, runtime requirements, and dependencies and create an SSOT for the documentation of this component.