ClusterCockpit/cc-metric-collector
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-collector.git synced 2024-12-26 15:29:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update sink README.md

Browse Source
This commit is contained in:
Thomas Roehl 2021-11-26 14:18:59 +01:00
parent 24bf9590ee
commit 32d5a5b98f
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
sinks/README.md
View File

@ -21,10 +21,12 @@ A sink contains three functions and is derived from the type `Sink` (in `metricS
The data structures should be set up in `Init()` like opening a file or server connection. The `Write()` function takes a measurement, tags, fields and a timestamp and writes/sends the data. For non-blocking sinks, the `Flush()` method tells the sink to drain its internal buffers. The `Close()` function should tear down anything created in `Init()`. The data structures should be set up in `Init()` like opening a file or server connection. The `Write()` function takes a measurement, tags, fields and a timestamp and writes/sends the data. For non-blocking sinks, the `Flush()` method tells the sink to drain its internal buffers. The `Close()` function should tear down anything created in `Init()`.
Finally, the sink needs to be registered in the `metric-collector.go`. There is a list of sinks called `Sinks` which is a map (sink_type_string -> pointer to sink). Add a new entry with a descriptive name and the new sink. Afterwards, it can be configured in the main configuration file at `type`: Finally, the sink needs to be registered in the `metric-collector.go`. There is a list of sinks called `Sinks` which is a map (sink_type_string -> pointer to sink). Add a new entry with a descriptive name and the new sink.
# Sink configuration
```json ```json
{
"sink": { "sink": {
"user": "testuser", "user": "testuser",
"password": "testpass", "password": "testpass",
@ -35,14 +37,12 @@ Finally, the sink needs to be registered in the `metric-collector.go`. There is
"ssl": false "ssl": false
"type": "stdout" "type": "stdout"
} }
}
``` ```
# Sink configuration
## `stdoutSink` ## `stdout`
When configuring `type = stdout`, all metrics are printed to stdout. No further configuration is required or touched, so you can leave your other-sink-config in there and just change the `type` for debugging purposes When configuring `type = stdout`, all metrics are printed to stdout. No further configuration is required or touched, so you can leave your other-sink-config in there and just change the `type` for debugging purposes
## `influxSink` ## `influxdb`
The InfluxDB sink uses blocking write operations to write to an InfluxDB database using the v2 API. It uses the following configuration options: The InfluxDB sink uses blocking write operations to write to an InfluxDB database using the v2 API. It uses the following configuration options:
* `host`: Hostname of the database instance * `host`: Hostname of the database instance
* `port`: Portnumber (as string) of the database * `port`: Portnumber (as string) of the database
@ -52,13 +52,13 @@ The InfluxDB sink uses blocking write operations to write to an InfluxDB databas
* `user`: Although the v2 API uses API keys instead of username and password, this field can be used if the sink should authentificate with `username:password`. If you want to use an API key, leave this field empty. * `user`: Although the v2 API uses API keys instead of username and password, this field can be used if the sink should authentificate with `username:password`. If you want to use an API key, leave this field empty.
* `password`: API key for the InfluxDB v2 API or password if `user` is set * `password`: API key for the InfluxDB v2 API or password if `user` is set
## `natsSink` ## `nats`
* `host`: Hostname of the NATS server * `host`: Hostname of the NATS server
* `port`: Portnumber (as string) of the NATS server * `port`: Portnumber (as string) of the NATS server
* `user`: Username for authentification in the NATS transport system * `user`: Username for authentification in the NATS transport system
* `password`: Password for authentification in the NATS transport system * `password`: Password for authentification in the NATS transport system
## `httpSink` ## `http`
* `host`: Hostname of the HTTP server * `host`: Hostname of the HTTP server
* `port`: Portnumber (as string) of the HTTP server * `port`: Portnumber (as string) of the HTTP server
* `database`: Endpoint to write to. HTTP POST requests are performed on `http://<host>:<port>/<database>` * `database`: Endpoint to write to. HTTP POST requests are performed on `http://<host>:<port>/<database>`