Skip to content

Add delimiter parameter of in_syslog - #646

Merged
kenhys merged 1 commit into
fluent:1.0from
Watson1978:docs-in-syslog-delimiter
Jul 24, 2026
Merged

Add delimiter parameter of in_syslog#646
kenhys merged 1 commit into
fluent:1.0from
Watson1978:docs-in-syslog-delimiter

Conversation

@Watson1978

Copy link
Copy Markdown
Contributor

The parameter is defined at lib/fluent/plugin/in_syslog.rb:106-107

desc 'The delimiter value "\n"'
config_param :delimiter, :string, default: "\n"

but input/syslog.md had no section for it under "Parameters". The "TCP Protocol and Message Delimiter" section described the concept without mentioning that the character is configurable, so a link to the new section is added there too.

The two limitations described come from the code:

  • #start_tcp_server (l.183) is the only reader, so the parameter has no effect on the udp transport, where #start_udp_server (l.176-180) handles one datagram as one message.
  • l.185 is delimiter = octet_count_frame ? " " : @delimiter, so frame_type octet_count ignores it.

Verified by sending messages over each transport: delimiter "||" splits on "||" with , and is ignored with frame_type octet_count and with udp.

Introduced at fluent/fluentd#2378

The parameter is defined at lib/fluent/plugin/in_syslog.rb:106-107

    desc 'The delimiter value "\n"'
    config_param :delimiter, :string, default: "\n"

but input/syslog.md had no section for it under "Parameters". The
"TCP Protocol and Message Delimiter" section described the concept
without mentioning that the character is configurable, so a link to the
new section is added there too.

The two limitations described come from the code:

  * #start_tcp_server (l.183) is the only reader, so the parameter has no
    effect on the udp transport, where #start_udp_server (l.176-180)
    handles one datagram as one message.
  * l.185 is `delimiter = octet_count_frame ? " " : @delimiter`, so
    `frame_type octet_count` ignores it.

Verified by sending messages over each transport: `delimiter "||"` splits
on "||" with <transport tcp>, and is ignored with `frame_type octet_count`
and with udp.

Introduced by 3e4327a0 "support config delimiter in syslog plugin", first
released in v1.5.0.

Signed-off-by: Shizuo Fujita <fujita@clear-code.com>
@Watson1978
Watson1978 force-pushed the docs-in-syslog-delimiter branch from b997d22 to 1d5f0b6 Compare July 24, 2026 01:49
@Watson1978
Watson1978 requested a review from kenhys July 24, 2026 01:50
@kenhys
kenhys merged commit 21acdba into fluent:1.0 Jul 24, 2026
2 checks passed
@Watson1978
Watson1978 deleted the docs-in-syslog-delimiter branch July 24, 2026 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants