[receiver/filelog] fix record counting with header #35870
+189
−32
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 refactors the `Reader::ReadToEnd` method by separating reading the file's header from reading the file's contents. This results in very similar code in `readHeader` and `readContents` methods, which was previosly deduplicated at the cost of slightly higher complexity. The bug could be fixed without separating header reading from contents reading, but I hope this separation will make it easier to implement content batching in the Reader (open-telemetry#35455). Content batching was my original motivation for these code changes. I only discovered the problem with record counting when reading the code.
andrzej-stencel
commented
Oct 18, 2024
|
|
||
| func (r *Reader) readContents(ctx context.Context) { | ||
| // Create the scanner to read the contents of the file. | ||
| s := scanner.New(r, r.maxLogSize, r.initialBufferSize, r.Offset, r.splitFunc) |
There was a problem hiding this comment.
Note that I recreate the scanner again with r.initialBufferSize, but its value is updated to scanner.DefaultBufferSize in "header machinery cleanup" section of the readHeader method.I hope this reflects the original behavior.
As far as I understand the "initial buffer size" is only used in tests and I'm not sure why those tests are actually needed.
andrzej-stencel
commented
Oct 18, 2024
|
|
||
| // Switch to the normal split and process functions. | ||
| r.splitFunc = r.lineSplitFunc | ||
| r.processFunc = r.emitFunc |
There was a problem hiding this comment.
This "juggling" of function references could probably be avoided altogether after the refactoring.
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
Fixes #35869 by refactoring of the
Reader::ReadToEndmethod.This refactors the
Reader::ReadToEndmethod by separating reading the file's header from reading the file's contents.This results in very similar code in
readHeaderandreadContentsmethods, which was previously deduplicated at the cost of slightly higher complexity.The bug could be fixed without separating header reading from contents reading, but I hope this separation will make it easier to implement content batching in the Reader (#35455).
Content batching was my original motivation for these code changes.
I only discovered the problem with record counting when reading the code.
Link to tracking issue
Fixes #35869
Testing
In the first commit I have added tests that document the erroneous behavior. In the second commit I have fixed the bug and corrected the tests.
Documentation
Added changelog entry.