From edd33d58106e65768ae591a7eb4a73b5913ab469 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Wed, 27 Jul 2022 17:45:13 +0200 Subject: [PATCH] Add docs to README --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 530989e..e1f9316 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # cc-metric-collector -A node agent for measuring, processing and forwarding node level metrics. It is part of the ClusterCockpit ecosystem. +A node agent for measuring, processing and forwarding node level metrics. It is part of the [ClusterCockpit ecosystem](./docs/introduction.md). The metric collector sends (and receives) metric in the [InfluxDB line protocol](https://docs.influxdata.com/influxdb/cloud/reference/syntax/line-protocol/) as it provides flexibility while providing a separation between tags (like index columns in relational databases) and fields (like data columns). @@ -26,7 +26,7 @@ There is a main configuration file with basic settings that point to the other c } ``` -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. This is important for some collectors, like the `likwid` collector. +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. This is important for some collectors, like the `likwid` collector. For more information, see [here](./docs/configuration.md). See the component READMEs for their configuration: @@ -44,6 +44,8 @@ $ go get (requires at least golang 1.16) $ make ``` +For more information, see [here](./docs/building.md). + # Running ```