kafka

Documentation

Overview

Package kafka provides an otelcol.receiver.kafka component.

Index

• type Arguments
  • func (args Arguments) Convert() (otelcomponent.Config, error)
  • func (args Arguments) DebugMetricsConfig() otelcolCfg.DebugMetricsArguments
  • func (args Arguments) Exporters() map[otelcomponent.DataType]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 AutoCommitArguments
  • func (args AutoCommitArguments) Convert() kafkareceiver.AutoCommit
  • func (args *AutoCommitArguments) SetToDefault()
• type HeaderExtraction
  • func (h HeaderExtraction) Convert() kafkareceiver.HeaderExtraction
  • func (h *HeaderExtraction) SetToDefault()
• type MessageMarkingArguments
  • func (args MessageMarkingArguments) Convert() kafkareceiver.MessageMarking
  • func (args *MessageMarkingArguments) SetToDefault()

Types

type Arguments

type Arguments struct {
	Brokers         []string `alloy:"brokers,attr"`
	ProtocolVersion string   `alloy:"protocol_version,attr"`
	Topic           string   `alloy:"topic,attr,optional"`
	Encoding        string   `alloy:"encoding,attr,optional"`
	GroupID         string   `alloy:"group_id,attr,optional"`
	ClientID        string   `alloy:"client_id,attr,optional"`
	InitialOffset   string   `alloy:"initial_offset,attr,optional"`

	ResolveCanonicalBootstrapServersOnly bool `alloy:"resolve_canonical_bootstrap_servers_only,attr,optional"`

	Authentication   otelcol.KafkaAuthenticationArguments `alloy:"authentication,block,optional"`
	Metadata         otelcol.KafkaMetadataArguments       `alloy:"metadata,block,optional"`
	AutoCommit       AutoCommitArguments                  `alloy:"autocommit,block,optional"`
	MessageMarking   MessageMarkingArguments              `alloy:"message_marking,block,optional"`
	HeaderExtraction HeaderExtraction                     `alloy:"header_extraction,block,optional"`

	// DebugMetrics configures component internal metrics. Optional.
	DebugMetrics otelcolCfg.DebugMetricsArguments `alloy:"debug_metrics,block,optional"`

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

Arguments configures the otelcol.receiver.kafka 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[otelcomponent.DataType]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 AutoCommitArguments

type AutoCommitArguments struct {
	Enable   bool          `alloy:"enable,attr,optional"`
	Interval time.Duration `alloy:"interval,attr,optional"`
}

AutoCommitArguments configures how to automatically commit updated topic offsets back to the Kafka broker.

func (AutoCommitArguments) Convert

func (args AutoCommitArguments) Convert() kafkareceiver.AutoCommit

Convert converts args into the upstream type.

func (*AutoCommitArguments) SetToDefault

func (args *AutoCommitArguments) SetToDefault()

type HeaderExtraction

type HeaderExtraction struct {
	ExtractHeaders bool     `alloy:"extract_headers,attr,optional"`
	Headers        []string `alloy:"headers,attr,optional"`
}

func (HeaderExtraction) Convert

func (h HeaderExtraction) Convert() kafkareceiver.HeaderExtraction

Convert converts HeaderExtraction into the upstream type.

func (*HeaderExtraction) SetToDefault

func (h *HeaderExtraction) SetToDefault()

type MessageMarkingArguments

type MessageMarkingArguments struct {
	AfterExecution      bool `alloy:"after_execution,attr,optional"`
	IncludeUnsuccessful bool `alloy:"include_unsuccessful,attr,optional"`
}

MessageMarkingArguments configures when Kafka messages are marked as read.

func (MessageMarkingArguments) Convert

func (args MessageMarkingArguments) Convert() kafkareceiver.MessageMarking

Convert converts args into the upstream type.

func (*MessageMarkingArguments) SetToDefault

func (args *MessageMarkingArguments) SetToDefault()