The goal of this project is to make it easy to track metrics.
Just create a .k-pi.dist.yaml
file following the following pattern:
---
reports:
<report-name>:
storage:
<storage-type>: <storage-config>
If a report is compiled in one of the configured storages
, then compiled
values can be added to it.
Add total metrics values to compiled report. Expected value is the label of the metric.
---
reports:
<report-name>:
extras:
total: The total
# ...
Customize metrics colors on compiled reports. The expected value is a key-value with the metric label as key, and a hex color code as value.
---
reports:
<report-name>:
colors:
The total: "#CDCDCD"
Metric 1: "#F2D6B1"
# ...
Allows you to specify the precision to which metrics will be rounded. The
default setting is 2
.
Allows you to configure the way in which the metrics recorded in the report are stored.
Integration with Github discussions.
Url of the target discussion (e.g. KnpLabs/K-pi#1).
Configure how metrics evolution is notified.
Integration with Github status on pull-requests.
For all examples, please refer to the configuration file
.k-pi.dist.yaml
.
The goal of this metric is to count the number of alerts from dependabot's Github API and project them onto a graph to track their evolution over time.
In the configuration file, you can see that the configured storage is
github-discussion
. It means that data will be stored in the discussion but
also projected onto a graph.