ClusterCockpit/cc-metric-store
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-store.git synced 2025-07-22 21:01:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation, change config format

Browse Source
This commit is contained in:
Lou Knauer
2022-02-04 08:46:14 +01:00
parent 8fb2557f97
commit 83d1cb2a98
5 changed files with 44 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -74,15 +74,17 @@ All durations are specified as string that will be parsed [like this](https://pk
- `"sum"` means that values from the child levels are summed up for the parent level
- `"avg"` means that values from the child levels are averaged for the parent level
- `scope`: Unused at the moment, should be something like `"node"`, `"socket"` or `"hwthread"`
- `nats`: Url of NATS.io server (The `updates` channel will be subscribed for metrics), example: "nats://localhost:4222"
- `http-api-address`: Where to listen via HTTP, example: ":8080"
- `nats`:
- `address`: Url of NATS.io server, example: "nats://localhost:4222"
- `http-api`:
- `address`: Address to bind to, for example `0.0.0.0:8080`
- `https-cert-file` and `https-key-file`: Optional, if provided enable HTTPS using those files as certificate/key.
- `jwt-public-key`: Base64 encoded string, use this to verify requests to the HTTP API
- `retention-on-memory`: Keep all values in memory for at least that amount of time
- `checkpoints`:
- `interval`: Do checkpoints every X seconds/minutes/hours
- `directory`: Path to a directory
- `restore`: After a restart, load the last X seconds/minutes/hours of data back into memory
- `archive`:
- `interval`: Move and compress all checkpoints not needed anymore every X seconds/minutes/hours
- `directory`: Path to a directory