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

Update README for receivers

Browse Source
This commit is contained in:
Thomas Roehl 2021-12-21 18:04:01 +01:00
parent ebd96b41e2
commit fc074468c4
1 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
receivers/README.md
View File

@ -1,35 +1,44 @@
This folder contains the receivers for the cc-metric-collector. # CCMetric receivers
# `metricReceiver.go` This folder contains the ReceiveManager and receiver implementations for the cc-metric-collector.
The base class/configuration is located in `metricReceiver.go`.
# Receivers # Configuration
* `natsReceiver.go`: Receives metrics from the Nats transport system in Influx line protocol encoding. The database name is used as subscription subject for the NATS messages. It uses https://github.com/nats-io/nats.go
# Installation The configuration file for the receivers is a list of configurations. The `type` field in each specifies which receiver to initialize.
Nothing to do, all receivers are pure Go code
# Receiver configuration
```json ```json
"receiver": { [
{
"type": "nats", "type": "nats",
"address": "nats://my-url" "address": "nats://my-url",
"port" : "4222", "port" : "4222",
"database": "testcluster" "database": "testcluster"
}, }
]
``` ```
## `nats`
The receiver connects to `address` and `port` and subscribes itself for all messages with topic `database`. The default port is `4222`. ## Type `nats`
```json
{
"type": "nats",
"address": "<nats-URI or hostname>",
"port" : "<portnumber>",
"database": "<subscribe topic>"
}
```
The `nats` receiver subscribes to the topic `database` and listens on `address` and `port` for metrics in the InfluxDB line protocol.
# Contributing own receivers # Contributing own receivers
A receiver contains three functions and is derived from the type `Receiver` (in `metricReceiver.go`): A receiver contains three functions and is derived from the type `Receiver` (in `metricReceiver.go`):
* `Init(config ReceiverConfig) error` * `Init(config ReceiverConfig) error`
* `Start() error` * `Start() error`
* `Close()` * `Close()`
* `Name() string`
* `SetSink(sink chan ccMetric.CCMetric)`
The data structures should be set up in `Init()` like opening a file or server connection. The `Start()` function should either start a go routine or issue some other asynchronous mechanism for receiving metrics. 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 `Start()` function should either start a go routine or issue some other asynchronous mechanism for receiving metrics. The `Close()` function should tear down anything created in `Init()`.
Finally, the receiver needs to be registered in the `metric-collector.go`. There is a list of receivers called `Receivers` which is a map (string -> pointer to receiver). Add a new entry with a descriptive name and the new receiver. Finally, the receiver needs to be registered in the `receiveManager.go`. There is a list of receivers called `AvailableReceivers` which is a map (`receiver_type_string` -> `pointer to Receiver interface`). Add a new entry with a descriptive name and the new receiver.