From c3ad5d47a8b93e02a7f20cbf216d97447f995ae4 Mon Sep 17 00:00:00 2001 From: flaviostutz Date: Sun, 4 Oct 2020 04:40:04 -0300 Subject: [PATCH] updating readme for distribution procedures --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c025db7..a12284b 100644 --- a/README.md +++ b/README.md @@ -29,3 +29,13 @@ promgrep_thing_count 3 * "--gauge [metric_name]@[regex]" defines regex rules for extracting metrics from input stream and expose it as [Prometheus Gauges](https://prometheus.io/docs/concepts/metric_types/#gauge). The regex must have a group match for a number ([0-9\\.]+) as it will be used as the value in metrics. If there is another regex group that does not resolve to a number, the matched contents will be used as "label" value in metric. * "--output (none|match|all)" determines what will be written to stdout. 'none' for silence, 'match' for lines matches by regex rules or 'all' to input to output passthrough. Defaults to 'match' + +## Distribution build + +Use docker-compose.yml from this repo + +Run `docker-compose up --build` + +Get distribution packages at workspace dir /dist + +Copy these files to Github under specific "Release" version