Add documentation

sinks/sinkManager.go

@@ -9,21 +9,24 @@ import (
 	lp "github.com/ClusterCockpit/cc-metric-collector/internal/ccMetric"
 )
 
+// Map of all available sinks
 var AvailableSinks = map[string]Sink{
-	"influxdb": &InfluxSink{},
-	"stdout":   &StdoutSink{},
-	"nats":     &NatsSink{},
-	"http":     &HttpSink{},
+	"influxdb": new(InfluxSink),
+	"stdout":   new(StdoutSink),
+	"nats":     new(NatsSink),
+	"http":     new(HttpSink),
 }
 
+// Metric collector manager data structure
 type sinkManager struct {
-	input   chan lp.CCMetric
-	outputs []Sink
-	done    chan bool
-	wg      *sync.WaitGroup
-	config  []sinkConfig
+	input   chan lp.CCMetric // input channel
+	outputs []Sink           // List of sinks to use
+	done    chan bool        // channel to finish / stop metric sink manager
+	wg      *sync.WaitGroup  // wait group for all goroutines in cc-metric-collector
+	config  []sinkConfig     // json encoded config for sink manager
 }
 
+// Sink manager access functions
 type SinkManager interface {
 	Init(wg *sync.WaitGroup, sinkConfigFile string) error
 	AddInput(input chan lp.CCMetric)
@@ -38,6 +41,8 @@ func (sm *sinkManager) Init(wg *sync.WaitGroup, sinkConfigFile string) error {
 	sm.done = make(chan bool)
 	sm.wg = wg
 	sm.config = make([]sinkConfig, 0)
+
+	// Read sink config file
 	if len(sinkConfigFile) > 0 {
 		configFile, err := os.Open(sinkConfigFile)
 		if err != nil {
@@ -63,27 +68,36 @@ func (sm *sinkManager) Init(wg *sync.WaitGroup, sinkConfigFile string) error {
 }
 
 func (sm *sinkManager) Start() {
-	sm.wg.Add(1)
 	batchcount := 20
+
+	sm.wg.Add(1)
 	go func() {
+		defer sm.wg.Done()
+
+		// Sink manager is done
 		done := func() {
 			for _, s := range sm.outputs {
 				s.Flush()
 				s.Close()
 			}
-			sm.wg.Done()
+
 			cclog.ComponentDebug("SinkManager", "DONE")
 		}
+
 		for {
 			select {
 			case <-sm.done:
 				done()
 				return
+
 			case p := <-sm.input:
+				// Send received metric to all outputs
 				cclog.ComponentDebug("SinkManager", "WRITE", p)
 				for _, s := range sm.outputs {
 					s.Write(p)
 				}
+
+				// Flush all outputs
 				if batchcount == 0 {
 					cclog.ComponentDebug("SinkManager", "FLUSH")
 					for _, s := range sm.outputs {
@@ -95,9 +109,12 @@ func (sm *sinkManager) Start() {
 			}
 		}
 	}()
+
+	// Sink manager is started
 	cclog.ComponentDebug("SinkManager", "STARTED")
 }
 
+// AddInput adds the input channel to the sink manager
 func (sm *sinkManager) AddInput(input chan lp.CCMetric) {
 	sm.input = input
 }
@@ -128,11 +145,13 @@ func (sm *sinkManager) AddOutput(rawConfig json.RawMessage) error {
 	return nil
 }
 
+// Close finishes / stops the sink manager
 func (sm *sinkManager) Close() {
 	cclog.ComponentDebug("SinkManager", "CLOSE")
 	sm.done <- true
 }
 
+// New creates a new initialized sink manager
 func New(wg *sync.WaitGroup, sinkConfigFile string) (SinkManager, error) {
 	sm := &sinkManager{}
 	err := sm.Init(wg, sinkConfigFile)