cc-metric-collector/receivers
Thomas Gruber 200af84c54
Modularize the whole thing (#16)
* Use channels, add a metric router, split up configuration and use extended version of Influx line protocol internally

* Use central timer for collectors and router. Add expressions to router

* Add expression to router config

* Update entry points

* Start with README

* Update README for CCMetric

* Formatting

* Update README.md

* Add README for MultiChanTicker

* Add README for MultiChanTicker

* Update README.md

* Add README to metric router

* Update main README

* Remove SinkEntity type

* Update README for sinks

* Update go files

* Update README for receivers

* Update collectors README

* Update collectors README

* Use seperate page per collector

* Fix for tempstat page

* Add docs for customcmd collector

* Add docs for ipmistat collector

* Add docs for topprocs collector

* Update customCmdMetric.md

* Use seconds when calculating LIKWID metrics

* Add IB metrics ib_recv_pkts and ib_xmit_pkts

* Drop domain part of host name

* Updated to latest stable version of likwid

* Define source code dependencies in Makefile

* Add GPFS / IBM Spectrum Scale collector

* Add vet and staticcheck make targets

* Add vet and staticcheck make targets

* Avoid go vet warning:
struct field tag `json:"..., omitempty"` not compatible with reflect.StructTag.Get: suspicious space in struct tag value
struct field tag `json:"...", omitempty` not compatible with reflect.StructTag.Get: key:"value" pairs not separated by spaces

* Add sample collector to README.md

* Add CPU frequency collector

* Avoid staticcheck warning: redundant return statement

* Avoid staticcheck warning: unnecessary assignment to the blank identifier

* Simplified code

* Add CPUFreqCollectorCpuinfo
a metric collector to measure the current frequency of the CPUs
as obtained from /proc/cpuinfo
Only measure on the first hyperthread

* Add collector for NFS clients

* Move publication of metrics into Flush() for NatsSink

* Update GitHub actions

* Refactoring

* Avoid vet warning: Println arg list ends with redundant newline

* Avoid vet warning struct field commands has json tag but is not exported

* Avoid vet warning: return copies lock value.

* Corrected typo

* Refactoring

* Add go sources in internal/...

* Bad separator in Makefile

* Fix Infiniband collector

Co-authored-by: Holger Obermaier <40787752+ho-ob@users.noreply.github.com>
2022-01-25 15:37:43 +01:00
..
metricReceiver.go Modularize the whole thing (#16) 2022-01-25 15:37:43 +01:00
natsReceiver.go Modularize the whole thing (#16) 2022-01-25 15:37:43 +01:00
README.md Modularize the whole thing (#16) 2022-01-25 15:37:43 +01:00
receiveManager.go Modularize the whole thing (#16) 2022-01-25 15:37:43 +01:00

CCMetric receivers

This folder contains the ReceiveManager and receiver implementations for the cc-metric-collector.

Configuration

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

[
  {
    "type": "nats",
    "address": "nats://my-url",
    "port" : "4222",
    "database": "testcluster"
  }
]

Type nats

{
  "type": "nats",
  "address": "<nats-URI or hostname>",
  "port" : "<portnumber>",
  "database": "<subscribe topic>"
}

The nats receiver subscribes to the topic database and listens on address and port for metrics in the InfluxDB line protocol.

Contributing own receivers

A receiver contains three functions and is derived from the type Receiver (in metricReceiver.go):

  • Init(config ReceiverConfig) error
  • Start() error
  • Close()
  • Name() string
  • SetSink(sink chan ccMetric.CCMetric)

The data structures should be set up in Init() like opening a file or server connection. The Start() function should either start a go routine or issue some other asynchronous mechanism for receiving metrics. The Close() function should tear down anything created in Init().

Finally, the receiver needs to be registered in the receiveManager.go. There is a list of receivers called AvailableReceivers which is a map (receiver_type_string -> pointer to Receiver interface). Add a new entry with a descriptive name and the new receiver.