README
¶
Fluent Forward Receiver
| Status | |
|---|---|
| Stability | beta: logs |
| Distributions | contrib |
| Issues |   |
| 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
chunkoption, 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
listenAddressoption of the formunix://<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
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
NewFactory return a new receiver.Factory for fluentd forwarder.
Types ¶
type AckResponse ¶
type AckResponse struct {
Ack string `msg:"ack"`
}
type Collector ¶
type Collector struct {
// contains filtered or unexported fields
}
Collector acts as an aggregator of LogRecords so that we don't have to generate as many plog.Logs instances...we can pre-batch the LogRecord instances from several Forward events into one to hopefully reduce allocations and GC overhead.
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"`
}
Config defines configuration for the fluentforward receiver.
type ForwardEventLogRecords ¶
type ForwardEventLogRecords struct {
plog.LogRecordSlice
OptionsMap
}
func (*ForwardEventLogRecords) DecodeMsg ¶
func (fe *ForwardEventLogRecords) DecodeMsg(dc *msgp.Reader) error
func (*ForwardEventLogRecords) LogRecords ¶
func (fe *ForwardEventLogRecords) LogRecords() plog.LogRecordSlice
type MessageEventLogRecord ¶
type MessageEventLogRecord struct {
plog.LogRecordSlice
OptionsMap
}
func (*MessageEventLogRecord) DecodeMsg ¶
func (melr *MessageEventLogRecord) DecodeMsg(dc *msgp.Reader) error
func (*MessageEventLogRecord) LogRecords ¶
func (melr *MessageEventLogRecord) LogRecords() plog.LogRecordSlice
type OptionsMap ¶
func (OptionsMap) Chunk ¶
func (om OptionsMap) Chunk() string
Chunk returns the `chunk` option or blank string if it was not set.
func (OptionsMap) Compressed ¶
func (om OptionsMap) Compressed() string
type PackedForwardEventLogRecords ¶
type PackedForwardEventLogRecords struct {
plog.LogRecordSlice
OptionsMap
}
func (*PackedForwardEventLogRecords) DecodeMsg ¶
func (pfe *PackedForwardEventLogRecords) DecodeMsg(dc *msgp.Reader) error
DecodeMsg implements msgp.Decodable. This was originally code generated but then manually copied here in order to handle the optional Options field.
func (*PackedForwardEventLogRecords) LogRecords ¶
func (pfe *PackedForwardEventLogRecords) LogRecords() plog.LogRecordSlice
Source Files
Directories