observiqexporter

README

observIQ Exporter

Status
Stability	deprecated
Supported pipeline types	logs
Distributions	none

This exporter supports sending log data to observIQ

** NOTE: ** This exporter is deprecated and is scheduled to be removed in v0.56.0

Configuration

One of the following configuration options are required:

• api_key (no default): The API key used to authenticate with observIQ. See the your profile on observiq to generate one. This is only required if secret_key is not specified, and should not be specified if secret_key is specified. This is the preferred key to use if your collector is not managed by observIQ.
• secret_key (no default): The secret key used to authenticate with observIQ. You can find this by adding an agent. This is only required if api_key is not specified, and should not be specified if api_key is specified.

The following configuration options can also be configured:

• endpoint (default: https://nozzle.app.observiq.com/v1/add): Endpoint where logs are sent to over http(s).
• agent_id (default: uuid generated from os.Hostname): ID for identifying the collector deployment. Ideally, this is a unique uuid, for uniquely identifying specific deployments of the agent. By default, this will be a uuid generated from the hostname. If the hostname cannot be determined, it will be 00000000-0000-0000-0000-000000000000
• agent_name (default: os.Hostname): Name for identifying the collector deployment. This is the friendly name of the deployment. Defaults to the hostname; If the hostname cannot be determined, otel collector will be used as a fallback.
• timeout (default: 20s): Http timeout when sending data.
• dialer_timeout (default: 10s): TCP Dialer timeout when sending data.
• tls:
  • insecure_skip_verify (default: false): Whether to skip checking the certificate of the endpoint when sending data over HTTPS.
  • ca_file (no default) Path to the CA cert to verify the server being connected to.
  • cert_file (no default) Path to the TLS cert to use for client connections when TLS client auth is required.
  • key_file (no default) Path to the TLS key to use for TLS required connections.

In addition, this exporter offers queued retry which is enabled by default. Information about queued retry configuration parameters can be found here.

The full list of settings exposed for this exporter are documented here

This exporter also offers proxy support as documented here.

Documentation

Index

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

Functions

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for observIQ exporter

Types

type Config

type Config struct {
	config.ExporterSettings        `mapstructure:",squash"`
	exporterhelper.TimeoutSettings `mapstructure:",squash"`
	exporterhelper.QueueSettings   `mapstructure:"sending_queue"`
	exporterhelper.RetrySettings   `mapstructure:"retry_on_failure"`
	// TLSSetting is the TLS settings for http client to use when sending logs to endpoint
	TLSSetting configtls.TLSClientSetting `mapstructure:"tls,omitempty"`
	// APIkey is the api key for authenticating with ingestion endpoint (required if no SecretKey)
	APIKey string `mapstructure:"api_key"`
	// SecretKey is the secret key for authenticating with the ingestion endpoint (required if no APIKey)
	SecretKey string `mapstructure:"secret_key"`
	// Endpoint is the url that defines the ingestion endpoint (default: "https://nozzle.app.observiq.com/v1/add")
	Endpoint string `mapstructure:"endpoint"`
	// AgentID is the ID that identifies this agent (default: uuid based off os.HostName())
	AgentID string `mapstructure:"agent_id"`
	// AgentName is the name identifies this agent (default: os.HostName())
	AgentName string `mapstructure:"agent_name"`
	// DialerTimeout is the amount of time to wait before aborting establishing the tcp connection when making
	// an http request (default: 10s)
	DialerTimeout time.Duration `mapstructure:"dialer_timeout"`
}

Config object for observIQ exporter

func (*Config) Validate

func (c *Config) Validate() error