Struct mz_kafka_util::client::MzClientContext

pub struct MzClientContext;

A ClientContext implementation that uses tracing instead of log macros.

All code in Materialize that constructs Kafka clients should use this context or a custom context that delegates the log and error methods to this implementation.

Trait Implementations

impl ClientContext for MzClientContext

fn log(&self, level: RDKafkaLogLevel, fac: &str, log_message: &str)

Receives log lines from librdkafka.

fn error(&self, error: KafkaError, reason: &str)

Receives global errors from the librdkafka client.

const ENABLE_REFRESH_OAUTH_TOKEN: bool = false

Whether to periodically refresh the SASL OAUTHBEARER token by calling ClientContext::generate_oauth_token.

fn stats(&self, statistics: Statistics)

Receives the decoded statistics of the librdkafka client. To enable, the statistics.interval.ms configuration parameter must be specified.

fn stats_raw(&self, statistics: &[u8])

Receives the JSON-encoded statistics of the librdkafka client. To enable, the statistics.interval.ms configuration parameter must be specified.

fn rewrite_broker_addr(&self, addr: BrokerAddr) -> BrokerAddr

Rewrites a broker address for DNS resolution.

fn generate_oauth_token(
    &self,
    _oauthbearer_config: Option<&str>
) -> Result<OAuthToken, Box<dyn Error + 'static, Global>>

Generates an OAuth token from the provided configuration.

impl ConsumerContext for MzClientContext

fn rebalance(
    &self,
    native_client: &NativeClient,
    err: rd_kafka_resp_err_t,
    tpl: &mut TopicPartitionList
)

Implements the default rebalancing strategy and calls the pre_rebalance and post_rebalance methods. If this method is overridden, it will be responsibility of the user to call them if needed.

fn pre_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Pre-rebalance callback. This method will run before the rebalance and should terminate its execution quickly.

fn post_rebalance<'a>(&self, rebalance: &Rebalance<'a>)

Post-rebalance callback. This method will run after the rebalance and should terminate its execution quickly.

fn commit_callback(
    &self,
    result: Result<(), KafkaError>,
    offsets: &TopicPartitionList
)

Post commit callback. This method will run after a group of offsets was committed to the offset store.

fn main_queue_min_poll_interval(&self) -> Timeout

Returns the minimum interval at which to poll the main queue, which services the logging, stats, and error callbacks.

impl ProducerContext for MzClientContext

type DeliveryOpaque = <DefaultProducerContext as ProducerContext>::DeliveryOpaque

A DeliveryOpaque is a user-defined structure that will be passed to the producer when producing a message, and returned to the delivery method once the message has been delivered, or failed to.

fn delivery(
    &self,
    delivery_result: &DeliveryResult<'_>,
    delivery_opaque: Self::DeliveryOpaque
)

This method will be called once the message has been delivered (or failed to). The DeliveryOpaque will be the one provided by the user when calling send.