diff --git a/README.md b/README.md index f819be2..530989e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # cc-metric-collector + A node agent for measuring, processing and forwarding node level metrics. It is part of the ClusterCockpit ecosystem. 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). @@ -20,20 +21,20 @@ There is a main configuration file with basic settings that point to the other c "collectors" : "collectors.json", "receivers" : "receivers.json", "router" : "router.json", - "interval": 10, - "duration": 1 + "interval": "10s", + "duration": "1s" } ``` 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. See the component READMEs for their configuration: + * [`collectors`](./collectors/README.md) * [`sinks`](./sinks/README.md) * [`receivers`](./receivers/README.md) * [`router`](./internal/metricRouter/README.md) - # Installation ``` @@ -43,7 +44,6 @@ $ go get (requires at least golang 1.16) $ make ``` - # Running ``` @@ -56,6 +56,7 @@ Usage of metric-collector: -once Run all collectors only once ``` + # Scenarios The metric collector was designed with flexibility in mind, so it can be used in many scenarios. Here are a few: @@ -93,11 +94,12 @@ flowchart TD ``` # Contributing + The ClusterCockpit ecosystem is designed to be used by different HPC computing centers. Since configurations and setups differ between the centers, the centers likely have to put some work into the cc-metric-collector to gather all desired metrics. You are free to open an issue to request a collector but we would also be happy about PRs. -# Contact +# Contact * [Matrix.org ClusterCockpit General chat](https://matrix.to/#/#clustercockpit-dev:matrix.org) * [Matrix.org ClusterCockpit Development chat](https://matrix.to/#/#clustercockpit:matrix.org)