faroexporter

README

Faro Exporter

Status
Stability	alpha: logs, traces
Distributions	contrib
Issues
Code coverage
Code Owners	@dehaansa, @rlankfo, @mar4uk

The Faro exporter sends telemetry data to a Faro endpoint.

Configuration

The following settings are required:

• endpoint (no default): The URL to send telemetry data to (e.g., https://faro.example.com/collect).

The following settings can be optionally configured:

• sending_queue
  • enabled (default = true)
  • num_consumers (default = 10)
  • queue_size (default = 1000)
• retry_on_failure
  • enabled (default = true)
  • initial_interval (default = 5s): Time to wait after the first failure before retrying.
  • max_interval (default = 30s): Upper bound on backoff.
  • max_elapsed_time (default = 300s): Maximum amount of time spent trying to send a batch.
• timeout (default = 5s): HTTP request timeout when sending data.
• read_buffer_size (default = 0): Size of the buffer used to read the response body.
• write_buffer_size (default = 512 KiB): Size of the buffer used to write the request body.
• headers (default = {}): Additional headers to send with the request.
• compression (default = none): Compression method to use for the request body. Supported values: none, gzip.

Example:

exporters:
  faro:
    endpoint: https://faro.example.com/collect
    timeout: 10s
    headers:
      X-API-Key: "my-api-key"

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

Getting Started

The following settings are required:

• endpoint (no default): URL to which the exporter is going to send Faro telemetry data. For example: https://faro.example.com/collect.

To use TLS, specify https:// as the protocol scheme in the URL passed to the endpoint property. See Advanced Configuration for more TLS options.

Example:

exporters:
  faro:
    endpoint: "https://faro.example.com/collect"

  faro/tlsnoverify:
    endpoint: "https://faro.example.com/collect"
    tls:
      insecure_skip_verify: true

Advanced Configuration

Several helper files are leveraged to provide additional capabilities automatically:

• HTTP client settings
• TLS and mTLS settings
• Queuing, retry and timeout settings

Documentation

Overview

Package faroexporter implements an exporter that sends data to Grafana Faro.

Index

• func NewFactory() exporter.Factory
• type Config
  • func (c *Config) Unmarshal(component *confmap.Conf) error
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() exporter.Factory

NewFactory creates a factory for Faro exporter.

Types

type Config

type Config struct {
	confighttp.ClientConfig `mapstructure:",squash"`
	QueueConfig             configoptional.Optional[exporterhelper.QueueBatchConfig] `mapstructure:"sending_queue"`
	RetryConfig             configretry.BackOffConfig                                `mapstructure:"retry_on_failure"`
}

Config defines configuration settings for the Faro exporter.

func (*Config) Unmarshal

func (c *Config) Unmarshal(component *confmap.Conf) error

func (*Config) Validate

func (c *Config) Validate() error