Skip to content

feat: Add an optional task appender to AutomaticContainerLogConfig #1255

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

Closed
Churi12 wants to merge 1 commit into from
+105 −1
Closed

feat: Add an optional task appender to AutomaticContainerLogConfig #1255

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
9 changes: 9 additions & 0 deletions crates/stackable-operator/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

### Added

- Add an optional `task` appender to `AutomaticContainerLogConfig`, next to `console` and
`file`. It is only used by products which have a separate task log destination, currently
Airflow, where it sets the log level shown in the web UI. It defaults to unset, so the
rendered configuration of every other product is unchanged ([#1255]).

[#1255]: https://github.com/stackabletech/operator-rs/pull/1255

## [0.114.0] - 2026-07-22

### Added
Expand Down
2 changes: 2 additions & 0 deletions crates/stackable-operator/src/product_logging/framework.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1553,6 +1553,7 @@ mod tests {
file: Some(AppenderConfig {
level: Some(LogLevel::ERROR),
}),
task: None,
};

let log4j2_properties = create_log4j2_config(
Expand Down Expand Up @@ -1601,6 +1602,7 @@ mod tests {
file: Some(AppenderConfig {
level: Some(LogLevel::ERROR),
}),
task: None,
};

let log4j2_properties = create_log4j2_config(
Expand Down
95 changes: 94 additions & 1 deletion crates/stackable-operator/src/product_logging/spec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,12 @@ pub struct AutomaticContainerLogConfig {
pub console: Option<AppenderConfig>,
/// Configuration for the file appender
pub file: Option<AppenderConfig>,
/// Configuration for the task appender
///
/// Only used by products which have a separate task log destination, currently Airflow,
/// where it controls the log level shown in the web UI. Left unset by every other product,
/// in which case it has no effect.
pub task: Option<AppenderConfig>,
}

impl Merge for AutomaticContainerLogConfigFragment {
Expand All @@ -252,6 +258,13 @@ impl Merge for AutomaticContainerLogConfigFragment {
} else {
self.file.clone_from(&defaults.file);
}
if let Some(task) = &mut self.task {
if let Some(defaults_task) = &defaults.task {
task.merge(defaults_task);
}
} else {
self.task.clone_from(&defaults.task);
}
}
}

Expand Down Expand Up @@ -449,6 +462,7 @@ pub fn default_container_log_config() -> ContainerLogConfigFragment {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::INFO),
}),
task: None,
},
)),
}
Expand All @@ -471,7 +485,7 @@ mod tests {
fn serialize_container_log_config() {
// automatic configuration
assert_eq!(
"{\"loggers\":{},\"console\":{\"level\":\"INFO\"},\"file\":{\"level\":\"WARN\"}}"
"{\"loggers\":{},\"console\":{\"level\":\"INFO\"},\"file\":{\"level\":\"WARN\"},\"task\":null}"
.to_string(),
serde_json::to_string(&ContainerLogConfigFragment {
choice: Some(ContainerLogConfigChoiceFragment::Automatic(
Expand All @@ -483,6 +497,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
})
Expand Down Expand Up @@ -519,6 +534,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
},
Expand Down Expand Up @@ -553,6 +569,7 @@ mod tests {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
},
)),
},
Expand Down Expand Up @@ -586,17 +603,20 @@ mod tests {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
},
merge::merge(
AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
}
)
);
Expand All @@ -611,6 +631,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
merge::merge(
AutomaticContainerLogConfigFragment {
Expand All @@ -621,11 +642,13 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
}
)
);
Expand All @@ -640,12 +663,14 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
merge::merge(
AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
Expand All @@ -655,6 +680,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
}
)
);
Expand All @@ -669,6 +695,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::ERROR),
}),
task: None,
},
merge::merge(
AutomaticContainerLogConfigFragment {
Expand All @@ -677,6 +704,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::ERROR),
}),
task: None,
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
Expand All @@ -686,8 +714,66 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
}
)
);
}

#[test]
fn merge_task_appender_config_fragment() {
// The task appender is merged like the console and file appenders. It is handled
// separately here because the Merge implementation is written by hand, so a missing
// block would silently drop the level instead of failing to compile.

// overriding task level + default task level -> overriding task level
assert_eq!(
Some(AppenderConfigFragment {
level: Some(LogLevel::DEBUG),
}),
merge::merge(
AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: Some(AppenderConfigFragment {
level: Some(LogLevel::DEBUG),
}),
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
}
)
.task
);

// no overriding task level + default task level -> default task level
assert_eq!(
Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
merge::merge(
AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: None,
},
&AutomaticContainerLogConfigFragment {
loggers: BTreeMap::new(),
console: None,
file: None,
task: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
}
)
.task
);
}

Expand All @@ -705,6 +791,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
},
Expand All @@ -719,6 +806,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
},
Expand Down Expand Up @@ -746,6 +834,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
},
Expand All @@ -758,6 +847,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
},
Expand All @@ -769,6 +859,7 @@ mod tests {
level: Some(LogLevel::INFO),
}),
file: Some(AppenderConfigFragment { level: None }),
task: None,
},
)),
}
Expand All @@ -789,6 +880,7 @@ mod tests {
file: Some(AppenderConfig {
level: Some(LogLevel::WARN)
}),
task: None,
}
))
},
Expand All @@ -802,6 +894,7 @@ mod tests {
file: Some(AppenderConfigFragment {
level: Some(LogLevel::WARN),
}),
task: None,
},
)),
})
Expand Down
Loading