[exporter/syslog] send syslog messages in batches #27799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This changes the behavior of the Syslog exporter to send each batch of syslog messages in a single request (with messages separated by newlines), instead of sending each message in a separate request and closing the connection after each message. This also significantly refactors (and hopefully simplifies) the exporter's code, extracting the code that formats the Syslog messages from the `sender` type into separate `formatter` types. Hopefully this will make the development of this component easier.
andrzej-stencel
force-pushed
the
syslog-exporter-performance
branch
from
c83790a to
421407a
Compare
songy23
approved these changes
Oct 17, 2023
rnishtala-sumo
approved these changes
Oct 19, 2023
According to https://datatracker.ietf.org/doc/html/rfc5426#section-3.1, Messages sent over UDP must be sent separately. > Each syslog UDP datagram MUST contain only one syslog message
|
I have changed the implementation to only batch messages when using TCP. As correctly pointed out by @kkujawa-sumo (thank you!), when sending over UDP, each message must be sent in a separate request: https://datatracker.ietf.org/doc/html/rfc5426#section-3.1
|
kasia-kujawa
approved these changes
Oct 24, 2023
|
@songy23 anything missing from marking it as |
songy23
added
the
ready to merge
|
Added the label, cc @open-telemetry/collector-contrib-maintainer please merge 🙏 |
jmsnll
pushed a commit
to jmsnll/opentelemetry-collector-contrib
that referenced
this pull request
Nov 12, 2023
**Description:** This changes the behavior of the Syslog exporter to send each batch of Syslog messages in a single request (with messages separated by newlines), instead of sending each message in a separate request and closing the connection after each message. The batching only happens when using TCP. For UDP, each syslog message is still sent in a separate request, as defined by [the spec](https://datatracker.ietf.org/doc/html/rfc5426#section-3.1). This also significantly refactors (and hopefully simplifies) the exporter's code, extracting the code that formats the syslog messages from the `sender` type into separate `formatter` types. Hopefully this will make the development of this component easier. **Link to tracking Issue:** - open-telemetry#21244 **Testing:** The unit tests have been updated to reflect the refactored codebase. The integration tests introduced in open-telemetry#27464 are unchanged, as the format of the output messages hasn't changed. **Documentation:** No documentation updates.
RoryCrispin
pushed a commit
to ClickHouse/opentelemetry-collector-contrib
that referenced
this pull request
Nov 24, 2023
**Description:** This changes the behavior of the Syslog exporter to send each batch of Syslog messages in a single request (with messages separated by newlines), instead of sending each message in a separate request and closing the connection after each message. The batching only happens when using TCP. For UDP, each syslog message is still sent in a separate request, as defined by [the spec](https://datatracker.ietf.org/doc/html/rfc5426#section-3.1). This also significantly refactors (and hopefully simplifies) the exporter's code, extracting the code that formats the syslog messages from the `sender` type into separate `formatter` types. Hopefully this will make the development of this component easier. **Link to tracking Issue:** - open-telemetry#21244 **Testing:** The unit tests have been updated to reflect the refactored codebase. The integration tests introduced in open-telemetry#27464 are unchanged, as the format of the output messages hasn't changed. **Documentation:** No documentation updates.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This changes the behavior of the Syslog exporter to send each batch of Syslog messages in a single request (with messages separated by newlines), instead of sending each message in a separate request and closing the connection after each message.
The batching only happens when using TCP. For UDP, each syslog message is still sent in a separate request, as defined by the spec.
This also significantly refactors (and hopefully simplifies) the exporter's code, extracting the code that formats the syslog messages from the
sendertype into separateformattertypes. Hopefully this will make the development of this component easier.Link to tracking Issue:
Testing:
The unit tests have been updated to reflect the refactored codebase. The integration tests introduced in #27464 are unchanged, as the format of the output messages hasn't changed.
Documentation:
No documentation updates.