Skip to content

Merge stream.read_ahead and stream.read_ahead_limit options (backport #14894) #14948

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

Merged
merged 1 commit into from
Nov 13, 2025
+20 −52
Merged

Merge stream.read_ahead and stream.read_ahead_limit options (backport #14894) #14948

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 3 additions & 12 deletions deps/rabbit/priv/schema/rabbit.schema
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2776,24 +2776,15 @@ fun(Conf) ->
end
end}.

%% See github.com/rabbitmq/osiris#192 and https://github.com/rabbitmq/rabbitmq-server/commit/9f162dfd01c1516d168e7d1fad39d33a929756e5
%% Enables read-head
{mapping, "stream.read_ahead", "rabbit.stream_read_ahead",
[{datatype, {enum, [true, false]}}]}.

{mapping, "stream.read_ahead_limit", "rabbit.stream_read_ahead_limit", [
{datatype, [integer, string]},
{validators, ["is_supported_information_unit"]}
]}.
[{datatype, [{enum, [true, false]}, integer, string]}]}.

{mapping, "cluster_tags.$tag", "rabbit.cluster_tags", [
{datatype, [binary]}
]}.


%% See github.com/rabbitmq/osiris#192 and https://github.com/rabbitmq/rabbitmq-server/commit/9f162dfd01c1516d168e7d1fad39d33a929756e5
%% Enables read-head
{mapping, "stream.read_ahead", "rabbit.stream_read_ahead",
Copy link
Collaborator

@the-mikedavis the-mikedavis Nov 12, 2025

Choose a reason for hiding this comment

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

I accidentally moved or duplicated this last time

[{datatype, {enum, [true, false]}}]}.

{translation, "rabbit.cluster_tags",
fun(Conf) ->
case cuttlefish:conf_get("cluster_tags", Conf, undefined) of
Expand Down
24 changes: 10 additions & 14 deletions deps/rabbit/src/rabbit_stream_queue.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
-export([format_osiris_event/2]).
-export([update_stream_conf/2]).
-export([readers/1]).
-export([read_ahead_on/0, read_ahead_limit/0]).
-export([read_ahead/0]).

-export([parse_offset_arg/1,
filter_spec/1]).
Expand Down Expand Up @@ -468,8 +468,7 @@ begin_stream(#stream_client{name = QName,
Tag, Offset, Mode, AckRequired, Filter, Options0)
when is_pid(LocalPid) ->
CounterSpec = {{?MODULE, QName, Tag, self()}, []},
Options1 = Options0#{read_ahead => read_ahead_on(),
read_ahead_limit => read_ahead_limit()},
Options1 = Options0#{read_ahead => read_ahead()},
{ok, Seg0} = osiris:init_reader(LocalPid, Offset, CounterSpec, Options1),
NextOffset = osiris_log:next_offset(Seg0) - 1,
osiris:register_offset_listener(LocalPid, NextOffset),
Expand Down Expand Up @@ -1531,23 +1530,20 @@ queue_vm_ets() ->
shrink_all(_Node) ->
{error, not_quorum_queue}.

read_ahead_on() ->
application:get_env(rabbit, stream_read_ahead, true).

-spec read_ahead_limit() -> integer() | undefined.
read_ahead_limit() ->
case application:get_env(rabbit, stream_read_ahead_limit, undefined) of
undefined ->
undefined;
Bytes when is_integer(Bytes) ->
Bytes;
-spec read_ahead() -> boolean() | non_neg_integer().
read_ahead() ->
case application:get_env(rabbit, stream_read_ahead, true) of
Toggle when is_boolean(Toggle) ->
Toggle;
LimitBytes when is_integer(LimitBytes) ->
LimitBytes;
Limit when is_list(Limit) ->
case rabbit_resource_monitor_misc:parse_information_unit(Limit) of
{ok, ParsedLimit} ->
ParsedLimit;
{error, parse_error} ->
?LOG_ERROR("Unable to parse stream read ahead limit value "
"~tp", [Limit]),
undefined
true
end
end.
28 changes: 5 additions & 23 deletions deps/rabbit/test/config_schema_SUITE_data/rabbit.snippets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1224,19 +1224,6 @@ credential_validator.regexp = ^abc\\d+",
]}],
[]},

%%
%% Stream read ahead on/off
Copy link
Collaborator

@the-mikedavis the-mikedavis Nov 12, 2025

Choose a reason for hiding this comment

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

Same here, this was duplicated, probably because of conflicts

%%

{stream_read_ahead,
"
stream.read_ahead = false
",
[{rabbit, [
{stream_read_ahead, false}
]}],
[]},

{stream_replication_port_range,
"
stream.replication.port_range.max = 4600
Expand All @@ -1247,7 +1234,7 @@ credential_validator.regexp = ^abc\\d+",
[]},

%%
%% Stream read ahead on/off
%% Stream read ahead on/off/limit
%%

{stream_read_ahead,
Expand All @@ -1267,25 +1254,20 @@ credential_validator.regexp = ^abc\\d+",
{stream_read_ahead, false}
]}],
[]},

%%
%% Stream read limit
%%
{stream_read_ahead_limit_bytes,
"
stream.read_ahead_limit = 8192
stream.read_ahead = 8192
",
[{rabbit, [
{stream_read_ahead_limit, 8192}
{stream_read_ahead, 8192}
]}],
[]},
{stream_read_ahead_limit_information_unit,
"
stream.read_ahead_limit = 8KiB
stream.read_ahead = 8KiB
",
[{rabbit, [
{stream_read_ahead_limit, "8KiB"}
{stream_read_ahead, "8KiB"}
]}],
[]}

].
3 changes: 1 addition & 2 deletions deps/rabbitmq_stream/src/rabbit_stream_reader.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2814,8 +2814,7 @@ init_reader(ConnectionTransport,
CounterSpec = {{?MODULE, QueueResource, SubscriptionId, self()}, []},
Options0 = #{transport => ConnectionTransport,
chunk_selector => get_chunk_selector(Properties),
read_ahead => rabbit_stream_queue:read_ahead_on(),
read_ahead_limit => rabbit_stream_queue:read_ahead_limit()},
read_ahead => rabbit_stream_queue:read_ahead()},

Options1 = maps:merge(Options0,
rabbit_stream_utils:filter_spec(Properties)),
Expand Down
2 changes: 1 addition & 1 deletion rabbitmq-components.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ dep_jose = hex 1.11.10
dep_khepri = hex 0.17.2
dep_khepri_mnesia_migration = hex 0.8.0
dep_meck = hex 1.0.0
dep_osiris = git https://github.com/rabbitmq/osiris v1.10.1
dep_osiris = git https://github.com/rabbitmq/osiris v1.10.2
dep_prometheus = hex 5.1.1
dep_ra = hex 2.17.1
dep_ranch = hex 2.2.0
Expand Down
Loading