chore(codecs): Implement additional Encoder/EncodingConfig without framing
#12156
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
✅ Deploy Preview for vector-project canceled.
|
pablosichert
changed the title
Encoder/EncodingConfig without framingEncoder/EncodingConfig without framing
github-actions
bot
added
domain: codecs
pablosichert
force-pushed
the
pablosichert/encoder-without-framer
branch
2 times, most recently
from
ea7e3c7
to
b0ff768
Compare
Soak Test ResultsBaseline: e2530d8 ExplanationA soak test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine, quickly, if vector performance is changed and to what degree by a pull request. Where appropriate units are scaled per-core. The table below, if present, lists those experiments that have experienced a statistically significant change in their throughput performance between baseline and comparision SHAs, with 90.0% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±7.0% change in mean throughput are discarded. An experiment is erratic if its coefficient of variation is greater than 0.3. The abbreviated table will be omitted if no interesting changes are observed. No interesting changes in throughput with confidence ≥ 90.00% and absolute Δ mean >= ±7.0%: Fine details of change detection per experiment.
Fine details of each soak run.
|
Signed-off-by: Pablo Sichert <mail@pablosichert.com>
pablosichert
force-pushed
the
pablosichert/encoder-without-framer
branch
from
b0ff768
to
c0862c5
Compare
Soak Test ResultsBaseline: e2530d8 ExplanationA soak test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine, quickly, if vector performance is changed and to what degree by a pull request. Where appropriate units are scaled per-core. The table below, if present, lists those experiments that have experienced a statistically significant change in their throughput performance between baseline and comparision SHAs, with 90.0% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±7.0% change in mean throughput are discarded. An experiment is erratic if its coefficient of variation is greater than 0.3. The abbreviated table will be omitted if no interesting changes are observed. No interesting changes in throughput with confidence ≥ 90.00% and absolute Δ mean >= ±7.0%: Fine details of change detection per experiment.
Fine details of each soak run.
|
Comment on lines
-14
to
+16
| pub struct Encoder { | ||
| pub struct Encoder<Framer> | ||
| where | ||
| Framer: Clone, |
There was a problem hiding this comment.
Why generics instead of just making framer an Option?
There was a problem hiding this comment.
Because this allows us to specialize the implementations for impl tokio_util::codec::Encoder<Event> for Encoder<Framer> and impl tokio_util::codec::Encoder<Event> for Encoder<()> at compile time such that they are branch free:
impl tokio_util::codec::Encoder<Event> for Encoder<Framer> {
type Error = Error;
fn encode(&mut self, event: Event, buffer: &mut BytesMut) -> Result<(), Self::Error> {
let len = buffer.len();
let mut payload = buffer.split_off(len);
self.serialize(event, &mut payload)?;
// Frame the serialized event.
self.framer.encode((), &mut payload).map_err(|error| {
emit!(EncoderFramingFailed { error: &error });
Error::FramingError(error)
})?;
buffer.unsplit(payload);
Ok(())
}
}impl tokio_util::codec::Encoder<Event> for Encoder<()> {
type Error = Error;
fn encode(&mut self, event: Event, buffer: &mut BytesMut) -> Result<(), Self::Error> {
let len = buffer.len();
let mut payload = buffer.split_off(len);
self.serialize(event, &mut payload)?;
buffer.unsplit(payload);
Ok(())
}
}Meaning that when we know that no framer is used we don't need to check for its known absence, same (but inverse) when using an encoder with a known framer. Since this is a very hot path, the difference can be within the order of 5-10% throughput, as can also be seen in the benchmarks in #10684 (comment).
lukesteensen
approved these changes
Apr 12, 2022
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.
This PR adds support structures needed to have both an
Encoder<()>(no framing) andEncoder<Framer>(with framing), both of which emit internal logs when encoding fails.Some context that triggered the need for this: #12133 (comment).