ClusterCockpit/cc-metric-collector
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-collector.git synced 2025-04-06 13:35:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'main' into develop

Browse Source
This commit is contained in:
Thomas Gruber 2023-12-04 11:32:17 +01:00 committed by GitHub
commit d21ffdbede
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sinks/influxAsyncSink.md
View File

@ -9,7 +9,6 @@ The `influxasync` sink uses the official [InfluxDB golang client](https://pkg.go
{ {
"<name>": { "<name>": {
"type": "influxasync", "type": "influxasync",
"meta_as_tags" : true,
"database" : "mymetrics", "database" : "mymetrics",
"host": "dbhost.example.com", "host": "dbhost.example.com",
"port": "4222", "port": "4222",
@ -21,13 +20,13 @@ The `influxasync` sink uses the official [InfluxDB golang client](https://pkg.go
"retry_interval" : "1s", "retry_interval" : "1s",
"retry_exponential_base" : 2, "retry_exponential_base" : 2,
"max_retries": 20, "max_retries": 20,
"max_retry_time" : "168h" "max_retry_time" : "168h",
"meta_as_tags" : [],
} }
} }
``` ```
- `type`: makes the sink an `influxdb` sink - `type`: makes the sink an `influxdb` sink
- `meta_as_tags`: print all meta information as tags in the output (optional)
- `database`: All metrics are written to this bucket - `database`: All metrics are written to this bucket
- `host`: Hostname of the InfluxDB database server - `host`: Hostname of the InfluxDB database server
- `port`: Portnumber (as string) of the InfluxDB database server - `port`: Portnumber (as string) of the InfluxDB database server
@ -40,5 +39,6 @@ The `influxasync` sink uses the official [InfluxDB golang client](https://pkg.go
- `retry_exponential_base`: The retry interval is exponentially increased with this base, default 2 - `retry_exponential_base`: The retry interval is exponentially increased with this base, default 2
- `max_retries`: Maximal number of retry attempts - `max_retries`: Maximal number of retry attempts
- `max_retry_time`: Maximal time to retry failed writes, default 168h (one week) - `max_retry_time`: Maximal time to retry failed writes, default 168h (one week)
- `meta_as_tags`: move meta information keys to tags (optional)
For information about the calculation of the retry interval settings, see [offical influxdb-client-go documentation](https://github.com/influxdata/influxdb-client-go#handling-of-failed-async-writes) For information about the calculation of the retry interval settings, see [offical influxdb-client-go documentation](https://github.com/influxdata/influxdb-client-go#handling-of-failed-async-writes)

6
sinks/influxSink.md
View File

@ -8,7 +8,6 @@ The `influxdb` sink uses the official [InfluxDB golang client](https://pkg.go.de
{ {
"<name>": { "<name>": {
"type": "influxdb", "type": "influxdb",
"meta_as_tags" : true,
"database" : "mymetrics", "database" : "mymetrics",
"host": "dbhost.example.com", "host": "dbhost.example.com",
"port": "4222", "port": "4222",
@ -19,6 +18,7 @@ The `influxdb` sink uses the official [InfluxDB golang client](https://pkg.go.de
"flush_delay" : "1s", "flush_delay" : "1s",
"batch_size" : 1000, "batch_size" : 1000,
"use_gzip": true "use_gzip": true
"meta_as_tags" : [],
} }
} }
``` ```
@ -36,7 +36,9 @@ The `influxdb` sink uses the official [InfluxDB golang client](https://pkg.go.de
- `batch_size`: Maximal batch size. If `batch_size` is reached before the end of `flush_delay`, the metrics are sent without further delay - `batch_size`: Maximal batch size. If `batch_size` is reached before the end of `flush_delay`, the metrics are sent without further delay
Influx client options: Influx client options:
=======
- `batch_size`: Maximal batch size
- `meta_as_tags`: move meta information keys to tags (optional)
- `http_request_timeout`: HTTP request timeout - `http_request_timeout`: HTTP request timeout
- `retry_interval`: retry interval - `retry_interval`: retry interval
- `max_retry_interval`: maximum delay between each retry attempt - `max_retry_interval`: maximum delay between each retry attempt

6
sinks/natsSink.md
View File

@ -8,20 +8,20 @@ The `nats` sink publishes all metrics into a NATS network. The publishing key is
{ {
"<name>": { "<name>": {
"type": "nats", "type": "nats",
"meta_as_tags" : true,
"database" : "mymetrics", "database" : "mymetrics",
"host": "dbhost.example.com", "host": "dbhost.example.com",
"port": "4222", "port": "4222",
"user": "exampleuser", "user": "exampleuser",
"password" : "examplepw" "password" : "examplepw",
"meta_as_tags" : [],
} }
} }
``` ```
- `type`: makes the sink an `nats` sink - `type`: makes the sink an `nats` sink
- `meta_as_tags`: print all meta information as tags in the output (optional)
- `database`: All metrics are published with this subject - `database`: All metrics are published with this subject
- `host`: Hostname of the NATS server - `host`: Hostname of the NATS server
- `port`: Port number (as string) of the NATS server - `port`: Port number (as string) of the NATS server
- `user`: Username for basic authentication - `user`: Username for basic authentication
- `password`: Password for basic authentication - `password`: Password for basic authentication
- `meta_as_tags`: print all meta information as tags in the output (optional)

4
sinks/stdoutSink.md
View File

@ -9,14 +9,14 @@ The `stdout` sink is the most simple sink provided by cc-metric-collector. It wr
{ {
"<name>": { "<name>": {
"type": "stdout", "type": "stdout",
"meta_as_tags" : true, "meta_as_tags" : [],
"output_file" : "mylogfile.log" "output_file" : "mylogfile.log"
} }
} }
``` ```
- `type`: makes the sink an `stdout` sink - `type`: makes the sink an `stdout` sink
- `meta_as_tags`: print all meta information as tags in the output (optional) - `meta_as_tags`: print meta information as tags in the output (optional)
- `output_file`: Write all data to the selected file (optional). There are two 'special' files: `stdout` and `stderr`. If this option is not provided, the default value is `stdout` - `output_file`: Write all data to the selected file (optional). There are two 'special' files: `stdout` and `stderr`. If this option is not provided, the default value is `stdout`