Add reader and manifest abstractions for osiris_log
#194
Conversation
This file contains hidden or 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
Note - dialyzer is unhappy with this being opaque :/
We can use this to calculate the CRC32 for remote-tier integrity checks.
the-mikedavis
force-pushed
the
md/log-reader-and-manifest
branch
from
3e1045f to
71d7870
Compare
TODO - fully replace the seg_info record with the map?
This change also refactors the overview type from being
{osiris_log:range(), [{osiris:epoch(), osiris:offset()}]}
to being a map where both of those are required:
#{range := osiris_log:range(),
epoch_offsets := [{osiris:epoch(), osiris:offset()}]}
This allows other manifest implementations to stick other data in the
map. This map is passed through to replicas in `init_acceptor/2` and
`acceptor_manifest/2`, so they can use information from the manifest
from the writer's node.
Collaborator
Author
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 adds two new abstractions into osiris_log which provide hooks necessary for #184.
The simpler one is
osiris_log_reader:open/1,pread/3,sendfile/4andclose/1. The default implementation reads directly from the passed segment file with the functions fromfile. A tiered storage reader would use the default implementation inosiris_log_readerfor local files and otherwise read from the remote tier.Then there is
osiris_log_manifestwhich abstracts over whatever data structure is used to find positions within the log for readers. The default implementation is inosiris_log(in order to minimize the diff of this change) and it lists and sorts segment and index files from the stream's directory. While the manifest concept is meant to enable finding locations in the remote tier, this abstraction could also be used to swap out the current directory listing approach to do something like consult a file instead.The manifest behaviour also has a callback for handling events: currently a segment file being rolled and a chunk being written. The manifest can use these events as hooks to update the backing data structure. This part isn't used by the default implementation.