mirror of
https://github.com/ClusterCockpit/cc-metric-collector.git
synced 2024-12-25 15:09:05 +01:00
Update README for sinks and rename file
This commit is contained in:
parent
9a205717f7
commit
2e9cec5488
@ -1,10 +1,9 @@
|
||||
This folder contains the sinks for the cc-metric-collector.
|
||||
|
||||
# `sink.go`
|
||||
The base class/configuration is located in `sink.go`.
|
||||
# `metricSink.go`
|
||||
The base class/configuration is located in `metricSink.go`.
|
||||
|
||||
# Sinks
|
||||
There are currently two sinks shipped with the cc-metric-collector:
|
||||
* `stdoutSink.go`: Writes all metrics to `stdout` in InfluxDB line protocol. The sink does not use https://github.com/influxdata/line-protocol to reduce the executed code for debugging
|
||||
* `influxSink.go`: Writes all metrics to an InfluxDB database instance using a blocking writer. It uses https://github.com/influxdata/influxdb-client-go . Configuration for the server, port, user, password and database name are in the global configuration file
|
||||
* `natsSink.go`: Sends all metrics to an NATS server using the InfluxDB line protocol as encoding. It uses https://github.com/nats-io/nats.go . Configuration for the server, port, user, password and database name are in the global configuration file. The database name is used as subject for the NATS messages.
|
||||
@ -13,8 +12,8 @@ There are currently two sinks shipped with the cc-metric-collector:
|
||||
Nothing to do, all sinks are pure Go code
|
||||
|
||||
# Contributing own sinks
|
||||
A sink contains three functions and is derived from the type `Sink` (in `sink.go`):
|
||||
* `Init(host string, port string, user string, password string, database string) error`
|
||||
A sink contains three functions and is derived from the type `Sink` (in `metricSink.go`):
|
||||
* `Init(config SinkConfig) error`
|
||||
* `Write(measurement string, tags map[string]string, fields map[string]interface{}, t time.Time) error`
|
||||
* `Close()`
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user