Verified Commit f1417e65 authored by David Runge's avatar David Runge
Browse files

README: Change openmetrics section into configuration subsection

README.rst:
As the openmetrics section is about how to configure openmetrics and
projects.toml to retrieve data from a build, it is best kept as a
subsection of the configuration section.
parent cb609090
......@@ -59,7 +59,7 @@ The command-line tool ``arch-release-promotion`` makes use of two sources of con
reference in regards to the available options
Openmetrics
===========
-----------
If the upstream project offers an `openmetrics <https://openmetrics.io/>`_
based metrics file, the data from it can be used as additional information in
......@@ -68,7 +68,7 @@ the JSON payload.
The following metrics are considered.
Version metrics
---------------
^^^^^^^^^^^^^^^
Description and version information about e.g. packages can be derived from
``version_info`` metrics of type ``info``, that define a ``name``,
......@@ -97,7 +97,7 @@ The above metrics entry would result in the following JSON representation:
]
Size metrics
------------
^^^^^^^^^^^^
Artifact size information in MebiBytes (MiB) and description can be derived
from ``artifact_bytes`` metrics of type ``gauge``, that define a ``name`` and a
......@@ -126,7 +126,7 @@ The above metrics entry would result in the following JSON representation:
]
Amount metrics
--------------
^^^^^^^^^^^^^^
Information on the amount of something (e.g. packages) and description can be
derived from ``data_count`` metrics of type ``summary``, that define a ``name``
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment