Skip to content

feat: kafka extended configuration for SASL auth & TLS #355

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 2 commits into
base: main
Choose a base branch
from
Open

feat: kafka extended configuration for SASL auth & TLS #355

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
813d02f
feat: define kafka extended configuration from config
aldy505 Jul 5, 2025
98b64e6
feat: apply kafka config on manager
aldy505 Jul 5, 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
71 changes: 70 additions & 1 deletion src/app/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,32 @@ pub struct MetricsConfig {
pub hostname_tag: Option<String>,
}

#[serde_as]
#[derive(PartialEq, Debug, Serialize, Deserialize)]
pub struct KafkaConfig {
/// Kafka security protocol to use. The value must be one of "plaintext, "ssl", "sasl_plaintext", "sasl_ssl".
/// If not specified, defaults to "plaintext".
pub kafka_security_protocol: Option<String>,
Copy link
Contributor

@klochek klochek Oct 10, 2025

Choose a reason for hiding this comment

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

If these are the only possible options, let's represent them as an enum, then.


/// TLS CA certificate location for Kafka.
pub kafka_ssl_ca_location: Option<String>,

/// TLS certificate location for Kafka.
pub kafka_ssl_cert_location: Option<String>,

/// TLS private key location for Kafka.
pub kafka_ssl_key_location: Option<String>,

/// SASL mechanism to use for Kafka. The value must be one of "PLAIN", "SCRAM-SHA-256", "SCRAM-SHA-512".
pub kafka_sasl_mechanism: Option<String>,

/// SASL username for Kafka.
pub kafka_sasl_username: Option<String>,

/// SASL password for Kafka.
pub kafka_sasl_password: Option<String>,
}

