otlpmqttexporter

README

OTLP/MQTT Exporter

Alt 1. Test Orb Agent with Open Telemetry use this config in localconifg/config.yaml

otel:
  enable: true

Exports traces and/or metrics via MQTT using OTLP format.

Supported pipeline types: traces, metrics, logs

⚠ OTLP logs format is currently marked as "Beta" and may change in incompatible ways.

The following settings are required:

• endpoint (no default): The target base URL to send data to (e.g.: https://example.com:4318). To send each signal a corresponding path will be added to this base URL, i.e. for traces "/v1/traces" will appended, for metrics "/v1/metrics" will be appended, for logs "/v1/logs" will be appended.

The following settings can be optionally configured:

• traces_channel (no default): The target URL to send trace data to (e.g.: https://example.com:4318/v1/traces). If this setting is present the endpoint setting is ignored for traces.
• metrics_channel (no default): The target URL to send metric data to (e.g.: https://example.com:4318/v1/metrics). If this setting is present the endpoint setting is ignored for metrics.
• logs_channel (no default): The target URL to send log data to (e.g.: https://example.com:4318/v1/logs). If this setting is present the endpoint setting is ignored logs.
• tls: see TLS Configuration Settings for the full set of available options.

Example:

exporters:
  otlpmqtt:
    endpoint: https://example.com:4318/v1/traces

By default gzip compression is enabled. See compression comparison for details benchmark information. To disable, configure as follows:

exporters:
  otlpmqtt:
    ...
    compression: none

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

Documentation

Overview

Package otlpmqttexporter exports data by using the OTLP format to an MQTT endpoint.

Index

• func CreateConfig(addr, id, key, channel, pktvisor, metricsTopic string) config.Exporter
• func CreateConfigClient(client mqtt.Client, metricsTopic, pktvisor string) config.Exporter
• func CreateDefaultConfig() config.Exporter
• func CreateDefaultSettings(logger *zap.Logger) component.ExporterCreateSettings
• func CreateMetricsExporter(ctx context.Context, set component.ExporterCreateSettings, cfg config.Exporter) (component.MetricsExporter, error)
• func NewFactory() component.ExporterFactory
• type Config
  • func (cfg *Config) Validate() error

Functions

func CreateConfig

func CreateConfig(addr, id, key, channel, pktvisor, metricsTopic string) config.Exporter

func CreateConfigClient

func CreateConfigClient(client mqtt.Client, metricsTopic, pktvisor string) config.Exporter

func CreateDefaultConfig

func CreateDefaultConfig() config.Exporter

func CreateDefaultSettings

func CreateDefaultSettings(logger *zap.Logger) component.ExporterCreateSettings

func CreateMetricsExporter

func CreateMetricsExporter(
	ctx context.Context,
	set component.ExporterCreateSettings,
	cfg config.Exporter,
) (component.MetricsExporter, error)

func NewFactory

func NewFactory() component.ExporterFactory

NewFactory creates a factory for OTLP exporter. Reducing the scope to just Metrics since it is our use-case

Types

type Config

type Config struct {
	config.ExporterSettings      `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
	exporterhelper.QueueSettings `mapstructure:"sending_queue"`
	exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`

	// Add Client directly to only re-use an existing connection - requires "github.com/eclipse/paho.mqtt.golang"
	Client mqtt.Client

	// Configuration to connect to MQTT
	Address      string `mapstructure:"address"`
	Id           string `mapstructure:"id"`
	Key          string `mapstructure:"key"`
	ChannelID    string `mapstructure:"channel_id"`
	TLS          bool   `mapstructure:"enable_tls"`
	MetricsTopic string `mapstructure:"metrics_topic"`

	// Specific for ORB Agent
	PktVisorVersion string `mapstructure:"pktvisor_version"`
}

Config defines configuration for OTLP/HTTP exporter.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks if the exporter configuration is valid