From 09e15c9949c88c6098dd2d0048d21a571fa6e749 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Fri, 26 Nov 2021 14:19:07 +0100 Subject: [PATCH] Update receiver README.md --- receivers/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/receivers/README.md b/receivers/README.md index cff01cf..7733a94 100644 --- a/receivers/README.md +++ b/receivers/README.md @@ -9,6 +9,21 @@ The base class/configuration is located in `metricReceiver.go`. # Installation Nothing to do, all receivers are pure Go code +# Receiver configuration + +```json + "receiver": { + "type": "nats", + "address": "nats://my-url" + "port" : "4222", + "database": "testcluster" + }, +``` + +## `nats` + +The receiver connects to `address` and `port` and subscribes itself for all messages with topic `database`. The default port is `4222`. + # Contributing own receivers A receiver contains three functions and is derived from the type `Receiver` (in `metricReceiver.go`): * `Init(config ReceiverConfig) error`