collectdreceiver

README

CollectD write_http plugin JSON receiver

This receiver can receive data exported by the CollectD's write_http plugin. Only JSON format is supported. Authentication is not supported at this time.

Status
Stability	beta: metrics
Distributions	contrib
Issues
Code coverage
Code Owners	@atoulme | Seeking more code owners!

This receiver was donated by SignalFx and ported from SignalFx's Gateway (https://github.com/signalfx/gateway/tree/master/protocol/collectd). As a result, this receiver supports some additional features that are technically not compatible with stock CollectD's write_http plugin. That said, in practice such incompatibilities should never surface. For example, this receiver supports extracting labels from different fields. Given a field value field[a=b, k=v], this receiver will extract a and b as label keys and, k and v as the respective label values.

Configuration

The configuration includes the OpenTelemetry collector's server confighttp, which allows for a variety of settings. Only the most relevant ones will be discussed here, but all are available.

The following settings are required:

• endpoint (default = localhost:8081): Endpoint exposed by this receiver to send data.

The following settings are optional:

• attributes_prefix (no default): Used to add query parameters in key=value format to all metrics.
• timeout (default = 30s): Used as the read_timeout and write_timeout for the listening server.

Example:

receivers:
  collectd:
  collectd/one:
    attributes_prefix: "dap_"
    endpoint: "localhost:12345"
    timeout: "50s"

The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml.

Documentation

Overview

Package collectdreceiver implements a receiver that can be used by the OpenTelemetry collector to receive traces from CollectD http_write plugin in JSON format.

Index

• func NewFactory() receiver.Factory
• type Config
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a factory for collectd receiver.

Types

type Config

type Config struct {
	confighttp.ServerConfig `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	Timeout                 time.Duration            `mapstructure:"timeout"`
	Encoding                string                   `mapstructure:"encoding"`
	AttributesPrefix        string                   `mapstructure:"attributes_prefix"`
}

Config defines configuration for Collectd receiver.

func (*Config) Validate

func (c *Config) Validate() error