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

Add Prometheus sink to README

Browse Source
This commit is contained in:
Thomas Roehl 2021-05-29 03:46:41 +02:00
parent 02e22457a2
commit 0e560f1076
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
sinks/README.md
View File

@ -7,6 +7,7 @@ The base class/configuration is located in `metricSink.go`.
* `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, database name and organisation are in the global configuration file. It uses the v2 API of Influx.
* `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.
* `prometheusSink.go`: Provides an HTTP endpoint which can be queried by the Prometheus monitoring system. It uses the Golang package provided by the Prometheus developers. Configuration for the listen address (host) and port can be defined in the glibal configuration file. All other sink options are not used.
# Installation
Nothing to do, all sinks are pure Go code