Files
akvorado/inlet/kafka/config.go
Vincent Bernat ac68c5970e inlet: split inlet into new inlet and outlet
This change split the inlet component into a simpler inlet and a new
outlet component. The new inlet component receive flows and put them in
Kafka, unparsed. The outlet component takes them from Kafka and resume
the processing from here (flow parsing, enrichment) and puts them in
ClickHouse.

The main goal is to ensure the inlet does a minimal work to not be late
when processing packets (and restart faster). It also brings some
simplification as the number of knobs to tune everything is reduced: for
inlet, we only need to tune the queue size for UDP, the number of
workers and a few Kafka parameters; for outlet, we need to tune a few
Kafka parameters, the number of workers and a few ClickHouse parameters.

The outlet component features a simple Kafka input component. The core
component becomes just a callback function. There is also a new
ClickHouse component to push data to ClickHouse using the low-level
ch-go library with batch inserts.

This processing has an impact on the internal representation of a
FlowMessage. Previously, it was tailored to dynamically build the
protobuf message to be put in Kafka. Now, it builds the batch request to
be sent to ClickHouse. This makes the FlowMessage structure hides the
content of the next batch request and therefore, it should be reused.
This also changes the way we decode flows as they don't output
FlowMessage anymore, they reuse one that is provided to each worker.

The ClickHouse tables are slightly updated. Instead of using Kafka
engine, the Null engine is used instead.

Fix #1122
2025-07-27 21:44:28 +02:00

60 lines
1.9 KiB
Go

// SPDX-FileCopyrightText: 2022 Free Mobile
// SPDX-License-Identifier: AGPL-3.0-only
package kafka
import (
"time"
"github.com/IBM/sarama"
"akvorado/common/kafka"
)
// Configuration describes the configuration for the Kafka exporter.
type Configuration struct {
kafka.Configuration `mapstructure:",squash" yaml:"-,inline"`
// FlushInterval tells how often to flush pending data to Kafka.
FlushInterval time.Duration `validate:"min=100ms"`
// FlushBytes tells to flush when there are many bytes to write
FlushBytes int `validate:"min=1000"`
// MaxMessageBytes is the maximum permitted size of a message.
// Should be set equal or smaller than broker's
// `message.max.bytes`.
MaxMessageBytes int `validate:"min=1"`
// CompressionCodec defines the compression to use.
CompressionCodec CompressionCodec
// QueueSize defines the size of the channel used to send to Kafka.
QueueSize int `validate:"min=1"`
}
// DefaultConfiguration represents the default configuration for the Kafka exporter.
func DefaultConfiguration() Configuration {
return Configuration{
Configuration: kafka.DefaultConfiguration(),
FlushInterval: time.Second,
FlushBytes: int(sarama.MaxRequestSize) - 1,
MaxMessageBytes: 1_000_000,
CompressionCodec: CompressionCodec(sarama.CompressionNone),
QueueSize: 32,
}
}
// CompressionCodec represents a compression codec.
type CompressionCodec sarama.CompressionCodec
// UnmarshalText produces a compression codec
func (cc *CompressionCodec) UnmarshalText(text []byte) error {
return (*sarama.CompressionCodec)(cc).UnmarshalText(text)
}
// String turns a compression codec into a string
func (cc CompressionCodec) String() string {
return sarama.CompressionCodec(cc).String()
}
// MarshalText turns a compression codec into a string
func (cc CompressionCodec) MarshalText() ([]byte, error) {
return []byte(cc.String()), nil
}