Skip to content

Add abstractions for tiered storage of stream data #196

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add abstractions for tiered storage of stream data #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3574f6b
Add `osiris_log_reader` abstraction over offset readers
the-mikedavis Oct 8, 2025
4572f17
Add a `{'fun', fun()}` retention spec
the-mikedavis Sep 16, 2025
d2ea886
Replace `osiris_log:overview/1` tuple with a map
the-mikedavis Oct 8, 2025
681015e
Expose `osiris_log:parse_header/2`
the-mikedavis Oct 9, 2025
5f5ed04
Add `osiris_log_manifest` behaviour for hooks into log writers
the-mikedavis Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions src/osiris.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,11 @@
{abs, offset()} |
offset() |
{timestamp, timestamp()}.
-type retention_fun() :: fun((IdxFile :: file:filename_all()) -> boolean()).
-type retention_spec() ::
{max_bytes, non_neg_integer()} | {max_age, milliseconds()}.
{max_bytes, non_neg_integer()} |
{max_age, milliseconds()} |
{'fun', retention_fun()}.
Comment on lines +69 to +73
Copy link
Collaborator Author

@the-mikedavis the-mikedavis Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The retention spec part of this PR could probably be ported out on its own. It could also be used to provide a feature unrelated to tiered storage like rabbitmq/rabbitmq-server#14413 - retention up to an offset

-type writer_id() :: binary().
-type batch() :: {batch, NumRecords :: non_neg_integer(),
compression_type(),
Expand All @@ -80,11 +83,6 @@

%% returned when reading
-type entry() :: binary() | batch().
-type reader_options() :: #{transport => tcp | ssl,
chunk_selector => all | user_data,
filter_spec => osiris_bloom:filter_spec(),
read_ahead => boolean()
}.

-export_type([name/0,
config/0,
Expand Down Expand Up @@ -225,8 +223,8 @@ init_reader(Pid, OffsetSpec, CounterSpec) ->
chunk_selector => user_data}).

-spec init_reader(pid(), offset_spec(), osiris_log:counter_spec(),
reader_options()) ->
{ok, osiris_log:state()} |
osiris_log_reader:options()) ->
{ok, osiris_log_reader:state()} |
{error, {offset_out_of_range, empty | {offset(), offset()}}} |
{error, {invalid_last_offset_epoch, offset(), offset()}}.
init_reader(Pid, OffsetSpec, {_, _} = CounterSpec, Options)
Expand All @@ -235,7 +233,7 @@ init_reader(Pid, OffsetSpec, {_, _} = CounterSpec, Options)
Ctx0 = osiris_util:get_reader_context(Pid),
Ctx = Ctx0#{counter_spec => CounterSpec,
options => Options},
osiris_log:init_offset_reader(OffsetSpec, Ctx).
(osiris_log_reader:module()):init_offset_reader(OffsetSpec, Ctx).

-spec register_offset_listener(pid(), offset()) -> ok.
register_offset_listener(Pid, Offset) ->
Expand Down
Loading