Skip to content

Disabling the lifo slot and variable shard load by default #5898

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 2 commits into from
Sep 15, 2025
Merged

Disabling the lifo slot and variable shard load by default #5898

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
701cee1
Disabling the lifo slot by default, and variable shard load
fulmicoton-dd Sep 15, 2025
83c3971
Merge branch 'main' into paul.masurel/disable-lifo-slot-by-default
fulmicoton Sep 15, 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
59 changes: 29 additions & 30 deletions quickwit/quickwit-common/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,43 +84,42 @@ pub fn split_file(split_id: impl Display) -> String {
format!("{split_id}.split")
}

pub fn get_from_env<T: FromStr + Debug>(key: &str, default_value: T) -> T {
if let Ok(value_str) = std::env::var(key) {
if let Ok(value) = T::from_str(&value_str) {
info!(value=?value, "using environment variable `{key}` value");
return value;
} else {
error!(value=%value_str, "failed to parse environment variable `{key}` value");
}
}
info!(value=?default_value, "using environment variable `{key}` default value");
default_value
fn get_from_env_opt_aux<T: Debug>(
key: &str,
parse_fn: impl FnOnce(&str) -> Option<T>,
) -> Option<T> {
let value_str = std::env::var(key).ok()?;
let Some(value) = parse_fn(&value_str) else {
error!(value=%value_str, "failed to parse environment variable `{key}` value");
return None;
};
info!(value=?value, "using environment variable `{key}` value");
Some(value)
}

pub fn get_bool_from_env(key: &str, default_value: bool) -> bool {
if let Ok(value_str) = std::env::var(key) {
if let Some(value) = parse_bool_lenient(&value_str) {
info!(value=%value, "using environment variable `{key}` value");
return value;
} else {
error!(value=%value_str, "failed to parse environment variable `{key}` value");
}
pub fn get_from_env<T: FromStr + Debug>(key: &str, default_value: T) -> T {
if let Some(value) = get_from_env_opt(key) {
value
} else {
info!(default_value=?default_value, "using environment variable `{key}` default value");
default_value
}
info!(value=?default_value, "using environment variable `{key}` default value");
default_value
}

pub fn get_from_env_opt<T: FromStr + Debug>(key: &str) -> Option<T> {
let Some(value_str) = std::env::var(key).ok() else {
info!("environment variable `{key}` is not set");
return None;
};
if let Ok(value) = T::from_str(&value_str) {
info!(value=?value, "using environment variable `{key}` value");
Some(value)
get_from_env_opt_aux(key, |val_str| val_str.parse().ok())
}

pub fn get_bool_from_env_opt(key: &str) -> Option<bool> {
get_from_env_opt_aux(key, parse_bool_lenient)
}

pub fn get_bool_from_env(key: &str, default_value: bool) -> bool {
if let Some(flag_value) = get_bool_from_env_opt(key) {
flag_value
} else {
error!(value=%value_str, "failed to parse environment variable `{key}` value");
None
info!(default_value=%default_value, "using environment variable `{key}` default value");
default_value
}
}

Expand Down
2 changes: 1 addition & 1 deletion quickwit/quickwit-common/src/runtimes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ impl Default for RuntimesConfig {
fn start_runtimes(config: RuntimesConfig) -> HashMap<RuntimeType, Runtime> {
let mut runtimes = HashMap::with_capacity(2);

let disable_lifo_slot = crate::get_bool_from_env("QW_DISABLE_TOKIO_LIFO_SLOT", false);
let disable_lifo_slot = crate::get_bool_from_env("QW_DISABLE_TOKIO_LIFO_SLOT", true);

let mut blocking_runtime_builder = tokio::runtime::Builder::new_multi_thread();
if disable_lifo_slot {
Expand Down
27 changes: 26 additions & 1 deletion quickwit/quickwit-control-plane/src/indexing_scheduler/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ use crate::metrics::ShardLocalityMetrics;
use crate::model::{ControlPlaneModel, ShardEntry, ShardLocations};
use crate::{IndexerNodeInfo, IndexerPool};

const DEFAULT_ENABLE_VARIABLE_SHARD_LOAD: bool = false;

pub(crate) const MIN_DURATION_BETWEEN_SCHEDULING: Duration =
if cfg!(any(test, feature = "testsuite")) {
Duration::from_millis(50)
Expand Down Expand Up @@ -121,7 +123,30 @@ impl fmt::Debug for IndexingScheduler {
fn enable_variable_shard_load() -> bool {
static IS_SHARD_LOAD_CP_ENABLED: OnceCell<bool> = OnceCell::new();
*IS_SHARD_LOAD_CP_ENABLED.get_or_init(|| {
!quickwit_common::get_bool_from_env("QW_DISABLE_VARIABLE_SHARD_LOAD", false)
Copy link
Contributor

@PSeitz-dd PSeitz-dd Sep 15, 2025

Choose a reason for hiding this comment

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

In the future I think this pattern would be a bit simpler
QW_VARIABLE_SHARD_LOAD=true|enable
QW_VARIABLE_SHARD_LOAD=false|disable

Copy link
Collaborator Author

@fulmicoton-dd fulmicoton-dd Sep 15, 2025

Choose a reason for hiding this comment

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

I kind of disagree.

But I start thinking that the _DISABLE stuff was not a good idea. (The point was to suggest that the default was enabling of course, but it really sucks when we want to change the default)

if let Some(enable_flag) =
quickwit_common::get_bool_from_env_opt("QW_ENABLE_VARIABLE_SHARD_LOAD")
{
return enable_flag;
}
// For backward compatibility, if QW_DISABLE_VARIABLE_SHARD_LOAD is set, we accept this
// value too.
if let Some(disable_flag) =
quickwit_common::get_bool_from_env_opt("QW_DISABLE_VARIABLE_SHARD_LOAD")
{
warn!(
disable = disable_flag,
"QW_DISABLE_VARIABLE_SHARD_LOAD is deprecated. Please use \
QW_ENABLE_VARIABLE_SHARD_LOAD instead. We will use your setting in this version, \
but will likely ignore it in future versions."
);
return !disable_flag;
}
// Defaulting to false
info!(
"QW_ENABLE_VARIABLE_SHARD_LOAD not set, defaulting to {}",
DEFAULT_ENABLE_VARIABLE_SHARD_LOAD
);
DEFAULT_ENABLE_VARIABLE_SHARD_LOAD
})
}

Expand Down