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
//! Traits, implementations, and macros related to logging timely events.
/// Type alias for logging timely events.
pub type WorkerIdentifier = usize;
/// Logger type for worker-local logging.
pub type Logger<Event> = crate::logging_core::Logger<Event, WorkerIdentifier>;
/// Logger for timely dataflow system events.
pub type TimelyLogger = Logger<TimelyEvent>;
/// Logger for timely dataflow progress events (the "timely/progress" log stream).
pub type TimelyProgressLogger = Logger<TimelyProgressEvent>;
use std::time::Duration;
use crate::dataflow::operators::capture::{Event, EventPusher};
/// Logs events as a timely stream, with progress statements.
pub struct BatchLogger<T, E, P> where P: EventPusher<Duration, Vec<(Duration, E, T)>> {
// None when the logging stream is closed
time: Duration,
event_pusher: P,
_phantom: ::std::marker::PhantomData<(E, T)>,
}
impl<T, E, P> BatchLogger<T, E, P> where P: EventPusher<Duration, Vec<(Duration, E, T)>> {
/// Creates a new batch logger.
pub fn new(event_pusher: P) -> Self {
BatchLogger {
time: Default::default(),
event_pusher,
_phantom: ::std::marker::PhantomData,
}
}
/// Publishes a batch of logged events and advances the capability.
pub fn publish_batch(&mut self, &time: &Duration, data: &mut Vec<(Duration, E, T)>) {
if !data.is_empty() {
self.event_pusher.push(Event::Messages(self.time, data.drain(..).collect()));
}
if self.time < time {
let new_frontier = time;
let old_frontier = self.time;
self.event_pusher.push(Event::Progress(vec![(new_frontier, 1), (old_frontier, -1)]));
}
self.time = time;
}
}
impl<T, E, P> Drop for BatchLogger<T, E, P> where P: EventPusher<Duration, Vec<(Duration, E, T)>> {
fn drop(&mut self) {
self.event_pusher.push(Event::Progress(vec![(self.time, -1)]));
}
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// The creation of an `Operate` implementor.
pub struct OperatesEvent {
/// Worker-unique identifier for the operator.
pub id: usize,
/// Sequence of nested scope identifiers indicating the path from the root to this instance.
pub addr: Vec<usize>,
/// A helpful name.
pub name: String,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// The creation of a channel between operators.
pub struct ChannelsEvent {
/// Worker-unique identifier for the channel
pub id: usize,
/// Sequence of nested scope identifiers indicating the path from the root to this instance.
pub scope_addr: Vec<usize>,
/// Source descriptor, indicating operator index and output port.
pub source: (usize, usize),
/// Target descriptor, indicating operator index and input port.
pub target: (usize, usize),
}
/// Encapsulates Any and Debug for dynamically typed timestamps in logs
pub trait ProgressEventTimestamp: std::fmt::Debug + std::any::Any {
/// Upcasts this `ProgressEventTimestamp` to `Any`.
///
/// NOTE: This is required until <https://github.com/rust-lang/rfcs/issues/2765> is fixed
///
/// # Example
/// ```rust
/// let ts = vec![(0usize, 0usize, (23u64, 10u64), -4i64), (0usize, 0usize, (23u64, 11u64), 1i64)];
/// let ts: &timely::logging::ProgressEventTimestampVec = &ts;
/// for (n, p, t, d) in ts.iter() {
/// print!("{:?}, ", (n, p, t.as_any().downcast_ref::<(u64, u64)>(), d));
/// }
/// println!();
/// ```
fn as_any(&self) -> &dyn std::any::Any;
/// Returns the name of the concrete type of this object.
///
/// # Note
///
/// This is intended for diagnostic use. The exact contents and format of the
/// string returned are not specified, other than being a best-effort
/// description of the type. For example, amongst the strings
/// that `type_name::<Option<String>>()` might return are `"Option<String>"` and
/// `"std::option::Option<std::string::String>"`.
fn type_name(&self) -> &'static str;
}
impl<T: crate::Data + std::fmt::Debug + std::any::Any> ProgressEventTimestamp for T {
fn as_any(&self) -> &dyn std::any::Any { self }
fn type_name(&self) -> &'static str { std::any::type_name::<T>() }
}
/// A vector of progress updates in logs
///
/// This exists to support upcasting of the concrecte progress update vectors to
/// `dyn ProgressEventTimestamp`. Doing so at the vector granularity allows us to
/// use a single allocation for the entire vector (as opposed to a `Box` allocation
/// for each dynamically typed element).
pub trait ProgressEventTimestampVec: std::fmt::Debug + std::any::Any {
/// Iterate over the contents of the vector
fn iter<'a>(&'a self) -> Box<dyn Iterator<Item=(&'a usize, &'a usize, &'a dyn ProgressEventTimestamp, &'a i64)>+'a>;
}
impl<T: ProgressEventTimestamp> ProgressEventTimestampVec for Vec<(usize, usize, T, i64)> {
fn iter<'a>(&'a self) -> Box<dyn Iterator<Item=(&'a usize, &'a usize, &'a dyn ProgressEventTimestamp, &'a i64)>+'a> {
Box::new(<[(usize, usize, T, i64)]>::iter(&self[..]).map(|(n, p, t, d)| {
let t: &dyn ProgressEventTimestamp = t;
(n, p, t, d)
}))
}
}
#[derive(Debug)]
/// Send or receive of progress information.
pub struct TimelyProgressEvent {
/// `true` if the event is a send, and `false` if it is a receive.
pub is_send: bool,
/// Source worker index.
pub source: usize,
/// Communication channel identifier
pub channel: usize,
/// Message sequence number.
pub seq_no: usize,
/// Sequence of nested scope identifiers indicating the path from the root to this instance.
pub addr: Vec<usize>,
/// List of message updates, containing Target descriptor, timestamp as string, and delta.
pub messages: Box<dyn ProgressEventTimestampVec>,
/// List of capability updates, containing Source descriptor, timestamp as string, and delta.
pub internal: Box<dyn ProgressEventTimestampVec>,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// External progress pushed onto an operator
pub struct PushProgressEvent {
/// Worker-unique operator identifier
pub op_id: usize,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Message send or receive event
pub struct MessagesEvent {
/// `true` if send event, `false` if receive event.
pub is_send: bool,
/// Channel identifier
pub channel: usize,
/// Source worker index.
pub source: usize,
/// Target worker index.
pub target: usize,
/// Message sequence number.
pub seq_no: usize,
/// Number of typed records in the message.
pub length: usize,
}
/// Records the starting and stopping of an operator.
#[derive(Serialize, Deserialize, Debug, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
pub enum StartStop {
/// Operator starts.
Start,
/// Operator stops.
Stop,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Operator start or stop.
pub struct ScheduleEvent {
/// Worker-unique identifier for the operator, linkable to the identifiers in `OperatesEvent`.
pub id: usize,
/// `Start` if the operator is starting, `Stop` if it is stopping.
/// activity is true if it looks like some useful work was performed during this call (data was
/// read or written, notifications were requested / delivered)
pub start_stop: StartStop,
}
impl ScheduleEvent {
/// Creates a new start scheduling event.
pub fn start(id: usize) -> Self { ScheduleEvent { id, start_stop: StartStop::Start } }
/// Creates a new stop scheduling event and reports whether work occurred.
pub fn stop(id: usize) -> Self { ScheduleEvent { id, start_stop: StartStop::Stop } }
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Operator shutdown.
pub struct ShutdownEvent {
/// Worker-unique identifier for the operator, linkable to the identifiers in `OperatesEvent`.
pub id: usize,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Application-defined code start or stop
pub struct ApplicationEvent {
/// Unique event type identifier
pub id: usize,
/// True when activity begins, false when it stops
pub is_start: bool,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Application-defined code start or stop
pub struct GuardedMessageEvent {
/// True when activity begins, false when it stops
pub is_start: bool,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Application-defined code start or stop
pub struct GuardedProgressEvent {
/// True when activity begins, false when it stops
pub is_start: bool,
}
#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Hash, Clone, Copy)]
/// Identifier of the worker that generated a log line
pub struct TimelySetup {
/// Worker index
pub index: usize,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Kind of communication channel
pub enum CommChannelKind {
/// Communication channel carrying progress information
Progress,
/// Communication channel carrying data
Data,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Event on a communication channel
pub struct CommChannelsEvent {
/// Communication channel identifier
pub identifier: usize,
/// Kind of communication channel (progress / data)
pub kind: CommChannelKind,
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// Input logic start/stop
pub struct InputEvent {
/// True when activity begins, false when it stops
pub start_stop: StartStop,
}
/// Records the starting and stopping of an operator.
#[derive(Serialize, Deserialize, Debug, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
pub enum ParkEvent {
/// Worker parks.
Park(Option<Duration>),
/// Worker unparks.
Unpark,
}
impl ParkEvent {
/// Creates a new park event from the supplied duration.
pub fn park(duration: Option<Duration>) -> Self { ParkEvent::Park(duration) }
/// Creates a new unpark event.
pub fn unpark() -> Self { ParkEvent::Unpark }
}
#[derive(Serialize, Deserialize, Debug, Clone, Hash, Eq, PartialEq, Ord, PartialOrd)]
/// An event in a timely worker
pub enum TimelyEvent {
/// Operator creation.
Operates(OperatesEvent),
/// Channel creation.
Channels(ChannelsEvent),
/// Progress propagation (reasoning).
PushProgress(PushProgressEvent),
/// Message send or receive.
Messages(MessagesEvent),
/// Operator start or stop.
Schedule(ScheduleEvent),
/// Operator shutdown.
Shutdown(ShutdownEvent),
/// No clue.
Application(ApplicationEvent),
/// Per-message computation.
GuardedMessage(GuardedMessageEvent),
/// Per-notification computation.
GuardedProgress(GuardedProgressEvent),
/// Communication channel event.
CommChannels(CommChannelsEvent),
/// Input event.
Input(InputEvent),
/// Park event.
Park(ParkEvent),
/// Unstructured event.
Text(String),
}
impl From<OperatesEvent> for TimelyEvent {
fn from(v: OperatesEvent) -> TimelyEvent { TimelyEvent::Operates(v) }
}
impl From<ChannelsEvent> for TimelyEvent {
fn from(v: ChannelsEvent) -> TimelyEvent { TimelyEvent::Channels(v) }
}
impl From<PushProgressEvent> for TimelyEvent {
fn from(v: PushProgressEvent) -> TimelyEvent { TimelyEvent::PushProgress(v) }
}
impl From<MessagesEvent> for TimelyEvent {
fn from(v: MessagesEvent) -> TimelyEvent { TimelyEvent::Messages(v) }
}
impl From<ScheduleEvent> for TimelyEvent {
fn from(v: ScheduleEvent) -> TimelyEvent { TimelyEvent::Schedule(v) }
}
impl From<ShutdownEvent> for TimelyEvent {
fn from(v: ShutdownEvent) -> TimelyEvent { TimelyEvent::Shutdown(v) }
}
impl From<ApplicationEvent> for TimelyEvent {
fn from(v: ApplicationEvent) -> TimelyEvent { TimelyEvent::Application(v) }
}
impl From<GuardedMessageEvent> for TimelyEvent {
fn from(v: GuardedMessageEvent) -> TimelyEvent { TimelyEvent::GuardedMessage(v) }
}
impl From<GuardedProgressEvent> for TimelyEvent {
fn from(v: GuardedProgressEvent) -> TimelyEvent { TimelyEvent::GuardedProgress(v) }
}
impl From<CommChannelsEvent> for TimelyEvent {
fn from(v: CommChannelsEvent) -> TimelyEvent { TimelyEvent::CommChannels(v) }
}
impl From<InputEvent> for TimelyEvent {
fn from(v: InputEvent) -> TimelyEvent { TimelyEvent::Input(v) }
}
impl From<ParkEvent> for TimelyEvent {
fn from(v: ParkEvent) -> TimelyEvent { TimelyEvent::Park(v) }
}