#[serde_as]
#[derive(PartialEq, Debug, Serialize, Deserialize)]
pub struct Config {
Expand Down Expand Up @@ -86,6 +112,10 @@ pub struct Config {
/// The topic to produce uptime checks into.
pub results_kafka_topic: String,

/// Kafka extended configuration
#[serde(flatten)]
Copy link
Contributor

@klochek klochek Oct 10, 2025

Choose a reason for hiding this comment

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

Should be able to use #[serde(flatten, with = "kafka_")], and then not have to have the kafka_ prefix on all those struct field names

pub kafka_config: KafkaConfig,

/// Which config provider to use to load configs into memory
pub config_provider_mode: ConfigProviderMode,

Expand Down Expand Up @@ -172,6 +202,15 @@ impl Default for Config {
},
results_kafka_cluster: vec!["127.0.0.1:9092".to_owned()],
results_kafka_topic: "uptime-results".to_owned(),
kafka_config: KafkaConfig {
Copy link
Contributor

@klochek klochek Oct 10, 2025

Choose a reason for hiding this comment

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

Lets's derive a default for KafkaConfig, so that we can just use that here.

kafka_security_protocol: None,
kafka_ssl_ca_location: None,
kafka_ssl_cert_location: None,
kafka_ssl_key_location: None,
kafka_sasl_mechanism: None,
kafka_sasl_username: None,
kafka_sasl_password: None,
},
config_provider_mode: ConfigProviderMode::Redis,
checker_mode: CheckerMode::Reqwest,
vector_batch_size: 10,
Expand Down Expand Up @@ -261,7 +300,9 @@ mod tests {

use crate::{app::cli, logging};

use super::{CheckerMode, Config, ConfigProviderMode, MetricsConfig, ProducerMode};
use super::{
CheckerMode, Config, ConfigProviderMode, KafkaConfig, MetricsConfig, ProducerMode,
};

fn test_with_config<F>(yaml: &str, env_vars: &[(&str, &str)], test_fn: F)
where
Expand Down Expand Up @@ -326,6 +367,15 @@ mod tests {
"10.0.0.2:9000".to_owned()
],
results_kafka_topic: "uptime-results".to_owned(),
kafka_config: KafkaConfig {
kafka_security_protocol: None,
kafka_ssl_ca_location: None,
kafka_ssl_cert_location: None,
kafka_ssl_key_location: None,
kafka_sasl_mechanism: None,
kafka_sasl_username: None,
kafka_sasl_password: None,
},
config_provider_mode: ConfigProviderMode::Redis,
checker_mode: CheckerMode::Reqwest,
config_provider_redis_update_ms: 1000,
Expand Down Expand Up @@ -371,6 +421,16 @@ mod tests {
"UPTIME_CHECKER_CONFIGS_KAFKA_CLUSTER",
"10.0.0.1,10.0.0.2:7000",
),
("UPTIME_CHECKER_KAFKA_SECURITY_PROTOCOL", "plaintext"),
("UPTIME_CHECKER_KAFKA_SSL_CA_LOCATION", "/path/to/ca.crt"),
(
"UPTIME_CHECKER_KAFKA_SSL_CERT_LOCATION",
"/path/to/cert.crt",
),
("UPTIME_CHECKER_KAFKA_SSL_KEY_LOCATION", "/path/to/key.key"),
("UPTIME_CHECKER_KAFKA_SASL_MECHANISM", "scram-sha-256"),
("UPTIME_CHECKER_KAFKA_SASL_USERNAME", "my_user"),
("UPTIME_CHECKER_KAFKA_SASL_PASSWORD", "my_password"),
("UPTIME_CHECKER_CONFIG_PROVIDER_MODE", "redis"),
("UPTIME_CHECKER_CONFIG_PROVIDER_REDIS_UPDATE_MS", "2000"),
(
Expand Down Expand Up @@ -415,6 +475,15 @@ mod tests {
"10.0.0.2:7000".to_owned()
],
results_kafka_topic: "uptime-results".to_owned(),
kafka_config: KafkaConfig {
kafka_security_protocol: Some("plaintext".to_owned()),
kafka_ssl_ca_location: Some("/path/to/ca.crt".to_owned()),
kafka_ssl_cert_location: Some("/path/to/cert.crt".to_owned()),
kafka_ssl_key_location: Some("/path/to/key.key".to_owned()),
kafka_sasl_mechanism: Some("scram-sha-256".to_owned()),
kafka_sasl_username: Some("my_user".to_owned()),
kafka_sasl_password: Some("my_password".to_owned()),
},
config_provider_mode: ConfigProviderMode::Redis,
checker_mode: CheckerMode::Reqwest,
config_provider_redis_update_ms: 2000,
Expand Down
50 changes: 49 additions & 1 deletion src/manager.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,56 @@ impl Manager {
(sender, handle, results_worker)
}
ProducerMode::Kafka => {
let kafka_overrides =
let mut kafka_overrides =
HashMap::from([("compression.type".to_string(), "lz4".to_string())]);

if let Some(kafka_ssl_ca_location) = &config.kafka_config.kafka_ssl_ca_location {
kafka_overrides.insert(
"ssl.ca.location".to_string(),
kafka_ssl_ca_location.to_owned(),
);
}

if let Some(kafka_ssl_cert_location) = &config.kafka_config.kafka_ssl_cert_location
{
kafka_overrides.insert(
"ssl.certificate.location".to_string(),
kafka_ssl_cert_location.to_owned(),
);
}

if let Some(kafka_ssl_key_location) = &config.kafka_config.kafka_ssl_key_location {
kafka_overrides.insert(
"ssl.key.location".to_string(),
kafka_ssl_key_location.to_owned(),
);
}

if let Some(kafka_security_protocol) = &config.kafka_config.kafka_security_protocol
{
kafka_overrides.insert(
"security.protocol".to_string(),
kafka_security_protocol.to_owned(),
);
}

if let Some(kafka_sasl_mechanism) = &config.kafka_config.kafka_sasl_mechanism {
kafka_overrides.insert(
"sasl.mechanism".to_string(),
kafka_sasl_mechanism.to_owned(),
);
}

if let Some(kafka_sasl_username) = &config.kafka_config.kafka_sasl_username {
kafka_overrides
.insert("sasl.username".to_string(), kafka_sasl_username.to_owned());
}

if let Some(kafka_sasl_password) = &config.kafka_config.kafka_sasl_password {
kafka_overrides
.insert("sasl.password".to_string(), kafka_sasl_password.to_owned());
}

let kafka_config = KafkaConfig::new_config(
config.results_kafka_cluster.to_owned(),
Some(kafka_overrides),
Expand Down
Loading