mirror of
				https://github.com/ClusterCockpit/cc-metric-collector.git
				synced 2025-11-04 02:35:07 +01:00 
			
		
		
		
	Add docs to README
This commit is contained in:
		@@ -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
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user