cc-metric-collector/sinks
Thomas Gruber 57629a2e0a
Meta to tags list and map for sinks (#63)
* Change ccMetric->Influx functions

* Use a meta_as_tags string list in config but create a lookup map afterwards

* Add meta as tag logic to sampleSink
2022-03-15 16:16:26 +01:00
..
gangliaCommon.go Use old metric name in Ganglia if rename has happened in the router (#60) 2022-03-11 13:44:32 +01:00
gangliaSink.go Use old metric name in Ganglia if rename has happened in the router (#60) 2022-03-11 13:44:32 +01:00
gangliaSink.md Sink specific configuration maps (#25) 2022-02-04 18:12:24 +01:00
httpSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
httpSink.md Automatically flush batched writes in the HTTP sink (#31) 2022-02-10 13:12:32 +01:00
influxAsyncSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
influxAsyncSink.md Add config options for retry intervals of InfluxDB clients (#59) 2022-03-11 13:43:03 +01:00
influxSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
influxSink.md Add config options for retry intervals of InfluxDB clients (#59) 2022-03-11 13:43:03 +01:00
libgangliaSink.go Use old metric name in Ganglia if rename has happened in the router (#60) 2022-03-11 13:44:32 +01:00
libgangliaSink.md Ganglia sink using libganglia.so directly (#35) 2022-02-16 18:33:46 +01:00
metricSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
natsSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
natsSink.md Sink specific configuration maps (#25) 2022-02-04 18:12:24 +01:00
prometheusSink.go Add sink for Prometheus monitoring system (#46) 2022-02-25 14:33:20 +01:00
prometheusSink.md Add sink for Prometheus monitoring system (#46) 2022-02-25 14:33:20 +01:00
README.md Add sink for Prometheus monitoring system (#46) 2022-02-25 14:33:20 +01:00
sampleSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
sinkManager.go Use new sink instances to allow multiple of same sink type 2022-02-22 16:15:25 +01:00
stdoutSink.go Meta to tags list and map for sinks (#63) 2022-03-15 16:16:26 +01:00
stdoutSink.md Sink specific configuration maps (#25) 2022-02-04 18:12:24 +01:00

CCMetric sinks

This folder contains the SinkManager and sink implementations for the cc-metric-collector.

Available sinks:

Configuration

The configuration file for the sinks is a list of configurations. The type field in each specifies which sink to initialize.

[
  "mystdout" : {
    "type" : "stdout",
    "meta_as_tags" : false
  },
  "metricstore" : {
    "type" : "http",
    "host" : "localhost",
    "port" : "4123",
    "database" : "ccmetric",
    "password" : "<jwt token>"
  }
]

Contributing own sinks

A sink contains five functions and is derived from the type sink:

  • Init(name string, config json.RawMessage) error
  • Write(point CCMetric) error
  • Flush() error
  • Close()
  • New<Typename>(name string, config json.RawMessage) (Sink, error) (calls the Init() function)

The data structures should be set up in Init() like opening a file or server connection. The Write() function writes/sends the data. For non-blocking sinks, the Flush() method tells the sink to drain its internal buffers. The Close() function should tear down anything created in Init().

Finally, the sink needs to be registered in the sinkManager.go. There is a list of sinks called AvailableSinks which is a map (sink_type_string -> pointer to sink interface). Add a new entry with a descriptive name and the new sink.

Sample sink

package sinks

import (
	"encoding/json"
	"log"
	lp "github.com/ClusterCockpit/cc-metric-collector/internal/ccMetric"
)

type SampleSinkConfig struct {
	defaultSinkConfig  // defines JSON tags for 'name' and 'meta_as_tags'
}

type SampleSink struct {
	sink              // declarate 'name' and 'meta_as_tags'
	config StdoutSinkConfig // entry point to the SampleSinkConfig
}

// Initialize the sink by giving it a name and reading in the config JSON
func (s *SampleSink) Init(name string, config json.RawMessage) error {
	s.name = fmt.Sprintf("SampleSink(%s)", name)   // Always specify a name here
  // Read in the config JSON
	if len(config) > 0 {
		err := json.Unmarshal(config, &s.config)
		if err != nil {
			return err
		}
	}
	return nil
}

// Code to submit a single CCMetric to the sink
func (s *SampleSink) Write(point lp.CCMetric) error {
	log.Print(point)
	return nil
}

// If the sink uses batched sends internally, you can tell to flush its buffers
func (s *SampleSink) Flush() error {
	return nil
}


// Close sink: close network connection, close files, close libraries, ...
func (s *SampleSink) Close() {}


// New function to create a new instance of the sink
func NewSampleSink(name string, config json.RawMessage) (Sink, error) {
	s := new(SampleSink)
	err := s.Init(name, config)
	return s, err
}