solace

Documentation

Overview

Package solace provides an otelcol.receiver.solace component.

Index

• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component
  • func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension
  • func (args Arguments) NextConsumers() *otelcol.ConsumerArguments
  • func (args *Arguments) SetToDefault()
  • func (args *Arguments) Validate() error
• type Authentication
  • func (args Authentication) Convert() solacereceiver.Authentication
• type FlowControl
  • func (args FlowControl) Convert() solacereceiver.FlowControl
  • func (args *FlowControl) SetToDefault()
• type FlowControlDelayedRetry
  • func (args FlowControlDelayedRetry) Convert() *solacereceiver.FlowControlDelayedRetry
• type SaslExternalConfig
  • func (args SaslExternalConfig) Convert() *solacereceiver.SaslExternalConfig
• type SaslPlainTextConfig
  • func (args SaslPlainTextConfig) Convert() *solacereceiver.SaslPlainTextConfig
• type SaslXAuth2Config
  • func (args SaslXAuth2Config) Convert() *solacereceiver.SaslXAuth2Config

Types

type Arguments

type Arguments struct {
	// The upstream component uses a list for the broker but they only use the first element in the list so I decided to use
	// a simple string in Alloy to avoid confusing the users.
	Broker     string `alloy:"broker,attr,optional"`
	Queue      string `alloy:"queue,attr"`
	MaxUnacked int32  `alloy:"max_unacknowledged,attr,optional"`

	TLS          otelcol.TLSClientArguments       `alloy:"tls,block,optional"`
	Flow         FlowControl                      `alloy:"flow_control,block,optional"`
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`
	Auth         Authentication                   `alloy:"auth,block"`

	// Output configures where to send received data. Required.
	Output *otelcol.ConsumerArguments `alloy:"output,block"`
}

Arguments configures the otelcol.receiver.solace component.

func (Arguments) Convert

func (args Arguments) Convert() (otelcomponent.Config, error)

Convert implements receiver.Arguments.

func (Arguments) DebugMetricsConfig

func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments

DebugMetricsConfig implements receiver.Arguments.

func (Arguments) Exporters

func (args Arguments) Exporters() map[pipeline.Signal]map[otelcomponent.ID]otelcomponent.Component

Exporters implements receiver.Arguments.

func (Arguments) Extensions

func (args Arguments) Extensions() map[otelcomponent.ID]otelextension.Extension

Extensions implements receiver.Arguments.

func (Arguments) NextConsumers

func (args Arguments) NextConsumers() *otelcol.ConsumerArguments

NextConsumers implements receiver.Arguments.

func (*Arguments) SetToDefault

func (args *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Arguments) Validate

func (args *Arguments) Validate() error

Validate implements syntax.Validator.

type Authentication

type Authentication struct {
	PlainText *SaslPlainTextConfig `alloy:"sasl_plain,block,optional"`
	XAuth2    *SaslXAuth2Config    `alloy:"sasl_xauth2,block,optional"`
	External  *SaslExternalConfig  `alloy:"sasl_external,block,optional"`
}

Authentication defines authentication strategies.

func (Authentication) Convert

func (args Authentication) Convert() solacereceiver.Authentication

Convert converts args into the upstream type.

type FlowControl

type FlowControl struct {
	DelayedRetry *FlowControlDelayedRetry `alloy:"delayed_retry,block"`
}

FlowControl defines the configuration for what to do in backpressure scenarios, e.g. memorylimiter errors

func (FlowControl) Convert

func (args FlowControl) Convert() solacereceiver.FlowControl

func (*FlowControl) SetToDefault

func (args *FlowControl) SetToDefault()

type FlowControlDelayedRetry

type FlowControlDelayedRetry struct {
	Delay time.Duration `alloy:"delay,attr,optional"`
}

FlowControlDelayedRetry represents the strategy of waiting for a defined amount of time (in time.Duration) and attempt redelivery

func (FlowControlDelayedRetry) Convert

func (args FlowControlDelayedRetry) Convert() *solacereceiver.FlowControlDelayedRetry

type SaslExternalConfig

type SaslExternalConfig struct{}

SaslExternalConfig defines the configuration for the SASL External used in conjunction with TLS client authentication.

func (SaslExternalConfig) Convert

func (args SaslExternalConfig) Convert() *solacereceiver.SaslExternalConfig

type SaslPlainTextConfig

type SaslPlainTextConfig struct {
	Username string            `alloy:"username,attr"`
	Password alloytypes.Secret `alloy:"password,attr"`
}

SaslPlainTextConfig defines SASL PLAIN authentication.

func (SaslPlainTextConfig) Convert

func (args SaslPlainTextConfig) Convert() *solacereceiver.SaslPlainTextConfig

type SaslXAuth2Config

type SaslXAuth2Config struct {
	Username string `alloy:"username,attr"`
	Bearer   string `alloy:"bearer,attr"`
}

SaslXAuth2Config defines the configuration for the SASL XAUTH2 authentication.

func (SaslXAuth2Config) Convert

func (args SaslXAuth2Config) Convert() *solacereceiver.SaslXAuth2Config