honeycombexporter

README

Honeycomb Exporter

Deprecated Honeycomb Exporter

Status
Stability	deprecated
Supported pipeline types	traces
Distributions	contrib

NOTE: Honeycomb now supports OTLP ingest directly. This means you can use an OTLP exporter and no longer need this exporter to send data to Honeycomb.

This exporter supports sending trace data to Honeycomb.

The following configuration options are supported:

• api_key (Required): This is the API key (also called Write Key) for your Honeycomb account.
• dataset (Required): The Honeycomb dataset that you want to send events to.
• api_url (Optional): You can set the hostname to send events to. Useful for debugging, defaults to https://api.honeycomb.io
• sample_rate (Optional): Constant sample rate. Can be used to send 1 / x events to Honeycomb. Defaults to 1 (always sample).
• sample_rate_attribute (Optional): The name of an attribute that contains the sample_rate for each span. If the attribute is on the span, it takes precedence over the static sample_rate configuration
• debug (Optional): Set this to true to get debug logs from the honeycomb SDK. Defaults to false.
• retry_on_failure (Optional):
  • enabled (default = true)
  • initial_interval (default = 5s): Time to wait after the first failure before retrying; ignored if enabled is false
  • max_interval (default = 30s): Is the upper bound on backoff; ignored if enabled is false
  • max_elapsed_time (default = 120s): Is the maximum amount of time spent trying to send a batch; ignored if enabled is false
• sending_queue (Optional):
  • enabled (default = true)
  • num_consumers (default = 10): Number of consumers that dequeue batches; ignored if enabled is false
  • queue_size (default = 5000): Maximum number of batches kept in memory before data; ignored if enabled is false;

Example:

exporters:
  honeycomb:
    api_key: "my-api-key"
    dataset: "my-dataset"
    api_url: "https://api.testhost.io"
    sample_rate: 25
    sample_rate_attribute: "hny.sample_rate"
    debug: true
    retry_on_failure:
      enabled: true
      initial_interval: 5
      max_interval: 30
      max_elapsed_time: 120
    sending_queue:
      enabled: true
      num_consumers: 10
      queue_size: 10000

Documentation

Index

• func NewFactory() component.ExporterFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for Honeycomb exporter.

Types

type Config

type Config struct {
	config.ExporterSettings `mapstructure:",squash"`
	// APIKey is the authentication token associated with the Honeycomb account.
	APIKey string `mapstructure:"api_key"`
	// Dataset is the Honeycomb dataset to send events to.
	Dataset string `mapstructure:"dataset"`
	// API URL to use (defaults to https://api.honeycomb.io)
	APIURL string `mapstructure:"api_url"`
	// Deprecated - do not use. This will be removed in a future release.
	SampleRate uint `mapstructure:"sample_rate"`
	// The name of an attribute that contains the sample_rate for each span.
	// If the attribute is on the span, it takes precedence over the static sample_rate configuration
	SampleRateAttribute string `mapstructure:"sample_rate_attribute"`
	// Debug enables more verbose logging from the Honeycomb SDK. It defaults to false.
	Debug bool `mapstructure:"debug"`
	// RetrySettings helps configure retry on traces which failed to send
	exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
	// QueueSettings enable queued processing
	exporterhelper.QueueSettings `mapstructure:"sending_queue"`
}

func (*Config) Validate

func (cfg *Config) Validate() error