Skip to content

Redact sensitive information in developer API debug output. Closes #6132 #6191

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
guilload merged 3 commits into from
Mar 5, 2026
Merged

Redact sensitive information in developer API debug output. Closes #6132 #6191

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3aa57c2
Redact sensitive information in developer API debug output. Closes #6132
osyniakov Mar 4, 2026
f47e731
Merge branch 'main' into fix/mask-sensitive-credentials-in-developer-api
osyniakov Mar 5, 2026
7a7209b
Merge branch 'main' into fix/mask-sensitive-credentials-in-developer-api
ncoiffier-celonis Mar 5, 2026
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: 14 additions & 2 deletions quickwit/quickwit-serve/src/developer_api/server.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,14 @@ impl DeveloperService for DeveloperApiServer {

let cluster_snapshot = self.cluster.snapshot().await;

// We must redact sensitive information such as credentials.
let mut node_config = (*self.node_config).clone();
node_config.redact();

let mut debug_info = json!({
"build_info": BuildInfo::get(),
"runtime_info": RuntimeInfo::get(),
"node_config": self.node_config,
"node_config": node_config,
"cluster_membership_info": json!({
"ready_nodes": cluster_snapshot.ready_nodes,
"live_nodes": cluster_snapshot.live_nodes,
Expand Down Expand Up @@ -137,7 +141,10 @@ mod tests {
.await
.unwrap();

let node_config = Arc::new(NodeConfig::for_test());
let mut node_config = NodeConfig::for_test();
node_config.metastore_uri =
quickwit_common::uri::Uri::for_test("postgresql://username:password@db");
let node_config = Arc::new(node_config);

let developer_api_server = DeveloperApiServer {
node_config,
Expand All @@ -155,6 +162,11 @@ mod tests {
assert!(debug_info["node_config"].is_object());
assert!(debug_info["cluster_membership_info"].is_object());

assert_eq!(
debug_info["node_config"]["metastore_uri"],
"postgresql://username:***redacted***@db"
);

// TODO: Test control plane and ingester debug info.
}
}