stratus/infra/kafka/
kafka.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
use anyhow::Result;
use clap::Parser;
use clap::ValueEnum;
use display_json::DebugAsJson;
use futures::Stream;
use futures::StreamExt;
use rdkafka::message::Header;
use rdkafka::message::OwnedHeaders;
use rdkafka::producer::future_producer::OwnedDeliveryResult;
use rdkafka::producer::DeliveryFuture;
use rdkafka::producer::FutureProducer;
use rdkafka::producer::FutureRecord;
use rdkafka::ClientConfig;

use crate::infra::metrics;
use crate::ledger::events::Event;
use crate::log_and_err;

#[derive(Parser, DebugAsJson, Clone, serde::Serialize, serde::Deserialize, Default)]
#[group(requires_all = ["bootstrap_servers", "topic", "client_id", "ImporterConfig"])]
pub struct KafkaConfig {
    #[arg(long = "kafka-bootstrap-servers", env = "KAFKA_BOOTSTRAP_SERVERS", required = false)]
    pub bootstrap_servers: String,

    #[arg(long = "kafka-topic", env = "KAFKA_TOPIC", group = "kafka", required = false)]
    pub topic: String,

    #[arg(long = "kafka-client-id", env = "KAFKA_CLIENT_ID", required = false)]
    pub client_id: String,

    #[arg(long = "kafka-group-id", env = "KAFKA_GROUP_ID", required = false)]
    pub group_id: Option<String>,

    #[arg(long = "kafka-security-protocol", env = "KAFKA_SECURITY_PROTOCOL", required = false, default_value_t)]
    pub security_protocol: KafkaSecurityProtocol,

    #[arg(long = "kafka-sasl-mechanisms", env = "KAFKA_SASL_MECHANISMS", required = false)]
    pub sasl_mechanisms: Option<String>,

    #[arg(long = "kafka-sasl-username", env = "KAFKA_SASL_USERNAME", required = false)]
    pub sasl_username: Option<String>,

    #[arg(long = "kafka-sasl-password", env = "KAFKA_SASL_PASSWORD", required = false)]
    pub sasl_password: Option<String>,

    #[arg(long = "kafka-ssl-ca-location", env = "KAFKA_SSL_CA_LOCATION", required = false)]
    pub ssl_ca_location: Option<String>,

    #[arg(long = "kafka-ssl-certificate-location", env = "KAFKA_SSL_CERTIFICATE_LOCATION", required = false)]
    pub ssl_certificate_location: Option<String>,

    #[arg(long = "kafka-ssl-key-location", env = "KAFKA_SSL_KEY_LOCATION", required = false)]
    pub ssl_key_location: Option<String>,
}

impl KafkaConfig {
    pub fn init(&self) -> Result<KafkaConnector> {
        KafkaConnector::new(self)
    }
}

#[derive(Clone)]
pub struct KafkaConnector {
    producer: FutureProducer,
    topic: String,
}

#[derive(Clone, Copy, serde::Serialize, serde::Deserialize, ValueEnum, Default)]
pub enum KafkaSecurityProtocol {
    #[default]
    None,
    SaslSsl,
    Ssl,
}

impl std::fmt::Display for KafkaSecurityProtocol {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            KafkaSecurityProtocol::None => write!(f, "none"),
            KafkaSecurityProtocol::SaslSsl => write!(f, "sasl_ssl"),
            KafkaSecurityProtocol::Ssl => write!(f, "ssl"),
        }
    }
}

