Skip to content

Commit 0fcf403

Browse files
committed
added documentation for size limits
1 parent 86896ee commit 0fcf403

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

src/site/antora/modules/ROOT/pages/manual/configuration/appenders/remotesyslogappender.adoc

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ You can also specify:
5757
</appender>
5858
----
5959
60+
[#newlinehandling]
61+
== Newline handling
62+
6063
If your log message contains multiple lines, it will be logged as multiple separate syslog entries instead of a single multiline message.
6164
6265
This might lead to confusion when analyzing logs because related lines could appear interleaved with logs from other sources.
@@ -85,4 +88,16 @@ Exception of type 'System.InvalidTimeZoneException' was thrown.
8588
at log4net.Tests.Appender.RemoteSyslogAppenderTest.LineBreakTest()
8689
at System.RuntimeMethodHandle.InvokeMethod(Object target, Void** arguments, Signature sig, Boolean isConstructor)
8790
at System.Reflection.MethodBaseInvoker.InvokeWithNoArgs(Object obj, BindingFlags invokeAttr)
88-
----
91+
----
92+
93+
[#sizelimits]
94+
== Size limits
95+
96+
The `RemoteSyslogAppender` uses the UDP protocol to send log messages to the syslog server.
97+
However, there are size limitations associated with UDP:
98+
99+
* **Message size:** Each log message is limited to **64 KB**, including both the message content and the headers.
100+
* **Practical size limit:** On many networks, such as Ethernet, the practical limit for message size is typically much lower — around **1500 bytes**.
101+
* **Message truncation:** If a log message exceeds these size limits, it will be **truncated**, which means some of the message content will be lost.
102+
103+
To avoid truncation, ensure that log messages are kept within the size limits of your network setup.

0 commit comments

Comments
 (0)