mirror of
https://github.com/rsyslog/rsyslog.git
synced 2026-06-19 12:52:57 +02:00
ee544611f6
Why:
Large rsyslog deployments cannot flip a fleet of omfwd clients to
stream compression in lockstep. Until now imptcp listeners had to
be configured as either "stream:always" or "none", which forces a
flag-day migration or running two parallel listeners on different
ports. This blocks staged roll-outs across hundreds of senders.
Impact:
Adds a new compression.mode value "stream:auto". Default behaviour
is unchanged. A new testbench script,
tests/imptcp-stream-compression-auto.sh, exercises a mixed
compressed/plain session pair on a single listener.
Before/After:
Before: one imptcp listener accepts only compressed OR plain.
After: "stream:auto" accepts both; detection is per-session and
locked-in after the first 2 bytes.
Technical overview:
- First 2 bytes of every new session are matched against the
RFC 1950 zlib header: CMF byte must equal 0x78 (deflate, default
32 KiB window - what every omfwd build emits via deflateInit()),
the FCHECK must be valid, and FDICT must be clear.
- A plain syslog frame always starts with an ASCII digit
(octet-counted framing) or '<' (non-transparent framing), so the
probe is conclusive in practice and avoids false positives.
- Detection state lives in ptcpsess_s; after the verdict the
per-session compressionMode field is rewritten to STREAM_ALWAYS
or NEVER so the steady-state DataRcvd() path is unchanged and
stays branch-free.
- Sniffed bytes are re-injected into the chosen path so no data
is lost across the probe boundary.
- Documentation, ChangeLog and a new testbench entry are included.
64 lines
2.3 KiB
Bash
Executable File
64 lines
2.3 KiB
Bash
Executable File
#!/bin/bash
|
|
# Test imptcp compression.mode="stream:auto": a single listener must
|
|
# accept BOTH a zlib-compressed session and a plain (uncompressed)
|
|
# session from independent senders on the same port. This mirrors the
|
|
# production scenario where a fleet of omfwd clients migrates from
|
|
# plain to stream-compressed delivery one peer at a time.
|
|
#
|
|
# Released under ASL 2.0
|
|
. ${srcdir:=.}/diag.sh init
|
|
export NUMMESSAGES=4000
|
|
|
|
# ---- receiver (instance 1): imptcp with stream:auto -------------------
|
|
generate_conf
|
|
add_conf '
|
|
module(load="../plugins/imptcp/.libs/imptcp")
|
|
input(type="imptcp" port="0"
|
|
listenPortFileName="'$RSYSLOG_DYNNAME'.tcpflood_port"
|
|
compression.mode="stream:auto")
|
|
|
|
template(name="outfmt" type="string" string="%msg:F,58:2%\n")
|
|
:msg, contains, "msgnum:" action(type="omfile" template="outfmt"
|
|
file="'$RSYSLOG_OUT_LOG'")
|
|
'
|
|
startup
|
|
assign_tcpflood_port $RSYSLOG_DYNNAME.tcpflood_port
|
|
# capture the receiver port before generate_conf 2 reassigns TCPFLOOD_PORT
|
|
export RCVR_PORT=$TCPFLOOD_PORT
|
|
|
|
# ---- sender (instance 2): omfwd with stream:always --------------------
|
|
generate_conf 2
|
|
add_conf '
|
|
module(load="../plugins/imdiag/.libs/imdiag")
|
|
module(load="../plugins/imtcp/.libs/imtcp")
|
|
input(type="imtcp" port="0" listenPortFileName="'$RSYSLOG_DYNNAME'.imtcp_port2")
|
|
|
|
*.* action(type="omfwd"
|
|
target="127.0.0.1" port="'$RCVR_PORT'" protocol="tcp"
|
|
compression.mode="stream:always"
|
|
template="RSYSLOG_TraditionalForwardFormat")
|
|
' 2
|
|
startup 2
|
|
|
|
# half of the messages go through the compressing sender (zlib stream)
|
|
injectmsg2 0 $((NUMMESSAGES / 2))
|
|
shutdown_when_empty 2
|
|
wait_shutdown 2
|
|
|
|
# at this point the receiver has accepted ONE compressed session; now we
|
|
# wait for those 2000 lines to land on disk before opening the second
|
|
# session - this ensures we exercise auto-detection on a fresh session,
|
|
# not on the tail of the previous stream.
|
|
wait_file_lines "$RSYSLOG_OUT_LOG" $((NUMMESSAGES / 2))
|
|
|
|
# second half: a plain TCP session to the SAME listener, no compression.
|
|
# The receiver must auto-detect plain framing on this brand-new connection.
|
|
tcpflood -p$RCVR_PORT -m$((NUMMESSAGES / 2)) -i$((NUMMESSAGES / 2))
|
|
|
|
wait_file_lines "$RSYSLOG_OUT_LOG" $NUMMESSAGES
|
|
shutdown_when_empty
|
|
wait_shutdown
|
|
|
|
seq_check
|
|
exit_test
|