Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat!: allow passing down machine options from nontransparent/octetcounting parsers #23

Merged
merged 10 commits into from
Feb 10, 2025
Merged

feat!: allow passing down machine options from nontransparent/octetcounting parsers #23

merged 10 commits into from
Feb 10, 2025

Conversation

leodido
Copy link
Owner

@leodido leodido commented Jan 25, 2025 •
edited
Loading

Fixes #21

This PR introduces breaking changes because it changes the Parser interface.
As a consequence, before merging it I'm waiting for confirmation it works in a real scenario from the grafana/alloy folks (see issue). Also, it would cause v5 to get released.

What it does

By merging in this PR,
the nontransparent and octetcounting parsers can now specify which options to pass down to the underlying syslog RFC machine parsers (RFC3164 vs RFC5424).

It introduces a syslog.ParserOption to let you do so: syslog.WithMachineOptions(opts ...syslog.MachineOption).

Example:

nontransparent.NewParserRFC3164(
  syslog.WithMachineOptions(rfc3164.WithYear(rfc3164.CurrentYear{})),
  syslog.WithListener(accumulator),
).Parse(r)

@leodido
feat: introduce WithMachineOptions() options + remove WithBestEffort(…
ca1f516 
…) (delegating it to the underlying machine and their options)

Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido leodido self-assigned this Jan 25, 2025
@leodido leodido changed the title feat!: ... feat!: better options Jan 25, 2025
@leodido
feat(nontransparent): change how underlying parsing machines get thei…
c678753 
…r options

Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(nontransparent): adapt test cases
1bc8a95 
Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(nontransparent): example showing how is now possible to pass dow…
e627b17 
…n the underlying machine options

Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
feat(octetcounting): change how underlying machines get their options
534295b 
Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(octetcounting): use NewParser(syslog.WithMachineOptions(...WithB…
127eee8 
…estEffor()), ...)

Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(octetcounting): adapt invokations
ac4444c 
Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(octetcounting): adapt invokations in examples
1ce93e5 
Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
test(octetcounting): example showing how to use rfc3164.WithYear(rfc3…
e0d0138 
…164.CurrentYear{})

Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido
chore: typo
19cf095 
Signed-off-by: Leonardo Di Donato <[email protected]>
@leodido leodido changed the title feat!: better options feat!: allow passing down machine options from nontransparent/octetcounting parsers Jan 25, 2025
@leodido leodido mentioned this pull request Jan 25, 2025
Open
@leodido leodido marked this pull request as ready for review January 25, 2025 18:46
@leodido
Copy link
Owner Author

leodido commented Jan 28, 2025

Friendly ping @dehaansa :)

@leodido leodido merged commit e1d78c2 into develop Feb 10, 2025
5 checks passed
@leodido leodido deleted the bc/revamp-options branch February 10, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@leodido leodido

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

There is no ability to use MachineOptions (WithYear) with nontransparent/octetcounting parsers
1 participant
@leodido