impl KafkaConnector {
    #[allow(clippy::expect_used)]
    pub fn new(config: &KafkaConfig) -> Result<Self> {
        tracing::info!(
            topic = %config.topic,
            bootstrap_servers = %config.bootstrap_servers,
            client_id = %config.client_id,
            "Creating Kafka connector"
        );

        let security_protocol = config.security_protocol;
        let mut client_config = ClientConfig::new()
            .set("bootstrap.servers", &config.bootstrap_servers)
            .set("client.id", &config.client_id)
            .set("linger.ms", "5")
            .set("batch.size", "1048576") // 1 MB
            .to_owned();

        let producer = match security_protocol {
            KafkaSecurityProtocol::None => client_config.create()?,
            KafkaSecurityProtocol::SaslSsl => client_config
                .set("security.protocol", "SASL_SSL")
                .set(
                    "sasl.mechanisms",
                    config.sasl_mechanisms.as_ref().expect("sasl mechanisms is required").as_str(),
                )
                .set("sasl.username", config.sasl_username.as_ref().expect("sasl username is required").as_str())
                .set("sasl.password", config.sasl_password.as_ref().expect("sasl password is required").as_str())
                .create()?,
            KafkaSecurityProtocol::Ssl => client_config
                .set(
                    "ssl.ca.location",
                    config.ssl_ca_location.as_ref().expect("ssl ca location is required").as_str(),
                )
                .set(
                    "ssl.certificate.location",
                    config.ssl_certificate_location.as_ref().expect("ssl certificate location is required").as_str(),
                )
                .set(
                    "ssl.key.location",
                    config.ssl_key_location.as_ref().expect("ssl key location is required").as_str(),
                )
                .create()?,
        };

        Ok(Self {
            producer,
            topic: config.topic.clone(),
        })
    }

    pub fn queue_event<T: Event>(&self, event: T) -> Result<DeliveryFuture> {
        tracing::debug!(?event, "queueing event");

        // prepare base payload
        let headers = event.event_headers()?;
        let key = event.event_key()?;
        let payload = event.event_payload()?;

        // prepare kafka payload
        let mut kafka_headers = OwnedHeaders::new_with_capacity(headers.len());
        for (key, value) in headers.iter() {
            let header = Header { key, value: Some(value) };
            kafka_headers = kafka_headers.insert(header);
        }
        let kafka_record = FutureRecord::to(&self.topic).payload(&payload).key(&key).headers(kafka_headers);

        // publis and handle response
        tracing::info!(%key, %payload, ?headers, "publishing kafka event");
        match self.producer.send_result(kafka_record) {
            Err((e, _)) => log_and_err!(reason = e, "failed to queue kafka event"),
            Ok(fut) => Ok(fut),
        }
    }

    pub async fn send_event<T: Event>(&self, event: T) -> Result<()> {
        tracing::debug!(?event, "sending event");
        handle_delivery_result(self.queue_event(event)?.await)
    }

    pub fn create_buffer<T, I>(&self, events: I, buffer_size: usize) -> Result<impl Stream<Item = Result<()>>>
    where
        T: Event,
        I: IntoIterator<Item = T>,
    {
        #[cfg(feature = "metrics")]
        let start = metrics::now();

        let futures: Vec<DeliveryFuture> = events
            .into_iter()
            .map(|event| {
                metrics::timed(|| self.queue_event(event)).with(|m| {
                    metrics::inc_kafka_queue_event(m.elapsed);
                })
            })
            .collect::<Result<Vec<_>, _>>()?; // This could fail because the queue is full (?)

        #[cfg(feature = "metrics")]
        metrics::inc_kafka_create_buffer(start.elapsed());

        Ok(futures::stream::iter(futures).buffered(buffer_size).map(handle_delivery_result))
    }

    pub async fn send_buffered<T, I>(&self, events: I, buffer_size: usize) -> Result<()>
    where
        T: Event,
        I: IntoIterator<Item = T>,
    {
        #[cfg(feature = "metrics")]
        let start = metrics::now();

        tracing::info!(?buffer_size, "sending events");

        let mut buffer = self.create_buffer(events, buffer_size)?;
        while let Some(res) = buffer.next().await {
            if let Err(e) = res {
                return log_and_err!(reason = e, "failed to send events");
            }
        }

        #[cfg(feature = "metrics")]
        metrics::inc_kafka_send_buffered(start.elapsed());
        Ok(())
    }
}

fn handle_delivery_result(res: Result<OwnedDeliveryResult, futures_channel::oneshot::Canceled>) -> Result<()> {
    match res {
        Err(e) => log_and_err!(reason = e, "failed to publish kafka event"),
        Ok(Err((e, _))) => log_and_err!(reason = e, "failed to publish kafka event"),
        Ok(_) => Ok(()),
    }
}