carbonexporter

README

Carbon Exporter

Status
Stability	beta: metrics
Distributions	contrib
Issues
Code Owners	@aboguszewski-sumo

The Carbon exporter supports Carbon's plaintext protocol.

Configuration

The following settings are required:

• endpoint (default = localhost:2003): Address and port that the exporter should send data to.

Example:

exporters:
  carbon:
    # by default it will export to localhost:2003 using tcp
  carbon/allsettings:
    # use endpoint to specify alternative destinations for the exporter,
    # the default is localhost:2003
    endpoint: localhost:8080
    # timeout is the maximum duration allowed to connecting and sending the
    # data to the configured endpoint.
    # The default is 5 seconds.
    timeout: 10s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here.

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• net settings
• Queuing, retry and timeout settings

Documentation

Overview

Package carbonexporter implements an exporter that sends data to Carbon.

Index

• func NewFactory() exporter.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for Carbon exporter.

Types

type Config

type Config struct {
	// Specifies the connection endpoint config. The default value is "localhost:2003".
	confignet.TCPAddrConfig `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct.
	// MaxIdleConns is used to set a limit to the maximum idle TCP connections the client can keep open. Default value is 100.
	// If `sending_queue` is enabled, it is recommended to use same value as `sending_queue::num_consumers`.
	MaxIdleConns int `mapstructure:"max_idle_conns"`

	// Timeout is the maximum duration allowed to connecting and sending the
	// data to the Carbon/Graphite backend. The default value is 5s.
	exporterhelper.TimeoutSettings `mapstructure:",squash"`     // squash ensures fields are correctly decoded in embedded struct.
	QueueConfig                    exporterhelper.QueueSettings `mapstructure:"sending_queue"`
	RetryConfig                    configretry.BackOffConfig    `mapstructure:"retry_on_failure"`

	// ResourceToTelemetrySettings defines configuration for converting resource attributes to metric labels.
	ResourceToTelemetryConfig resourcetotelemetry.Settings `mapstructure:"resource_to_telemetry_conversion"`
}

Config defines configuration for Carbon exporter.

func (*Config) Validate

func (cfg *Config) Validate() error