ClusterCockpit/cc-metric-collector
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-collector.git synced 2025-12-20 14:16:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README and build docu

Browse Source
This commit is contained in:
Thomas Roehl
2025-12-19 17:32:01 +01:00
parent f964a9d065
commit 6b10797556
2 changed files with 23 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -32,13 +32,15 @@ There is a main configuration file with basic settings that point to the other c
``` json ``` json
{ {
"sinks": "sinks.json", "sinks-file": "sinks.json",
"collectors" : "collectors.json", "collectors-file" : "collectors.json",
"receivers" : "receivers.json", "receivers-file" : "receivers.json",
"router" : "router.json", "router-file" : "router.json",
"main": {
"interval": "10s", "interval": "10s",
"duration": "1s" "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. For more information, see [here](./docs/configuration.md). 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).
@@ -52,11 +54,14 @@ See the component READMEs for their configuration:
# Installation # Installation
Dependecies:
- golang
- hwloc
``` ```
$ git clone git@github.com:ClusterCockpit/cc-metric-collector.git $ git clone git@github.com:ClusterCockpit/cc-metric-collector.git
$ export CGO_LDFLAGS="-L/path/to/hwloc/lib/dir"
$ make (downloads LIKWID, builds it as static library with 'direct' accessmode and copies all required files for the collector) $ make (downloads LIKWID, builds it as static library with 'direct' accessmode and copies all required files for the collector)
$ go get (requires at least golang 1.16)
$ make
``` ```
For more information, see [here](./docs/building.md). For more information, see [here](./docs/building.md).

11
docs/building.md
View File

@@ -1,6 +1,15 @@
# Building the cc-metric-collector # Building the cc-metric-collector
In most cases, a simple `make` in the main folder is enough to get a `cc-metric-collector` binary. It is basically a `go build` but some collectors require additional tasks. There is currently no Golang interface to LIKWID, so it uses `cgo` to create bindings but `cgo` requires the LIKWID header files. Therefore, it checks whether LIKWID is installed and if not it downloads LIKWID and copies the headers. Dependencies:
- golang
- hwloc
```
$ export CGO_LDFLAGS="-L/path/to/hwloc/lib/dir"
$ make
```
In most cases, a simple `make` in the main folder is enough to get a `cc-metric-collector` binary as long as hwloc is in default locations. It is basically a `go build` but some collectors require additional tasks. There is currently no Golang interface to LIKWID, so it uses `cgo` to create bindings but `cgo` requires the LIKWID header files. Therefore, it checks whether LIKWID is installed and if not it downloads LIKWID and copies the headers.
## System integration ## System integration