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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
//! Types related to the creation of dataflow raw sources.
//!
//! Raw sources are differential dataflow collections of data directly produced by the
//! upstream service. The main export of this module is [`create_raw_source`],
//! which turns [`RawSourceCreationConfig`]s into the aforementioned streams.
//!
//! The full source, which is the _differential_ stream that represents the actual object
//! created by a `CREATE SOURCE` statement, is created by composing
//! [`create_raw_source`] with
//! decoding, `SourceEnvelope` rendering, and more.
//!
// https://github.com/tokio-rs/prost/issues/237
#![allow(missing_docs)]
#![allow(clippy::needless_borrow)]
use std::cell::RefCell;
use std::collections::{BTreeMap, VecDeque};
use std::convert::Infallible;
use std::hash::{Hash, Hasher};
use std::rc::Rc;
use std::sync::Arc;
use std::time::Duration;
use differential_dataflow::lattice::Lattice;
use differential_dataflow::{AsCollection, Collection, Hashable};
use futures::stream::StreamExt;
use itertools::Itertools;
use mz_ore::cast::CastFrom;
use mz_ore::collections::CollectionExt;
use mz_ore::error::ErrorExt;
use mz_ore::now::NowFn;
use mz_persist_client::cache::PersistClientCache;
use mz_repr::{Diff, GlobalId, RelationDesc, Row};
use mz_storage_types::configuration::StorageConfiguration;
use mz_storage_types::controller::CollectionMetadata;
use mz_storage_types::dyncfgs;
use mz_storage_types::errors::DataflowError;
use mz_storage_types::sources::{
IndexedSourceExport, SourceConnection, SourceExportDataConfig, SourceTimestamp,
};
use mz_timely_util::antichain::AntichainExt;
use mz_timely_util::builder_async::{
Event as AsyncEvent, OperatorBuilder as AsyncOperatorBuilder, PressOnDropButton,
};
use mz_timely_util::capture::PusherCapture;
use mz_timely_util::operator::StreamExt as _;
use mz_timely_util::reclock::reclock;
use timely::container::CapacityContainerBuilder;
use timely::dataflow::channels::pact::Pipeline;
use timely::dataflow::operators::capture::capture::Capture;
use timely::dataflow::operators::capture::{Event, EventPusher};
use timely::dataflow::operators::core::Map as _;
use timely::dataflow::operators::generic::builder_rc::OperatorBuilder;
use timely::dataflow::operators::{Broadcast, CapabilitySet, Concat, Inspect, Leave, Partition};
use timely::dataflow::scopes::Child;
use timely::dataflow::{Scope, Stream};
use timely::order::TotalOrder;
use timely::progress::frontier::MutableAntichain;
use timely::progress::{Antichain, Timestamp};
use timely::{Container, PartialOrder};
use tokio::sync::{watch, Semaphore};
use tokio_stream::wrappers::WatchStream;
use tracing::trace;
use crate::healthcheck::{HealthStatusMessage, HealthStatusUpdate};
use crate::metrics::source::SourceMetrics;
use crate::metrics::StorageMetrics;
use crate::source::reclock::ReclockOperator;
use crate::source::types::{Probe, SourceMessage, SourceOutput, SourceRender, StackedCollection};
use crate::statistics::SourceStatistics;
/// Shared configuration information for all source types. This is used in the
/// `create_raw_source` functions, which produce raw sources.
#[derive(Clone)]
pub struct RawSourceCreationConfig {
/// The name to attach to the underlying timely operator.
pub name: String,
/// The ID of this instantiation of this source.
pub id: GlobalId,
/// The details of the outputs from this ingestion.
pub source_exports: BTreeMap<GlobalId, IndexedSourceExport<CollectionMetadata>>,
/// The ID of the worker on which this operator is executing
pub worker_id: usize,
/// The total count of workers
pub worker_count: usize,
/// Granularity with which timestamps should be closed (and capabilities
/// downgraded).
pub timestamp_interval: Duration,
/// The function to return a now time.
pub now_fn: NowFn,
/// The metrics & registry that each source instantiates.
pub metrics: StorageMetrics,
/// Storage Metadata
pub storage_metadata: CollectionMetadata,
/// The upper frontier this source should resume ingestion at
pub as_of: Antichain<mz_repr::Timestamp>,
/// For each source export, the upper frontier this source should resume ingestion at in the
/// system time domain.
pub resume_uppers: BTreeMap<GlobalId, Antichain<mz_repr::Timestamp>>,
/// For each source export, the upper frontier this source should resume ingestion at in the
/// source time domain.
///
/// Since every source has a different timestamp type we carry the timestamps of this frontier
/// in an encoded `Vec<Row>` form which will get decoded once we reach the connection
/// specialized functions.
pub source_resume_uppers: BTreeMap<GlobalId, Vec<Row>>,
/// A handle to the persist client cache
pub persist_clients: Arc<PersistClientCache>,
/// Place to share statistics updates with storage state.
pub source_statistics: SourceStatistics,
/// Enables reporting the remap operator's write frontier.
pub shared_remap_upper: Rc<RefCell<Antichain<mz_repr::Timestamp>>>,
/// Configuration parameters, possibly from LaunchDarkly
pub config: StorageConfiguration,
/// The ID of this source remap/progress collection.
pub remap_collection_id: GlobalId,
// A semaphore that should be acquired by async operators in order to signal that upstream
// operators should slow down.
pub busy_signal: Arc<Semaphore>,
}
/// Reduced version of [`RawSourceCreationConfig`] that is used when rendering
/// each export.
#[derive(Clone)]
pub struct SourceExportCreationConfig {
/// The ID of this instantiation of this source.
pub id: GlobalId,
/// The ID of the worker on which this operator is executing
pub worker_id: usize,
/// The metrics & registry that each source instantiates.
pub metrics: StorageMetrics,
/// Place to share statistics updates with storage state.
pub source_statistics: SourceStatistics,
}
impl RawSourceCreationConfig {
/// Returns the worker id responsible for handling the given partition.
pub fn responsible_worker<P: Hash>(&self, partition: P) -> usize {
let mut h = std::hash::DefaultHasher::default();
(self.id, partition).hash(&mut h);
let key = usize::cast_from(h.finish());
key % self.worker_count
}
/// Returns true if this worker is responsible for handling the given partition.
pub fn responsible_for<P: Hash>(&self, partition: P) -> bool {
self.responsible_worker(partition) == self.worker_id
}
}
/// Creates a source dataflow operator graph from a source connection. The type of SourceConnection
/// determines the type of connection that _should_ be created.
///
/// This is also the place where _reclocking_
/// (<https://github.com/MaterializeInc/materialize/blob/main/doc/developer/design/20210714_reclocking.md>)
/// happens.
///
/// See the [`source` module docs](crate::source) for more details about how raw
/// sources are used.
///
/// The `resume_stream` parameter will contain frontier updates whenever times are durably
/// recorded which allows the ingestion to release upstream resources.
pub fn create_raw_source<'g, G: Scope<Timestamp = ()>, C>(
scope: &mut Child<'g, G, mz_repr::Timestamp>,
storage_state: &crate::storage_state::StorageState,
committed_upper: &Stream<Child<'g, G, mz_repr::Timestamp>, ()>,
config: RawSourceCreationConfig,
source_connection: C,
start_signal: impl std::future::Future<Output = ()> + 'static,
) -> (
Vec<(
GlobalId,
Collection<Child<'g, G, mz_repr::Timestamp>, SourceOutput<C::Time>, Diff>,
Collection<Child<'g, G, mz_repr::Timestamp>, DataflowError, Diff>,
SourceExportDataConfig,
)>,
Stream<G, HealthStatusMessage>,
Vec<PressOnDropButton>,
)
where
C: SourceConnection + SourceRender + Clone + 'static,
{
let worker_id = config.worker_id;
let id = config.id;
let mut tokens = vec![];
let (ingested_upper_tx, ingested_upper_rx) =
watch::channel(MutableAntichain::new_bottom(C::Time::minimum()));
let (probed_upper_tx, probed_upper_rx) = watch::channel(None);
let source_metrics = Arc::new(
config
.metrics
.get_source_metrics(&config.name, id, worker_id),
);
let timestamp_desc = source_connection.timestamp_desc();
let (remap_collection, remap_token) = remap_operator(
scope,
storage_state,
config.clone(),
probed_upper_rx,
ingested_upper_rx,
timestamp_desc,
);
// Need to broadcast the remap changes to all workers.
let remap_collection = remap_collection.inner.broadcast().as_collection();
tokens.push(remap_token);
let committed_upper = reclock_committed_upper(
&remap_collection,
config.as_of.clone(),
committed_upper,
id,
Arc::clone(&source_metrics),
);
let (reclock_pusher, reclocked) = reclock(&remap_collection, config.as_of.clone());
let streams = demux_source_exports(config.clone(), reclocked);
let config = config.clone();
let (streams, health, source_tokens) = scope.parent.scoped("SourceTimeDomain", move |scope| {
let (source, source_upper, health_stream, source_tokens) = source_render_operator(
scope,
config.clone(),
source_connection,
probed_upper_tx,
committed_upper,
start_signal,
);
source
.inner
.map(move |((output, result), from_time, diff)| {
let result = match result {
Ok(msg) => Ok(SourceOutput {
key: msg.key.clone(),
value: msg.value.clone(),
metadata: msg.metadata.clone(),
from_time: from_time.clone(),
}),
Err(err) => Err(err.clone()),
};
((*output, result), from_time.clone(), *diff)
})
.capture_into(PusherCapture(reclock_pusher));
source_upper.capture_into(FrontierCapture(ingested_upper_tx));
(streams, health_stream.leave(), source_tokens)
});
tokens.extend(source_tokens);
(streams, health, tokens)
}
pub struct FrontierCapture<T>(watch::Sender<MutableAntichain<T>>);
impl<T: Timestamp> EventPusher<T, Vec<Infallible>> for FrontierCapture<T> {
fn push(&mut self, event: Event<T, Vec<Infallible>>) {
match event {
Event::Progress(changes) => self.0.send_modify(|frontier| {
frontier.update_iter(changes);
}),
Event::Messages(_, _) => unreachable!(),
}
}
}
/// Renders the source dataflow fragment from the given [SourceConnection]. This returns a
/// collection timestamped with the source specific timestamp type. Also returns a second stream
/// that can be used to learn about the `source_upper` that all the source reader instances know
/// about. This second stream will be used by the `remap_operator` to mint new timestamp bindings
/// into the remap shard.
fn source_render_operator<G, C>(
scope: &mut G,
config: RawSourceCreationConfig,
source_connection: C,
probed_upper_tx: watch::Sender<Option<Probe<C::Time>>>,
resume_uppers: impl futures::Stream<Item = Antichain<C::Time>> + 'static,
start_signal: impl std::future::Future<Output = ()> + 'static,
) -> (
StackedCollection<G, (usize, Result<SourceMessage, DataflowError>)>,
Stream<G, Infallible>,
Stream<G, HealthStatusMessage>,
Vec<PressOnDropButton>,
)
where
G: Scope<Timestamp = C::Time>,
C: SourceRender + 'static,
{
let source_id = config.id;
let worker_id = config.worker_id;
let source_statistics = config.source_statistics.clone();
let now_fn = config.now_fn.clone();
let timestamp_interval = config.timestamp_interval;
let resume_uppers = resume_uppers.inspect(move |upper| {
let upper = upper.pretty();
trace!(%upper, "timely-{worker_id} source({source_id}) received resume upper");
});
let (input_data, progress, health, stats, probes, tokens) =
source_connection.render(scope, config, resume_uppers, start_signal);
crate::source::statistics::process_statistics(
scope.clone(),
source_id,
worker_id,
stats,
source_statistics.clone(),
);
let name = format!("SourceGenericStats({})", source_id);
let mut builder = AsyncOperatorBuilder::new(name, scope.clone());
let (data_output, data) = builder.new_output::<CapacityContainerBuilder<_>>();
let (progress_output, derived_progress) = builder.new_output::<CapacityContainerBuilder<_>>();
let mut data_input = builder.new_input_for_many(
&input_data.inner,
Pipeline,
[&data_output, &progress_output],
);
let (health_output, derived_health) = builder.new_output::<CapacityContainerBuilder<_>>();
builder.build(move |mut caps| async move {
let health_cap = caps.pop().unwrap();
drop(caps);
let mut statuses_by_idx = BTreeMap::new();
while let Some(event) = data_input.next().await {
let AsyncEvent::Data([cap_data, _cap_progress], mut data) = event else {
continue;
};
for ((output_index, message), _, _) in data.iter() {
let status = match message {
Ok(_) => HealthStatusUpdate::running(),
// All errors coming into the data stream are definite.
// Downstream consumers of this data will preserve this
// status.
Err(ref error) => HealthStatusUpdate::stalled(
error.to_string(),
Some("retracting the errored value may resume the source".to_string()),
),
};
let statuses: &mut Vec<_> = statuses_by_idx.entry(*output_index).or_default();
let status = HealthStatusMessage {
index: *output_index,
namespace: C::STATUS_NAMESPACE.clone(),
update: status,
};
if statuses.last() != Some(&status) {
statuses.push(status);
}
match message {
Ok(message) => {
source_statistics.inc_messages_received_by(1);
let key_len = u64::cast_from(message.key.byte_len());
let value_len = u64::cast_from(message.value.byte_len());
source_statistics.inc_bytes_received_by(key_len + value_len);
}
Err(_) => {}
}
}
data_output.give_container(&cap_data, &mut data);
for statuses in statuses_by_idx.values_mut() {
if statuses.is_empty() {
continue;
}
health_output.give_container(&health_cap, statuses);
statuses.clear()
}
}
});
let progress = progress.unwrap_or(derived_progress);
let probe_stream = match probes {
Some(stream) => stream,
None => synthesize_probes(source_id, &progress, timestamp_interval, now_fn),
};
// Broadcasting does more work than necessary, which would be to exchange the probes to the
// worker that will be the one minting the bindings but we'd have to thread this information
// through and couple the two functions enough that it's not worth the optimization (I think).
probe_stream.broadcast().inspect(move |probe| {
// We don't care if the receiver is gone
let _ = probed_upper_tx.send(Some(probe.clone()));
});
(
data.as_collection(),
progress,
health.concat(&derived_health),
tokens,
)
}
/// Mints new contents for the remap shard based on summaries about the source
/// upper it receives from the raw reader operators.
///
/// Only one worker will be active and write to the remap shard. All source
/// upper summaries will be exchanged to it.
fn remap_operator<G, FromTime>(
scope: &G,
storage_state: &crate::storage_state::StorageState,
config: RawSourceCreationConfig,
mut probed_upper: watch::Receiver<Option<Probe<FromTime>>>,
mut ingested_upper: watch::Receiver<MutableAntichain<FromTime>>,
remap_relation_desc: RelationDesc,
) -> (Collection<G, FromTime, Diff>, PressOnDropButton)
where
G: Scope<Timestamp = mz_repr::Timestamp>,
FromTime: SourceTimestamp,
{
let RawSourceCreationConfig {
name,
id,
source_exports: _,
worker_id,
worker_count,
timestamp_interval,
storage_metadata,
as_of,
resume_uppers: _,
source_resume_uppers: _,
metrics: _,
now_fn,
persist_clients,
source_statistics: _,
shared_remap_upper,
config: _,
remap_collection_id,
busy_signal: _,
} = config;
let read_only_rx = storage_state.read_only_rx.clone();
let chosen_worker = usize::cast_from(id.hashed() % u64::cast_from(worker_count));
let active_worker = chosen_worker == worker_id;
let operator_name = format!("remap({})", id);
let mut remap_op = AsyncOperatorBuilder::new(operator_name, scope.clone());
let (remap_output, remap_stream) = remap_op.new_output::<CapacityContainerBuilder<_>>();
let button = remap_op.build(move |capabilities| async move {
if !active_worker {
// This worker is not writing, so make sure it's "taken out" of the
// calculation by advancing to the empty frontier.
shared_remap_upper.borrow_mut().clear();
return;
}
let mut cap_set = CapabilitySet::from_elem(capabilities.into_element());
let remap_handle = crate::source::reclock::compat::PersistHandle::<FromTime, _>::new(
Arc::clone(&persist_clients),
read_only_rx,
storage_metadata.clone(),
as_of.clone(),
shared_remap_upper,
id,
"remap",
worker_id,
worker_count,
remap_relation_desc,
remap_collection_id,
)
.await
.unwrap_or_else(|e| {
panic!(
"Failed to create remap handle for source {}: {}",
name,
e.display_with_causes()
)
});
let (mut timestamper, mut initial_batch) = ReclockOperator::new(remap_handle).await;
// Emit initial snapshot of the remap_shard, bootstrapping
// downstream reclock operators.
trace!(
"timely-{worker_id} remap({id}) emitting remap snapshot: trace_updates={:?}",
&initial_batch.updates
);
let cap = cap_set.delayed(cap_set.first().unwrap());
remap_output.give_container(&cap, &mut initial_batch.updates);
drop(cap);
cap_set.downgrade(initial_batch.upper);
let mut ticker = tokio::time::interval(timestamp_interval);
ticker.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
let mut prev_probe_ts: Option<mz_repr::Timestamp> = None;
let timestamp_interval_ms: u64 = timestamp_interval
.as_millis()
.try_into()
.expect("huge duration");
while !cap_set.is_empty() {
// Check the reclocking strategy in every iteration, to make it possible to change it
// without restarting the source pipeline.
let reclock_to_latest =
dyncfgs::STORAGE_RECLOCK_TO_LATEST.get(&config.config.config_set());
// If we are reclocking to the latest offset then we only mint bindings after a
// successful probe. Otherwise we fall back to the earlier behavior where we just
// record the ingested frontier.
let mut new_probe = None;
if reclock_to_latest {
new_probe = probed_upper
.wait_for(|new_probe| match (prev_probe_ts, new_probe) {
(None, Some(_)) => true,
(Some(prev_ts), Some(new)) => prev_ts < new.probe_ts,
_ => false,
})
.await
.map(|probe| (*probe).clone())
.unwrap_or_else(|_| {
Some(Probe {
probe_ts: now_fn().into(),
upstream_frontier: Antichain::new(),
})
});
} else {
while prev_probe_ts >= new_probe.as_ref().map(|p| p.probe_ts) {
ticker.tick().await;
// We only proceed if the source upper frontier is not the minimum frontier. This
// makes it so the first binding corresponds to the snapshot of the source, and
// because the first binding always maps to the minimum *target* frontier we
// guarantee that the source will never appear empty.
let upstream_frontier = ingested_upper
.wait_for(|f| *f.frontier() != [FromTime::minimum()])
.await
.unwrap()
.frontier()
.to_owned();
let now = (now_fn)();
let mut probe_ts = now - now % timestamp_interval_ms;
if (now % timestamp_interval_ms) != 0 {
probe_ts += timestamp_interval_ms;
}
new_probe = Some(Probe {
probe_ts: probe_ts.into(),
upstream_frontier,
});
}
};
let probe = new_probe.expect("known to be Some");
prev_probe_ts = Some(probe.probe_ts);
let binding_ts = probe.probe_ts;
let cur_source_upper = probe.upstream_frontier;
let new_into_upper = Antichain::from_elem(binding_ts.step_forward());
let mut remap_trace_batch = timestamper
.mint(binding_ts, new_into_upper, cur_source_upper.borrow())
.await;
trace!(
"timely-{worker_id} remap({id}) minted new bindings: \
updates={:?} \
source_upper={} \
trace_upper={}",
&remap_trace_batch.updates,
cur_source_upper.pretty(),
remap_trace_batch.upper.pretty()
);
let cap = cap_set.delayed(cap_set.first().unwrap());
remap_output.give_container(&cap, &mut remap_trace_batch.updates);
cap_set.downgrade(remap_trace_batch.upper);
}
});
(remap_stream.as_collection(), button.press_on_drop())
}
/// Demultiplexes a combined stream of all source exports into individual collections per source export
fn demux_source_exports<G, FromTime>(
config: RawSourceCreationConfig,
input: Collection<G, (usize, Result<SourceOutput<FromTime>, DataflowError>), Diff>,
) -> Vec<(
GlobalId,
Collection<G, SourceOutput<FromTime>, Diff>,
Collection<G, DataflowError, Diff>,
SourceExportDataConfig,
)>
where
G: Scope<Timestamp = mz_repr::Timestamp>,
FromTime: SourceTimestamp,
{
let RawSourceCreationConfig {
name,
id,
source_exports,
worker_id,
worker_count: _,
timestamp_interval: _,
storage_metadata: _,
as_of: _,
resume_uppers,
source_resume_uppers: _,
metrics,
now_fn: _,
persist_clients: _,
source_statistics: _,
shared_remap_upper: _,
config: _,
remap_collection_id: _,
busy_signal: _,
} = config;
// TODO(guswynn): expose function
let bytes_read_counter = metrics.source_defs.bytes_read.clone();
let source_metrics = metrics.get_source_metrics(&name, id, worker_id);
// Compute the overall resume upper to report for the ingestion
let resume_upper = Antichain::from_iter(resume_uppers.values().flat_map(|f| f.iter().cloned()));
source_metrics
.resume_upper
.set(mz_persist_client::metrics::encode_ts_metric(&resume_upper));
let input = input.inner.inspect_core(move |event| match event {
Ok((_, data)) => {
for ((_idx, result), _time, _diff) in data.iter() {
if let Ok(msg) = result {
bytes_read_counter.inc_by(u64::cast_from(msg.key.byte_len()));
bytes_read_counter.inc_by(u64::cast_from(msg.value.byte_len()));
}
}
}
Err([time]) => source_metrics.capability.set(time.into()),
Err([]) => source_metrics
.capability
.set(mz_repr::Timestamp::MAX.into()),
// `mz_repr::Timestamp` is totally ordered and so there can be at most one element in the
// frontier. If this ever changes we need to rethink how we surface this in metrics. We
// will notice when that happens because the `expect()` will fail.
Err(_) => unreachable!("there can be at most one element for totally ordered times"),
});
// TODO(petrosagg): output the two streams directly
type CB<C> = CapacityContainerBuilder<C>;
let (ok_muxed_stream, err_muxed_stream) = input.map_fallible::<CB<_>, CB<_>, _, _, _>(
"reclock-demux-ok-err",
|((output, r), ts, diff)| match r {
Ok(ok) => Ok(((output, ok), ts, diff)),
Err(err) => Err(((output, err), ts, diff)),
},
);
let exports_by_index = source_exports
.iter()
.map(|(id, export)| (export.ingestion_output, (*id, &export.export.data_config)))
.collect::<BTreeMap<_, _>>();
// We use the output index from the source export to route values to its ok
// and err streams. There is one partition per source export; however,
// source export indices can be non-contiguous, so we need to ensure we have
// at least as many partitions as we reference.
let partition_count = u64::cast_from(
exports_by_index
.keys()
.max()
.expect("source exports must have elements")
+ 1,
);
let ok_streams: Vec<_> = ok_muxed_stream
.partition(partition_count, |((output, data), time, diff)| {
(u64::cast_from(output), (data, time, diff))
})
.into_iter()
.map(|stream| stream.as_collection())
.collect();
let err_streams: Vec<_> = err_muxed_stream
.partition(partition_count, |((output, err), time, diff)| {
(u64::cast_from(output), (err, time, diff))
})
.into_iter()
.map(|stream| stream.as_collection())
.collect();
ok_streams
.into_iter()
.zip_eq(err_streams)
.enumerate()
.filter_map(|(idx, (ok_stream, err_stream))| {
// We only want to return streams for partitions with a data config, which
// indicates that they actually have data. The filtered streams were just
// empty partitions for any non-continuous values in the output indexes.
exports_by_index
.get(&idx)
.map(|export| (export.0, ok_stream, err_stream, (*export.1).clone()))
})
.collect()
}
/// Reclocks an `IntoTime` frontier stream into a `FromTime` frontier stream. This is used for the
/// virtual (through persist) feedback edge so that we convert the `IntoTime` resumption frontier
/// into the `FromTime` frontier that is used with the source's `OffsetCommiter`.
fn reclock_committed_upper<G, FromTime>(
bindings: &Collection<G, FromTime, Diff>,
as_of: Antichain<G::Timestamp>,
committed_upper: &Stream<G, ()>,
id: GlobalId,
metrics: Arc<SourceMetrics>,
) -> impl futures::stream::Stream<Item = Antichain<FromTime>> + 'static
where
G: Scope,
G::Timestamp: Lattice + TotalOrder,
FromTime: SourceTimestamp,
{
let (tx, rx) = watch::channel(Antichain::from_elem(FromTime::minimum()));
let scope = bindings.scope().clone();
let name = format!("ReclockCommitUpper({id})");
let mut builder = OperatorBuilder::new(name, scope);
let mut bindings = builder.new_input(&bindings.inner, Pipeline);
let _ = builder.new_input(committed_upper, Pipeline);
builder.build(move |_| {
// Remap bindings beyond the upper
let mut accepted_times = Vec::new();
// The upper frontier of the bindings
let mut upper = Antichain::from_elem(Timestamp::minimum());
// Remap bindings not beyond upper
let mut ready_times = VecDeque::new();
let mut source_upper = MutableAntichain::new();
move |frontiers| {
// Accept new bindings
while let Some((_, data)) = bindings.next() {
accepted_times.extend(data.drain(..).map(|(from, mut into, diff)| {
into.advance_by(as_of.borrow());
(from, into, diff)
}));
}
// Extract ready bindings
let new_upper = frontiers[0].frontier();
if PartialOrder::less_than(&upper.borrow(), &new_upper) {
upper = new_upper.to_owned();
accepted_times.sort_unstable_by(|a, b| a.1.cmp(&b.1));
// The times are totally ordered so we can binary search to find the prefix that is
// not beyond the upper and extract it into a batch.
let idx = accepted_times.partition_point(|(_, t, _)| !upper.less_equal(t));
ready_times.extend(accepted_times.drain(0..idx));
}
// The received times only accumulate correctly for times beyond the as_of.
if as_of.iter().all(|t| !upper.less_equal(t)) {
let committed_upper = frontiers[1].frontier();
if as_of.iter().all(|t| !committed_upper.less_equal(t)) {
// We have committed this source up until `committed_upper`. Because we have
// required that IntoTime is a total order this will be either a singleton set
// or the empty set.
//
// * Case 1: committed_upper is the empty set {}
//
// There won't be any future IntoTime timestamps that we will produce so we can
// provide feedback to the source that it can forget about everything.
//
// * Case 2: committed_upper is a singleton set {t_next}
//
// We know that t_next cannot be the minimum timestamp because we have required
// that all times of the as_of frontier are not beyond some time of
// committed_upper. Therefore t_next has a predecessor timestamp t_prev.
//
// We don't know what remap[t_next] is yet, but we do know that we will have to
// emit all source updates `u: remap[t_prev] <= time(u) <= remap[t_next]`.
// Since `t_next` is the minimum undetermined timestamp and we know that t1 <=
// t2 => remap[t1] <= remap[t2] we know that we will never need any source
// updates `u: !(remap[t_prev] <= time(u))`.
//
// Therefore we can provide feedback to the source that it can forget about any
// updates that are not beyond remap[t_prev].
//
// Important: We are *NOT* saying that the source can *compact* its data using
// remap[t_prev] as the compaction frontier. If the source were to compact its
// collection to remap[t_prev] we would lose the distinction between updates
// that happened *at* t_prev versus updates that happened ealier and were
// advanced to t_prev. If the source needs to communicate a compaction frontier
// upstream then the specific source implementation needs to further adjust the
// reclocked committed_upper and calculate a suitable compaction frontier in
// the same way we adjust uppers of collections in the controller with the
// LagWriteFrontier read policy.
//
// == What about IntoTime times that are general lattices?
//
// Reversing the upper for a general lattice is much more involved but it boils
// down to computing the meet of all the times in `committed_upper` and then
// treating that as `t_next` (I think). Until we need to deal with that though
// we can just assume TotalOrder.
let reclocked_upper = match committed_upper.as_option() {
Some(t_next) => {
let idx = ready_times.partition_point(|(_, t, _)| t < t_next);
let updates = ready_times
.drain(0..idx)
.map(|(from_time, _, diff)| (from_time, diff));
source_upper.update_iter(updates);
// At this point source_upper contains all updates that are less than
// t_next, which is equal to remap[t_prev]
source_upper.frontier().to_owned()
}
None => Antichain::new(),
};
tx.send_replace(reclocked_upper);
}
}
metrics
.commit_upper_accepted_times
.set(u64::cast_from(accepted_times.len()));
metrics
.commit_upper_ready_times
.set(u64::cast_from(ready_times.len()));
}
});
WatchStream::from_changes(rx)
}
/// Synthesizes a probe stream that produces the frontier of the given progress stream at the given
/// interval.
///
/// This is used as a fallback for sources that don't support probing the frontier of the upstream
/// system.
fn synthesize_probes<G>(
source_id: GlobalId,
progress: &Stream<G, Infallible>,
interval: Duration,
now_fn: NowFn,
) -> Stream<G, Probe<G::Timestamp>>
where
G: Scope,
{
let scope = progress.scope();
let active_worker = usize::cast_from(source_id.hashed()) % scope.peers();
let is_active_worker = active_worker == scope.index();
let mut ticker = tokio::time::interval(interval);
ticker.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Skip);
let mut op = AsyncOperatorBuilder::new("synthesize_probes".into(), scope);
let (output, output_stream) = op.new_output();
let mut input = op.new_input_for(progress, Pipeline, &output);
op.build(|caps| async move {
if !is_active_worker {
return;
}
let [cap] = caps.try_into().expect("one capability per output");
let minimum_frontier = Antichain::from_elem(Timestamp::minimum());
let mut frontier = minimum_frontier.clone();
loop {
tokio::select! {
event = input.next() => match event {
Some(AsyncEvent::Progress(progress)) => frontier = progress,
Some(AsyncEvent::Data(..)) => unreachable!(),
None => break,
},
// We only report a probe if the source upper frontier is not the minimum frontier.
// This makes it so the first remap binding corresponds to the snapshot of the
// source, and because the first binding always maps to the minimum *target*
// frontier we guarantee that the source will never appear empty.
_ = ticker.tick(), if frontier != minimum_frontier => {
let probe = Probe {
probe_ts: now_fn().into(),
upstream_frontier: frontier.clone(),
};
output.give(&cap, probe);
}
}
}
let probe = Probe {
probe_ts: now_fn().into(),
upstream_frontier: Antichain::new(),
};
output.give(&cap, probe);
});
output_stream
}