fluentforwardreceiver

package module

v0.128.0 Latest Latest Go to latest Published: Jun 9, 2025 License: Apache-2.0 Imports: 21 Imported by: 13

README ¶

Fluent Forward Receiver

Status
Stability	beta: logs
Distributions	contrib, k8s
Issues
Code coverage
Code Owners	@dmitryax

This receiver runs a TCP server that accepts events via the Fluent Forward protocol.

This receiver:

Does not support TLS or the handshake portion of the Forward protocol.
Does support acknowledgments of events that have the chunk option, as per the spec.
Supports all three event types (message, forward, packed forward, including compressed packed forward)
Supports listening on a Unix domain socket by making the listenAddress option of the form unix://<path to socket>.
If using TCP, it will start a UDP server on the same port to deliver heartbeat echos, as per the spec.

Here is a basic example config that makes the receiver listen on all interfaces on port 8006:

receivers:
  fluentforward:
    endpoint: 0.0.0.0:8006

Development

If you are working on this receiver and need to regenerate any of the message pack autogenerated code, just run go generate on this package and its subpackages. You can get the msgp binary by just running go get -u -t github.com/tinylib/msgp, and make sure the Go binary path is on your shell's PATH.

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewFactory ¶

func NewFactory() receiver.Factory

NewFactory return a new receiver.Factory for fluentd forwarder.

Types ¶

type Config ¶

type Config struct {
	// The address to listen on for incoming Fluent Forward events.  Should be
	// of the form `<ip addr>:<port>` (TCP) or `unix://<socket_path>` (Unix
	// domain socket).
	ListenAddress string `mapstructure:"endpoint"`
	// contains filtered or unexported fields
}

Config defines configuration for the fluentforward receiver.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
internal
metadata
metadatatest

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL