From 308ee13a10ad81eb9ad9088299080bb14e4bd0a7 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Tue, 18 May 2021 15:39:22 +0200 Subject: [PATCH] Add README for receivers --- receivers/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 receivers/README.md diff --git a/receivers/README.md b/receivers/README.md new file mode 100644 index 0000000..cff01cf --- /dev/null +++ b/receivers/README.md @@ -0,0 +1,20 @@ +This folder contains the receivers for the cc-metric-collector. + +# `metricReceiver.go` +The base class/configuration is located in `metricReceiver.go`. + +# Receivers +* `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 +Nothing to do, all receivers are pure Go code + +# Contributing own receivers +A receiver contains three functions and is derived from the type `Receiver` (in `metricReceiver.go`): +* `Init(config ReceiverConfig) error` +* `Start() error` +* `Close()` + +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.