From feb9f948f8518ad7659b4037b35cb403cde742db Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Wed, 12 May 2021 14:46:50 +0200 Subject: [PATCH] Add section about installation and running --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index e566ab0..bea783e 100644 --- a/README.md +++ b/README.md @@ -36,4 +36,26 @@ Supported metrics are documented [here](https://github.com/ClusterCockpit/cc-spe All available collectors are listed in the above JSON. There are currently three sinks supported `influxdb`, `nats` and `stdout`. The `interval` defines how often the metrics should be read and send to the sink. The `duration` tells collectors how long one measurement has to take. An example for this is the `likwid` collector which starts the hardware performance counter, waits for `duration` seconds and stops the counters again. For most systems, the `likwid` collector has to do two measurements, thus `interval` must be larger than two times `duration`. +# Installation + +``` +$ git clone git@github.com:ClusterCockpit/cc-metric-collector.git +$ cd cc-metric-collector/collectors +$ edit Makefile (for LIKWID collector) +$ make (downloads LIKWID, builds it as static library and copies all required files for the collector) +$ cd .. +$ go get (requires at least golang 1.13) +$ go build metric-collector +``` + +# Running + +``` +$ ./metric-collector --help +Usage of metric-collector: + -config string + Path to configuration file (default "./config.json") + -log string + Path for logfile (default "stderr") +```