Additional comments

receivers/metricReceiver.go

@@ -8,6 +8,7 @@ type defaultReceiverConfig struct {
 	Type string `json:"type"`
 }
 
+// Receiver configuration: Listen address, port
 type ReceiverConfig struct {
 	Addr         string `json:"address"`
 	Port         string `json:"port"`
@@ -23,15 +24,17 @@ type receiver struct {
 
 type Receiver interface {
 	Start()
-	Close()
-	Name() string
-	SetSink(sink chan lp.CCMetric)
+	Close()                        // Close / finish metric receiver
+	Name() string                  // Name of the metric receiver
+	SetSink(sink chan lp.CCMetric) // Set sink channel
 }
 
+// Name returns the name of the metric receiver
 func (r *receiver) Name() string {
 	return r.name
 }
 
+// SetSink set the sink channel
 func (r *receiver) SetSink(sink chan lp.CCMetric) {
 	r.sink = sink
 }

receivers/sampleReceiver.go

@@ -7,6 +7,7 @@ import (
 	cclog "github.com/ClusterCockpit/cc-metric-collector/internal/ccLogger"
 )
 
+// SampleReceiver configuration: receiver type, listen address, port
 type SampleReceiverConfig struct {
 	Type string `json:"type"`
 	Addr string `json:"address"`
@@ -24,6 +25,10 @@ type SampleReceiver struct {
 	// wg   sync.WaitGroup
 }
 
+// Implement functions required for Receiver interface
+// Start(), Close()
+// See: metricReceiver.go
+
 func (r *SampleReceiver) Start() {
 	cclog.ComponentDebug(r.name, "START")
 
@@ -44,6 +49,7 @@ func (r *SampleReceiver) Start() {
 	// }()
 }
 
+// Close receiver: close network connection, close files, close libraries, ...
 func (r *SampleReceiver) Close() {
 	cclog.ComponentDebug(r.name, "CLOSE")
 
@@ -54,13 +60,21 @@ func (r *SampleReceiver) Close() {
 	// r.wg.Wait()
 }
 
+// New function to create a new instance of the receiver
+// Initialize the receiver by giving it a name and reading in the config JSON
 func NewSampleReceiver(name string, config json.RawMessage) (Receiver, error) {
 	r := new(SampleReceiver)
-	r.name = fmt.Sprintf("HttpReceiver(%s)", name)
+
+	// Set name of SampleReceiver
+	// The name should be chosen in such a way that different instances of SampleReceiver can be distinguished
+	r.name = fmt.Sprintf("SampleReceiver(%s)", name)
 
 	// Set static information
 	r.meta = map[string]string{"source": r.name}
 
+	// Set defaults in r.config
+	// Allow overwriting these defaults by reading config JSON
+
 	// Read the sample receiver specific JSON config
 	if len(config) > 0 {
 		err := json.Unmarshal(config, &r.config)