package
0.1.0-beta.1
Repository: https://github.com/clustercockpit/cc-lib.git
Documentation: pkg.go.dev

# README

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.

{
  "myreceivername" : {
    "type": "receiver-type",
    <receiver-specific configuration>
  }
}

This allows to specify

Available receivers

  • nats: Receive metrics from the NATS network
  • prometheus: Scrape data from a Prometheus client
  • http: Listen for HTTP Post requests transporting metrics in InfluxDB line protocol
  • ipmi: Read IPMI sensor readings
  • redfish Use the Redfish (specification) to query thermal and power metrics

Contributing own receivers

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

For an example, check the sample receiver

# Functions

No description provided by the author
No description provided by the author
NewNatsReceiver creates a new Receiver which subscribes to messages from a NATS server.
No description provided by the author
New function to create a new instance of the receiver Initialize the receiver by giving it a name and reading in the config JSON.

# Constants

No description provided by the author

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Receiver configuration: Listen address, port.
No description provided by the author
SampleReceiver configuration: receiver type, listen address, port The defaultReceiverConfig contains the keys 'type' and 'process_messages'.

# Interfaces

No description provided by the author
No description provided by the author