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 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
// 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.
//! A controller that provides an interface to the compute layer, and the storage layer below it.
//!
//! The compute controller manages the creation, maintenance, and removal of compute instances.
//! This involves ensuring the intended service state with the orchestrator, as well as maintaining
//! a dedicated compute instance controller for each active compute instance.
//!
//! For each compute instance, the compute controller curates the creation of indexes and sinks
//! installed on the instance, the progress of readers through these collections, and their
//! eventual dropping and resource reclamation.
//!
//! The state maintained for a compute instance can be viewed as a partial map from `GlobalId` to
//! collection. It is an error to use an identifier before it has been "created" with
//! `create_dataflow()`. Once created, the controller holds a read capability for each output
//! collection of a dataflow, which is manipulated with `set_read_policy()`. Eventually, a
//! collection is dropped with `drop_collections()`.
//!
//! Created dataflows will prevent the compaction of their inputs, including other compute
//! collections but also collections managed by the storage layer. Each dataflow input is prevented
//! from compacting beyond the allowed compaction of each of its outputs, ensuring that we can
//! recover each dataflow to its current state in case of failure or other reconfiguration.
use std::collections::{BTreeMap, BTreeSet};
use std::num::NonZeroI64;
use std::sync::{Arc, Mutex};
use std::time::Duration;
use differential_dataflow::consolidation::consolidate;
use futures::stream::FuturesUnordered;
use futures::{FutureExt, StreamExt};
use mz_build_info::BuildInfo;
use mz_cluster_client::client::ClusterReplicaLocation;
use mz_cluster_client::{ReplicaId, WallclockLagFn};
use mz_compute_types::dataflows::DataflowDescription;
use mz_compute_types::ComputeInstanceId;
use mz_dyncfg::ConfigSet;
use mz_expr::RowSetFinishing;
use mz_ore::cast::CastFrom;
use mz_ore::collections::CollectionExt;
use mz_ore::metrics::MetricsRegistry;
use mz_ore::now::NowFn;
use mz_ore::tracing::OpenTelemetryContext;
use mz_repr::{Datum, Diff, GlobalId, Row, TimestampManipulation};
use mz_storage_client::controller::{IntrospectionType, StorageController, StorageWriteOp};
use mz_storage_types::read_holds::ReadHold;
use mz_storage_types::read_policy::ReadPolicy;
use prometheus::proto::LabelPair;
use serde::{Deserialize, Serialize};
use timely::progress::{Antichain, ChangeBatch, Timestamp};
use timely::PartialOrder;
use tokio::sync::{mpsc, oneshot};
use tokio::time::{self, MissedTickBehavior};
use tracing::debug_span;
use uuid::Uuid;
use crate::controller::error::{
CollectionLookupError, CollectionMissing, CollectionUpdateError, DataflowCreationError,
HydrationCheckBadTarget, InstanceExists, InstanceMissing, PeekError, ReadPolicyError,
ReplicaCreationError, ReplicaDropError,
};
use crate::controller::instance::{Instance, SharedCollectionState};
use crate::controller::replica::ReplicaConfig;
use crate::logging::{LogVariant, LoggingConfig};
use crate::metrics::ComputeControllerMetrics;
use crate::protocol::command::{ComputeParameters, PeekTarget};
use crate::protocol::response::{PeekResponse, SubscribeBatch};
use crate::service::{ComputeClient, ComputeGrpcClient};
mod instance;
mod replica;
mod sequential_hydration;
pub mod error;
type IntrospectionUpdates = (IntrospectionType, Vec<(Row, Diff)>);
type StorageCollections<T> = Arc<
dyn mz_storage_client::storage_collections::StorageCollections<Timestamp = T> + Send + Sync,
>;
/// A composite trait for types that serve as timestamps in the Compute Controller.
/// `Into<Datum<'a>>` is needed for writing timestamps to introspection collections.
pub trait ComputeControllerTimestamp: TimestampManipulation + Into<Datum<'static>> {}
impl ComputeControllerTimestamp for mz_repr::Timestamp {}
/// Responses from the compute controller.
#[derive(Debug)]
pub enum ComputeControllerResponse<T> {
/// See [`PeekNotification`].
PeekNotification(Uuid, PeekNotification, OpenTelemetryContext),
/// See [`crate::protocol::response::ComputeResponse::SubscribeResponse`].
SubscribeResponse(GlobalId, SubscribeBatch<T>),
/// The response from a dataflow containing an `CopyToS3Oneshot` sink.
///
/// The `GlobalId` identifies the sink. The `Result` is the response from
/// the sink, where an `Ok(n)` indicates that `n` rows were successfully
/// copied to S3 and an `Err` indicates that an error was encountered
/// during the copy operation.
///
/// For a given `CopyToS3Oneshot` sink, there will be at most one `CopyToResponse`
/// produced. (The sink may produce no responses if its dataflow is dropped
/// before completion.)
CopyToResponse(GlobalId, Result<u64, anyhow::Error>),
/// A response reporting advancement of a collection's upper frontier.
///
/// Once a collection's upper (aka "write frontier") has advanced to beyond a given time, the
/// contents of the collection as of that time have been sealed and cannot change anymore.
FrontierUpper {
/// The ID of a compute collection.
id: GlobalId,
/// The new upper frontier of the identified compute collection.
upper: Antichain<T>,
},
}
/// Notification and summary of a received and forwarded [`crate::protocol::response::ComputeResponse::PeekResponse`].
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
pub enum PeekNotification {
/// Returned rows of a successful peek.
Success {
/// Number of rows in the returned peek result.
rows: u64,
},
/// Error of an unsuccessful peek, including the reason for the error.
Error(String),
/// The peek was canceled.
Canceled,
}
impl PeekNotification {
/// Construct a new [`PeekNotification`] from a [`PeekResponse`]. The `offset` and `limit`
/// parameters are used to calculate the number of rows in the peek result.
fn new(peek_response: &PeekResponse, offset: usize, limit: Option<usize>) -> Self {
match peek_response {
PeekResponse::Rows(rows) => Self::Success {
rows: u64::cast_from(rows.count(offset, limit)),
},
PeekResponse::Error(err) => Self::Error(err.clone()),
PeekResponse::Canceled => Self::Canceled,
}
}
}
/// Replica configuration
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
pub struct ComputeReplicaConfig {
/// TODO(database-issues#7533): Add documentation.
pub logging: ComputeReplicaLogging,
}
/// Logging configuration of a replica.
#[derive(Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Serialize, Deserialize)]
pub struct ComputeReplicaLogging {
/// Whether to enable logging for the logging dataflows.
pub log_logging: bool,
/// The interval at which to log.
///
/// A `None` value indicates that logging is disabled.
pub interval: Option<Duration>,
}
impl ComputeReplicaLogging {
/// Return whether logging is enabled.
pub fn enabled(&self) -> bool {
self.interval.is_some()
}
}
/// A controller for the compute layer.
pub struct ComputeController<T: ComputeControllerTimestamp> {
instances: BTreeMap<ComputeInstanceId, InstanceState<T>>,
/// A map from an instance ID to an arbitrary string that describes the
/// class of the workload that compute instance is running (e.g.,
/// `production` or `staging`).
instance_workload_classes: Arc<Mutex<BTreeMap<ComputeInstanceId, Option<String>>>>,
build_info: &'static BuildInfo,
/// A handle providing access to storage collections.
storage_collections: StorageCollections<T>,
/// Set to `true` once `initialization_complete` has been called.
initialized: bool,
/// Whether or not this controller is in read-only mode.
///
/// When in read-only mode, neither this controller nor the instances
/// controlled by it are allowed to affect changes to external systems
/// (largely persist).
read_only: bool,
/// Compute configuration to apply to new instances.
config: ComputeParameters,
/// `arrangement_exert_proportionality` value passed to new replicas.
arrangement_exert_proportionality: u32,
/// A controller response to be returned on the next call to [`ComputeController::process`].
stashed_response: Option<ComputeControllerResponse<T>>,
/// A number that increases on every `environmentd` restart.
envd_epoch: NonZeroI64,
/// The compute controller metrics.
metrics: ComputeControllerMetrics,
/// A function that produces the current wallclock time.
now: NowFn,
/// A function that computes the lag between the given time and wallclock time.
wallclock_lag: WallclockLagFn<T>,
/// Dynamic system configuration.
///
/// Updated through `ComputeController::update_configuration` calls and shared with all
/// subcomponents of the compute controller.
dyncfg: Arc<ConfigSet>,
/// Receiver for responses produced by `Instance`s.
response_rx: mpsc::UnboundedReceiver<ComputeControllerResponse<T>>,
/// Response sender that's passed to new `Instance`s.
response_tx: mpsc::UnboundedSender<ComputeControllerResponse<T>>,
/// Receiver for introspection updates produced by `Instance`s.
introspection_rx: crossbeam_channel::Receiver<IntrospectionUpdates>,
/// Introspection updates sender that's passed to new `Instance`s.
introspection_tx: crossbeam_channel::Sender<IntrospectionUpdates>,
/// Ticker for scheduling periodic maintenance work.
maintenance_ticker: tokio::time::Interval,
/// Whether maintenance work was scheduled.
maintenance_scheduled: bool,
}
impl<T: ComputeControllerTimestamp> ComputeController<T> {
/// Construct a new [`ComputeController`].
pub fn new(
build_info: &'static BuildInfo,
storage_collections: StorageCollections<T>,
envd_epoch: NonZeroI64,
read_only: bool,
metrics_registry: MetricsRegistry,
now: NowFn,
wallclock_lag: WallclockLagFn<T>,
) -> Self {
let (response_tx, response_rx) = mpsc::unbounded_channel();
let (introspection_tx, introspection_rx) = crossbeam_channel::unbounded();
let mut maintenance_ticker = time::interval(Duration::from_secs(1));
maintenance_ticker.set_missed_tick_behavior(MissedTickBehavior::Skip);
let instance_workload_classes = Arc::new(Mutex::new(BTreeMap::<
ComputeInstanceId,
Option<String>,
>::new()));
// Apply a `workload_class` label to all metrics in the registry that
// have an `instance_id` label for an instance whose workload class is
// known.
metrics_registry.register_postprocessor({
let instance_workload_classes = Arc::clone(&instance_workload_classes);
move |metrics| {
let instance_workload_classes = instance_workload_classes
.lock()
.expect("lock poisoned")
.iter()
.map(|(id, workload_class)| (id.to_string(), workload_class.clone()))
.collect::<BTreeMap<String, Option<String>>>();
for metric in metrics {
'metric: for metric in metric.mut_metric() {
for label in metric.get_label() {
if label.get_name() == "instance_id" {
if let Some(workload_class) = instance_workload_classes
.get(label.get_value())
.cloned()
.flatten()
{
let mut label = LabelPair::default();
label.set_name("workload_class".into());
label.set_value(workload_class.clone());
let mut labels = metric.take_label();
labels.push(label);
metric.set_label(labels);
}
continue 'metric;
}
}
}
}
}
});
Self {
instances: BTreeMap::new(),
instance_workload_classes,
build_info,
storage_collections,
initialized: false,
read_only,
config: Default::default(),
arrangement_exert_proportionality: 16,
stashed_response: None,
envd_epoch,
metrics: ComputeControllerMetrics::new(metrics_registry),
now,
wallclock_lag,
dyncfg: Arc::new(mz_dyncfgs::all_dyncfgs()),
response_rx,
response_tx,
introspection_rx,
introspection_tx,
maintenance_ticker,
maintenance_scheduled: false,
}
}
/// TODO(database-issues#7533): Add documentation.
pub fn instance_exists(&self, id: ComputeInstanceId) -> bool {
self.instances.contains_key(&id)
}
/// Return a reference to the indicated compute instance.
fn instance(&self, id: ComputeInstanceId) -> Result<&InstanceState<T>, InstanceMissing> {
self.instances.get(&id).ok_or(InstanceMissing(id))
}
/// Return a mutable reference to the indicated compute instance.
fn instance_mut(
&mut self,
id: ComputeInstanceId,
) -> Result<&mut InstanceState<T>, InstanceMissing> {
self.instances.get_mut(&id).ok_or(InstanceMissing(id))
}
/// List the IDs of all collections in the identified compute instance.
pub fn collection_ids(
&self,
instance_id: ComputeInstanceId,
) -> Result<impl Iterator<Item = GlobalId> + '_, InstanceMissing> {
let instance = self.instance(instance_id)?;
let ids = instance.collections.keys().copied();
Ok(ids)
}
/// Return the frontiers of the indicated collection.
///
/// If an `instance_id` is provided, the collection is assumed to be installed on that
/// instance. Otherwise all available instances are searched.
pub fn collection_frontiers(
&self,
collection_id: GlobalId,
instance_id: Option<ComputeInstanceId>,
) -> Result<CollectionFrontiers<T>, CollectionLookupError> {
let collection = match instance_id {
Some(id) => self.instance(id)?.collection(collection_id)?,
None => self
.instances
.values()
.find_map(|i| i.collections.get(&collection_id))
.ok_or(CollectionMissing(collection_id))?,
};
Ok(collection.frontiers())
}
/// List compute collections that depend on the given collection.
pub fn collection_reverse_dependencies(
&self,
instance_id: ComputeInstanceId,
id: GlobalId,
) -> Result<impl Iterator<Item = GlobalId> + '_, InstanceMissing> {
let instance = self.instance(instance_id)?;
let collections = instance.collections.iter();
let ids = collections
.filter_map(move |(cid, c)| c.compute_dependencies.contains(&id).then_some(*cid));
Ok(ids)
}
/// Set the `arrangement_exert_proportionality` value to be passed to new replicas.
pub fn set_arrangement_exert_proportionality(&mut self, value: u32) {
self.arrangement_exert_proportionality = value;
}
/// Returns `true` if all non-transient, non-excluded collections on all clusters have been
/// hydrated.
///
/// For this check, zero-replica clusters are always considered hydrated.
/// Their collections would never normally be considered hydrated but it's
/// clearly intentional that they have no replicas.
pub async fn clusters_hydrated(&self, exclude_collections: &BTreeSet<GlobalId>) -> bool {
let instances = self.instances.iter();
let mut pending: FuturesUnordered<_> = instances
.map(|(id, instance)| {
let exclude_collections = exclude_collections.clone();
instance
.call_sync(move |i| i.collections_hydrated(&exclude_collections))
.map(move |x| (id, x))
})
.collect();
let mut result = true;
while let Some((id, hydrated)) = pending.next().await {
if !hydrated {
result = false;
// We continue with our loop instead of breaking out early, so
// that we log all non-hydrated clusters.
tracing::info!("cluster {id} is not hydrated");
}
}
result
}
/// Returns `true` if all non-transient, non-excluded collections are hydrated on any of the
/// provided replicas.
///
/// For this check, zero-replica clusters are always considered hydrated.
/// Their collections would never normally be considered hydrated but it's
/// clearly intentional that they have no replicas.
pub fn collections_hydrated_for_replicas(
&self,
instance_id: ComputeInstanceId,
replicas: Vec<ReplicaId>,
exclude_collections: BTreeSet<GlobalId>,
) -> Result<oneshot::Receiver<bool>, anyhow::Error> {
let instance = self.instance(instance_id)?;
// Validation
if instance.replicas.is_empty() && !replicas.iter().any(|id| instance.replicas.contains(id))
{
return Err(HydrationCheckBadTarget(replicas).into());
}
let (tx, rx) = oneshot::channel();
instance.call(move |i| {
let result = i
.collections_hydrated_on_replicas(Some(replicas), &exclude_collections)
.expect("validated");
let _ = tx.send(result);
});
Ok(rx)
}
/// Returns the state of the [`ComputeController`] formatted as JSON.
///
/// The returned value is not guaranteed to be stable and may change at any point in time.
pub async fn dump(&self) -> Result<serde_json::Value, anyhow::Error> {
// Note: We purposefully use the `Debug` formatting for the value of all fields in the
// returned object as a tradeoff between usability and stability. `serde_json` will fail
// to serialize an object if the keys aren't strings, so `Debug` formatting the values
// prevents a future unrelated change from silently breaking this method.
// Destructure `self` here so we don't forget to consider dumping newly added fields.
let Self {
instances,
instance_workload_classes,
build_info: _,
storage_collections: _,
initialized,
read_only,
config: _,
arrangement_exert_proportionality,
stashed_response,
envd_epoch,
metrics: _,
now: _,
wallclock_lag: _,
dyncfg: _,
response_rx: _,
response_tx: _,
introspection_rx: _,
introspection_tx: _,
maintenance_ticker: _,
maintenance_scheduled,
} = self;
let mut instances_dump = BTreeMap::new();
for (id, instance) in instances {
let dump = instance.dump().await?;
instances_dump.insert(id.to_string(), dump);
}
let instance_workload_classes: BTreeMap<_, _> = instance_workload_classes
.lock()
.expect("lock poisoned")
.iter()
.map(|(id, wc)| (id.to_string(), format!("{wc:?}")))
.collect();
fn field(
key: &str,
value: impl Serialize,
) -> Result<(String, serde_json::Value), anyhow::Error> {
let value = serde_json::to_value(value)?;
Ok((key.to_string(), value))
}
let map = serde_json::Map::from_iter([
field("instances", instances_dump)?,
field("instance_workload_classes", instance_workload_classes)?,
field("initialized", initialized)?,
field("read_only", read_only)?,
field(
"arrangement_exert_proportionality",
arrangement_exert_proportionality,
)?,
field("stashed_response", format!("{stashed_response:?}"))?,
field("envd_epoch", envd_epoch)?,
field("maintenance_scheduled", maintenance_scheduled)?,
]);
Ok(serde_json::Value::Object(map))
}
}
impl<T> ComputeController<T>
where
T: ComputeControllerTimestamp,
ComputeGrpcClient: ComputeClient<T>,
{
/// Create a compute instance.
pub fn create_instance(
&mut self,
id: ComputeInstanceId,
arranged_logs: BTreeMap<LogVariant, GlobalId>,
workload_class: Option<String>,
) -> Result<(), InstanceExists> {
if self.instances.contains_key(&id) {
return Err(InstanceExists(id));
}
let mut collections = BTreeMap::new();
let mut logs = Vec::with_capacity(arranged_logs.len());
for (&log, &id) in &arranged_logs {
let collection = Collection::new_log();
let shared = collection.shared.clone();
collections.insert(id, collection);
logs.push((log, id, shared));
}
let (read_holds_tx, read_holds_rx) = mpsc::unbounded_channel();
let client = instance::Client::spawn(
id,
self.build_info,
Arc::clone(&self.storage_collections),
logs,
self.envd_epoch,
self.metrics.for_instance(id),
self.now.clone(),
Arc::clone(&self.wallclock_lag),
Arc::clone(&self.dyncfg),
self.response_tx.clone(),
self.introspection_tx.clone(),
read_holds_tx.clone(),
read_holds_rx,
);
let instance = InstanceState::new(client, collections, read_holds_tx);
self.instances.insert(id, instance);
self.instance_workload_classes
.lock()
.expect("lock poisoned")
.insert(id, workload_class.clone());
let instance = self.instances.get_mut(&id).expect("instance just added");
if self.initialized {
instance.call(Instance::initialization_complete);
}
if !self.read_only {
instance.call(Instance::allow_writes);
}
let mut config_params = self.config.clone();
config_params.workload_class = Some(workload_class);
instance.call(|i| i.update_configuration(config_params));
Ok(())
}
/// Updates a compute instance's workload class.
pub fn update_instance_workload_class(
&mut self,
id: ComputeInstanceId,
workload_class: Option<String>,
) -> Result<(), InstanceMissing> {
// Ensure that the instance exists first.
let _ = self.instance(id)?;
self.instance_workload_classes
.lock()
.expect("lock poisoned")
.insert(id, workload_class);
// Cause a config update to notify the instance about its new workload class.
self.update_configuration(Default::default());
Ok(())
}
/// Remove a compute instance.
///
/// # Panics
///
/// Panics if the identified `instance` still has active replicas.
pub fn drop_instance(&mut self, id: ComputeInstanceId) {
if let Some(instance) = self.instances.remove(&id) {
instance.call(|i| i.check_empty());
}
self.instance_workload_classes
.lock()
.expect("lock poisoned")
.remove(&id);
}
/// Returns the compute controller's config set.
pub fn dyncfg(&self) -> &Arc<ConfigSet> {
&self.dyncfg
}
/// Update compute configuration.
pub fn update_configuration(&mut self, config_params: ComputeParameters) {
// Apply dyncfg updates.
config_params.dyncfg_updates.apply(&self.dyncfg);
let instance_workload_classes = self
.instance_workload_classes
.lock()
.expect("lock poisoned");
// Forward updates to existing clusters.
// Workload classes are cluster-specific, so we need to overwrite them here.
for (id, instance) in self.instances.iter_mut() {
let mut params = config_params.clone();
params.workload_class = Some(instance_workload_classes[id].clone());
instance.call(|i| i.update_configuration(params));
}
// Remember updates for future clusters.
self.config.update(config_params);
}
/// Mark the end of any initialization commands.
///
/// The implementor may wait for this method to be called before implementing prior commands,
/// and so it is important for a user to invoke this method as soon as it is comfortable.
/// This method can be invoked immediately, at the potential expense of performance.
pub fn initialization_complete(&mut self) {
self.initialized = true;
for instance in self.instances.values_mut() {
instance.call(Instance::initialization_complete);
}
}
/// Wait until the controller is ready to do some processing.
///
/// This method may block for an arbitrarily long time.
///
/// When the method returns, the caller should call [`ComputeController::process`].
///
/// This method is cancellation safe.
pub async fn ready(&mut self) {
if self.stashed_response.is_some() {
// We still have a response stashed, which we are immediately ready to process.
return;
}
if self.maintenance_scheduled {
// Maintenance work has been scheduled.
return;
}
tokio::select! {
resp = self.response_rx.recv() => {
let resp = resp.expect("`self.response_tx` not dropped");
self.stashed_response = Some(resp);
}
_ = self.maintenance_ticker.tick() => {
self.maintenance_scheduled = true;
},
}
}
/// Adds replicas of an instance.
pub fn add_replica_to_instance(
&mut self,
instance_id: ComputeInstanceId,
replica_id: ReplicaId,
location: ClusterReplicaLocation,
config: ComputeReplicaConfig,
) -> Result<(), ReplicaCreationError> {
use ReplicaCreationError::*;
let instance = self.instance(instance_id)?;
// Validation
if instance.replicas.contains(&replica_id) {
return Err(ReplicaExists(replica_id));
}
let (enable_logging, interval) = match config.logging.interval {
Some(interval) => (true, interval),
None => (false, Duration::from_secs(1)),
};
let replica_config = ReplicaConfig {
location,
logging: LoggingConfig {
interval,
enable_logging,
log_logging: config.logging.log_logging,
index_logs: Default::default(),
},
arrangement_exert_proportionality: self.arrangement_exert_proportionality,
grpc_client: self.config.grpc_client.clone(),
};
let instance = self.instance_mut(instance_id).expect("validated");
instance.replicas.insert(replica_id);
instance.call(move |i| {
i.add_replica(replica_id, replica_config)
.expect("validated")
});
Ok(())
}
/// Removes a replica from an instance, including its service in the orchestrator.
pub fn drop_replica(
&mut self,
instance_id: ComputeInstanceId,
replica_id: ReplicaId,
) -> Result<(), ReplicaDropError> {
use ReplicaDropError::*;
let instance = self.instance_mut(instance_id)?;
// Validation
if !instance.replicas.contains(&replica_id) {
return Err(ReplicaMissing(replica_id));
}
instance.replicas.remove(&replica_id);
instance.call(move |i| i.remove_replica(replica_id).expect("validated"));
Ok(())
}
/// Creates the described dataflow and initializes state for its output.
///
/// If a `subscribe_target_replica` is given, any subscribes exported by the dataflow are
/// configured to target that replica, i.e., only subscribe responses sent by that replica are
/// considered.
pub fn create_dataflow(
&mut self,
instance_id: ComputeInstanceId,
dataflow: DataflowDescription<mz_compute_types::plan::Plan<T>, (), T>,
subscribe_target_replica: Option<ReplicaId>,
) -> Result<(), DataflowCreationError> {
use DataflowCreationError::*;
let instance = self.instance(instance_id)?;
// Validation: target replica
if let Some(replica_id) = subscribe_target_replica {
if !instance.replicas.contains(&replica_id) {
return Err(ReplicaMissing(replica_id));
}
}
// Validation: as_of
let as_of = dataflow.as_of.as_ref().ok_or(MissingAsOf)?;
if as_of.is_empty() && dataflow.subscribe_ids().next().is_some() {
return Err(EmptyAsOfForSubscribe);
}
if as_of.is_empty() && dataflow.copy_to_ids().next().is_some() {
return Err(EmptyAsOfForCopyTo);
}
// Validation: input collections
let storage_ids = dataflow.imported_source_ids().collect();
let mut import_read_holds = self.storage_collections.acquire_read_holds(storage_ids)?;
for id in dataflow.imported_index_ids() {
let read_hold = instance.acquire_read_hold(id)?;
import_read_holds.push(read_hold);
}
for hold in &import_read_holds {
if PartialOrder::less_than(as_of, hold.since()) {
return Err(SinceViolation(hold.id()));
}
}
// Validation: storage sink collections
for id in dataflow.persist_sink_ids() {
if self.storage_collections.check_exists(id).is_err() {
return Err(CollectionMissing(id));
}
}
let instance = self.instance_mut(instance_id).expect("validated");
let mut shared_collection_state = BTreeMap::new();
for id in dataflow.export_ids() {
let shared = SharedCollectionState::new(as_of.clone());
let collection = Collection {
write_only: dataflow.sink_exports.contains_key(&id),
compute_dependencies: dataflow.imported_index_ids().collect(),
shared: shared.clone(),
};
instance.collections.insert(id, collection);
shared_collection_state.insert(id, shared);
}
instance.call(move |i| {
i.create_dataflow(
dataflow,
import_read_holds,
subscribe_target_replica,
shared_collection_state,
)
.expect("validated")
});
Ok(())
}
/// Drop the read capability for the given collections and allow their resources to be
/// reclaimed.
pub fn drop_collections(
&mut self,
instance_id: ComputeInstanceId,
collection_ids: Vec<GlobalId>,
) -> Result<(), CollectionUpdateError> {
let instance = self.instance_mut(instance_id)?;
// Validation
for id in &collection_ids {
instance.collection(*id)?;
}
for id in &collection_ids {
instance.collections.remove(id);
}
instance.call(|i| i.drop_collections(collection_ids).expect("validated"));
Ok(())
}
/// Initiate a peek request for the contents of the given collection at `timestamp`.
pub fn peek(
&mut self,
instance_id: ComputeInstanceId,
peek_target: PeekTarget,
literal_constraints: Option<Vec<Row>>,
uuid: Uuid,
timestamp: T,
finishing: RowSetFinishing,
map_filter_project: mz_expr::SafeMfpPlan,
target_replica: Option<ReplicaId>,
peek_response_tx: oneshot::Sender<PeekResponse>,
limit: Option<usize>,
offset: usize,
) -> Result<(), PeekError> {
use PeekError::*;
let instance = self.instance(instance_id)?;
// Validation: target replica
if let Some(replica_id) = target_replica {
if !instance.replicas.contains(&replica_id) {
return Err(ReplicaMissing(replica_id));
}
}
// Validation: peek target
let read_hold = match &peek_target {
PeekTarget::Index { id } => instance.acquire_read_hold(*id)?,
PeekTarget::Persist { id, .. } => self
.storage_collections
.acquire_read_holds(vec![*id])?
.into_element(),
};
if !read_hold.since().less_equal(×tamp) {
return Err(SinceViolation(peek_target.id()));
}
instance.call(move |i| {
i.peek(
peek_target,
literal_constraints,
uuid,
timestamp,
finishing,
map_filter_project,
read_hold,
target_replica,
peek_response_tx,
limit,
offset,
)
.expect("validated")
});
Ok(())
}
/// Cancel an existing peek request.
///
/// Canceling a peek is best effort. The caller may see any of the following
/// after canceling a peek request:
///
/// * A `PeekResponse::Rows` indicating that the cancellation request did
/// not take effect in time and the query succeeded.
/// * A `PeekResponse::Canceled` affirming that the peek was canceled.
/// * No `PeekResponse` at all.
pub fn cancel_peek(
&mut self,
instance_id: ComputeInstanceId,
uuid: Uuid,
reason: PeekResponse,
) -> Result<(), InstanceMissing> {
self.instance(instance_id)?
.call(move |i| i.cancel_peek(uuid, reason));
Ok(())
}
/// Assign a read policy to specific identifiers.
///
/// The policies are assigned in the order presented, and repeated identifiers should
/// conclude with the last policy. Changing a policy will immediately downgrade the read
/// capability if appropriate, but it will not "recover" the read capability if the prior
/// capability is already ahead of it.
///
/// Identifiers not present in `policies` retain their existing read policies.
///
/// It is an error to attempt to set a read policy for a collection that is not readable in the
/// context of compute. At this time, only indexes are readable compute collections.
pub fn set_read_policy(
&mut self,
instance_id: ComputeInstanceId,
policies: Vec<(GlobalId, ReadPolicy<T>)>,
) -> Result<(), ReadPolicyError> {
use ReadPolicyError::*;
let instance = self.instance(instance_id)?;
// Validation
for (id, _) in &policies {
let collection = instance.collection(*id)?;
if collection.write_only {
return Err(WriteOnlyCollection(*id));
}
}
self.instance(instance_id)?
.call(|i| i.set_read_policy(policies).expect("validated"));
Ok(())
}
/// Acquires a [`ReadHold`] for the identified compute collection.
pub fn acquire_read_hold(
&self,
instance_id: ComputeInstanceId,
collection_id: GlobalId,
) -> Result<ReadHold<T>, CollectionUpdateError> {
let read_hold = self
.instance(instance_id)?
.acquire_read_hold(collection_id)?;
Ok(read_hold)
}
#[mz_ore::instrument(level = "debug")]
fn record_introspection_updates(&mut self, storage: &mut dyn StorageController<Timestamp = T>) {
use IntrospectionType::*;
// We could record the contents of `introspection_rx` directly here, but to reduce the
// pressure on persist we spend some effort consolidating first.
let mut updates_by_type = BTreeMap::new();
for (type_, updates) in self.introspection_rx.try_iter() {
updates_by_type
.entry(type_)
.or_insert_with(Vec::new)
.extend(updates);
}
for updates in updates_by_type.values_mut() {
consolidate(updates);
}
for (type_, updates) in updates_by_type {
if updates.is_empty() {
continue;
}
match type_ {
Frontiers
| ReplicaFrontiers
| ComputeDependencies
| ComputeOperatorHydrationStatus
| ComputeMaterializedViewRefreshes => {
let op = StorageWriteOp::Append { updates };
storage.update_introspection_collection(type_, op);
}
WallclockLagHistory => {
storage.append_introspection_updates(type_, updates);
}
_ => panic!("unexpected introspection type: {type_:?}"),
}
}
}
/// Processes the work queued by [`ComputeController::ready`].
#[mz_ore::instrument(level = "debug")]
pub fn process(
&mut self,
storage: &mut dyn StorageController<Timestamp = T>,
) -> Option<ComputeControllerResponse<T>> {
// Perform periodic maintenance work.
if self.maintenance_scheduled {
self.maintain(storage);
self.maintenance_ticker.reset();
self.maintenance_scheduled = false;
}
// Return a ready response, if any.
self.stashed_response.take()
}
#[mz_ore::instrument(level = "debug")]
fn maintain(&mut self, storage: &mut dyn StorageController<Timestamp = T>) {
// Perform instance maintenance work.
for instance in self.instances.values_mut() {
instance.call(Instance::maintain);
}
// Record pending introspection updates.
//
// It's beneficial to do this as the last maintenance step because previous steps can cause
// dropping of state, which can can cause introspection retractions, which lower the volume
// of data we have to record.
self.record_introspection_updates(storage);
}
}
#[derive(Debug)]
struct InstanceState<T: ComputeControllerTimestamp> {
client: instance::Client<T>,
replicas: BTreeSet<ReplicaId>,
collections: BTreeMap<GlobalId, Collection<T>>,
/// Sender for updates to collection read holds.
///
/// Copies of this sender are given to [`ReadHold`]s that are created in
/// [`InstanceState::acquire_read_hold`].
read_holds_tx: mpsc::UnboundedSender<(GlobalId, ChangeBatch<T>)>,
}
impl<T: ComputeControllerTimestamp> InstanceState<T> {
fn new(
client: instance::Client<T>,
collections: BTreeMap<GlobalId, Collection<T>>,
read_holds_tx: mpsc::UnboundedSender<(GlobalId, ChangeBatch<T>)>,
) -> Self {
Self {
client,
replicas: Default::default(),
collections,
read_holds_tx,
}
}
fn collection(&self, id: GlobalId) -> Result<&Collection<T>, CollectionMissing> {
self.collections.get(&id).ok_or(CollectionMissing(id))
}
pub fn call<F>(&self, f: F)
where
F: FnOnce(&mut Instance<T>) + Send + 'static,
{
let otel_ctx = OpenTelemetryContext::obtain();
self.client.send(Box::new(move |instance| {
let _span = debug_span!("instance::call").entered();
otel_ctx.attach_as_parent();
f(instance)
}));
}
pub async fn call_sync<F, R>(&self, f: F) -> R
where
F: FnOnce(&mut Instance<T>) -> R + Send + 'static,
R: Send + 'static,
{
let (tx, rx) = oneshot::channel();
let otel_ctx = OpenTelemetryContext::obtain();
self.client.send(Box::new(move |instance| {
let _span = debug_span!("instance::call_sync").entered();
otel_ctx.attach_as_parent();
let result = f(instance);
let _ = tx.send(result);
}));
rx.await.expect("instance not dropped")
}
/// Acquires a [`ReadHold`] for the identified compute collection.
pub fn acquire_read_hold(&self, id: GlobalId) -> Result<ReadHold<T>, CollectionMissing> {
// We acquire read holds at the earliest possible time rather than returning a copy
// of the implied read hold. This is so that in `create_dataflow` we can acquire read holds
// on compute dependencies at frontiers that are held back by other read holds the caller
// has previously taken.
//
// If/when we change the compute API to expect callers to pass in the `ReadHold`s rather
// than acquiring them ourselves, we might tighten this up and instead acquire read holds
// at the implied capability.
let collection = self.collection(id)?;
let since = collection.shared.lock_read_capabilities(|caps| {
let since = caps.frontier().to_owned();
caps.update_iter(since.iter().map(|t| (t.clone(), 1)));
since
});
let hold = ReadHold::new(id, since, self.read_holds_tx.clone());
Ok(hold)
}
/// Returns the [`InstanceState`] formatted as JSON.
pub async fn dump(&self) -> Result<serde_json::Value, anyhow::Error> {
// Destructure `self` here so we don't forget to consider dumping newly added fields.
let Self {
client: _,
replicas,
collections,
read_holds_tx: _,
} = self;
let instance = self.call_sync(|i| i.dump()).await?;
let replicas: Vec<_> = replicas.iter().map(|id| id.to_string()).collect();
let collections: BTreeMap<_, _> = collections
.iter()
.map(|(id, c)| (id.to_string(), format!("{c:?}")))
.collect();
fn field(
key: &str,
value: impl Serialize,
) -> Result<(String, serde_json::Value), anyhow::Error> {
let value = serde_json::to_value(value)?;
Ok((key.to_string(), value))
}
let map = serde_json::Map::from_iter([
field("instance", instance)?,
field("replicas", replicas)?,
field("collections", collections)?,
]);
Ok(serde_json::Value::Object(map))
}
}
#[derive(Debug)]
struct Collection<T> {
write_only: bool,
compute_dependencies: BTreeSet<GlobalId>,
shared: SharedCollectionState<T>,
}
impl<T: Timestamp> Collection<T> {
fn new_log() -> Self {
let as_of = Antichain::from_elem(T::minimum());
Self {
write_only: false,
compute_dependencies: Default::default(),
shared: SharedCollectionState::new(as_of),
}
}
fn frontiers(&self) -> CollectionFrontiers<T> {
let read_frontier = self
.shared
.lock_read_capabilities(|c| c.frontier().to_owned());
let write_frontier = self.shared.lock_write_frontier(|f| f.clone());
CollectionFrontiers {
read_frontier,
write_frontier,
}
}
}
/// The frontiers of a compute collection.
#[derive(Clone, Debug)]
pub struct CollectionFrontiers<T> {
/// The read frontier.
pub read_frontier: Antichain<T>,
/// The write frontier.
pub write_frontier: Antichain<T>,
}
impl<T: Timestamp> Default for CollectionFrontiers<T> {
fn default() -> Self {
Self {
read_frontier: Antichain::from_elem(T::minimum()),
write_frontier: Antichain::from_elem(T::minimum()),
}
}
}