From 1f0c1b4e765aeec3b8ea25d06c8a1c58107f9cc0 Mon Sep 17 00:00:00 2001 From: Thomas Roehl Date: Mon, 29 Mar 2021 15:33:32 +0200 Subject: [PATCH] Update sinks' README --- sinks/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/sinks/README.md b/sinks/README.md index 72b4306..08a1de8 100644 --- a/sinks/README.md +++ b/sinks/README.md @@ -19,3 +19,5 @@ A sink contains three functions and is derived from the type `Sink` (in `sink.go * `Close()` The data structures should be set up in `Init()` like opening a file or server connection. The `Write()` function takes a measurement, tags, fields and a timestamp and writes/sends the data. The `Close()` function should tear down anything created in `Init()`. + +Finally, the sink needs to be registered in the `metric-collector.go`. There is a list of sinks called `Sinks` which is a map (string -> pointer to sink). Add a new entry with a descriptive name and the new sink.