mirror of
				https://github.com/ClusterCockpit/cc-metric-collector.git
				synced 2025-11-04 02:35:07 +01:00 
			
		
		
		
	Add section about installation and running
This commit is contained in:
		
							
								
								
									
										22
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								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")
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user