Event Time

Event Time / Processing Time / Ingestion Time

Flink supports different notions of time in streaming programs.

• Processing time: Processing time refers to the system time of the machine that is executing the respective operation.

When a streaming program runs on processing time, all time-based operations (like time windows) will use the system clock of the machines that run the respective operator. An hourly processing time window will include all records that arrived at a specific operator between the times when the system clock indicated the full hour. For example, if an application begins running at 9:15am, the first hourly processing time window will include events processed between 9:15am and 10:00am, the next window will include events processed between 10:00am and 11:00am, and so on.

Processing time is the simplest notion of time and requires no coordination between streams and machines. It provides the best performance and the lowest latency. However, in distributed and asynchronous environments processing time does not provide determinism, because it is susceptible to the speed at which records arrive in the system (for example from the message queue), to the speed at which the records flow between operators inside the system, and to outages (scheduled, or otherwise).

• Event time: Event time is the time that each individual event occurred on its producing device. This time is typically embedded within the records before they enter Flink, and that event timestamp can be extracted from each record. In event time, the progress of time depends on the data, not on any wall clocks. Event time programs must specify how to generate Event Time Watermarks, which is the mechanism that signals progress in event time. This watermarking mechanism is described in a later section, below.

In a perfect world, event time processing would yield completely consistent and deterministic results, regardless of when events arrive, or their ordering. However, unless the events are known to arrive in-order (by timestamp), event time processing incurs some latency while waiting for out-of-order events. As it is only possible to wait for a finite period of time, this places a limit on how deterministic event time applications can be.

Assuming all of the data has arrived, event time operations will behave as expected, and produce correct and consistent results even when working with out-of-order or late events, or when reprocessing historic data. For example, an hourly event time window will contain all records that carry an event timestamp that falls into that hour, regardless of the order in which they arrive, or when they are processed. (See the section on late events for more information.)

Note that sometimes when event time programs are processing live data in real-time, they will use some processing time operations in order to guarantee that they are progressing in a timely fashion.

• Ingestion time: Ingestion time is the time that events enter Flink. At the source operator each record gets the source’s current time as a timestamp, and time-based operations (like time windows) refer to that timestamp.

Ingestion time sits conceptually in between event time and processing time. Compared to processing time, it is slightly more expensive, but gives more predictable results. Because ingestion time uses stable timestamps (assigned once at the source), different window operations over the records will refer to the same timestamp, whereas in processing time each window operator may assign the record to a different window (based on the local system clock and any transport delay).

Compared to event time, ingestion time programs cannot handle any out-of-order events or late data, but the programs don’t have to specify how to generate watermarks.

Internally, ingestion time is treated much like event time, but with automatic timestamp assignment and automatic watermark generation.

Setting a Time Characteristic

The first part of a Flink DataStream program usually sets the base time characteristic. That settingdefines how data stream sources behave (for example, whether they will assign timestamps), and what notion oftime should be used by window operations like KeyedStream.timeWindow(Time.seconds(30)).

The following example shows a Flink program that aggregates events in hourly time windows. The behavior of thewindows adapts with the time characteristic.

final StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment();
env.setStreamTimeCharacteristic(TimeCharacteristic.ProcessingTime);
// alternatively:
// env.setStreamTimeCharacteristic(TimeCharacteristic.IngestionTime);
// env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime);
DataStream<MyEvent> stream = env.addSource(new FlinkKafkaConsumer09<MyEvent>(topic, schema, props));
stream
    .keyBy( (event) -> event.getUser() )
    .timeWindow(Time.hours(1))
    .reduce( (a, b) -> a.add(b) )
    .addSink(...);

val env = StreamExecutionEnvironment.getExecutionEnvironment
env.setStreamTimeCharacteristic(TimeCharacteristic.ProcessingTime)
// alternatively:
// env.setStreamTimeCharacteristic(TimeCharacteristic.IngestionTime)
// env.setStreamTimeCharacteristic(TimeCharacteristic.EventTime)
val stream: DataStream[MyEvent] = env.addSource(new FlinkKafkaConsumer09[MyEvent](topic, schema, props))
stream
    .keyBy( _.getUser )
    .timeWindow(Time.hours(1))
    .reduce( (a, b) => a.add(b) )
    .addSink(...)

env = StreamExecutionEnvironment.get_execution_environment()
env.set_stream_time_characteristic(TimeCharacteristic.ProcessingTime)
# alternatively:
# env.set_stream_time_characteristic(TimeCharacteristic.IngestionTime)
# env.set_stream_time_characteristic(TimeCharacteristic.EventTime)

Note that in order to run this example in event time, the program needs to either use sourcesthat directly define event time for the data and emit watermarks themselves, or the program mustinject a Timestamp Assigner & Watermark Generator after the sources. Those functions describe how to accessthe event timestamps, and what degree of out-of-orderness the event stream exhibits.

The section below describes the general mechanism behind timestamps and watermarks. For a guide on howto use timestamp assignment and watermark generation in the Flink DataStream API, please refer toGenerating Timestamps / Watermarks.

Event Time and Watermarks

Note: Flink implements many techniques from the Dataflow Model. For a good introduction to event time and watermarks, have a look at the articles below.

• Streaming 101 by Tyler Akidau
• The Dataflow Model paper

A stream processor that supports event time needs a way to measure the progress of event time.For example, a window operator that builds hourly windows needs to be notified when event time has passed beyond theend of an hour, so that the operator can close the window in progress.

Event time can progress independently of processing time (measured by wall clocks).For example, in one program the current event time of an operator may trail slightly behind the processing time(accounting for a delay in receiving the events), while both proceed at the same speed.On the other hand, another streaming program might progress through weeks of event time with only a few seconds of processing,by fast-forwarding through some historic data already buffered in a Kafka topic (or another message queue).

The mechanism in Flink to measure progress in event time is watermarks.Watermarks flow as part of the data stream and carry a timestamp t. A Watermark(t) declares that event time has reached timet in that stream, meaning that there should be no more elements from the stream with a timestamp t’ <= t (i.e. events with timestampsolder or equal to the watermark).

The figure below shows a stream of events with (logical) timestamps, and watermarks flowing inline. In this example the events are in order(with respect to their timestamps), meaning that the watermarks are simply periodic markers in the stream.

Watermarks are crucial for out-of-order streams, as illustrated below, where the events are not ordered by their timestamps.In general a watermark is a declaration that by that point in the stream, all events up to a certain timestamp should have arrived.Once a watermark reaches an operator, the operator can advance its internal event time clock to the value of the watermark.

Note that event time is inherited by a freshly created stream element (or elements) from either the event that produced them orfrom watermark that triggered creation of those elements.

Watermarks in Parallel Streams

Watermarks are generated at, or directly after, source functions. Each parallel subtask of a source function usuallygenerates its watermarks independently. These watermarks define the event time at that particular parallel source.

As the watermarks flow through the streaming program, they advance the event time at the operators where they arrive. Whenever anoperator advances its event time, it generates a new watermark downstream for its successor operators.

Some operators consume multiple input streams; a union, for example, or operators following a keyBy(…) or partition(…) function.Such an operator’s current event time is the minimum of its input streams’ event times. As its input streamsupdate their event times, so does the operator.

The figure below shows an example of events and watermarks flowing through parallel streams, and operators tracking event time.

Note that the Kafka source supports per-partition watermarking, which you can read more about here.

Late Elements

It is possible that certain elements will violate the watermark condition, meaning that even after the Watermark(t) has occurred,more elements with timestamp t’ <= t will occur. In fact, in many real world setups, certain elements can be arbitrarilydelayed, making it impossible to specify a time by which all elements of a certain event timestamp will have occurred.Furthermore, even if the lateness can be bounded, delaying the watermarks by too much is often not desirable, because itcauses too much delay in the evaluation of event time windows.

For this reason, streaming programs may explicitly expect some late elements. Late elements are elements thatarrive after the system’s event time clock (as signaled by the watermarks) has already passed the time of the late element’stimestamp. See Allowed Lateness for more information on how to workwith late elements in event time windows.

Idling sources

Currently, with pure event time watermarks generators, watermarks can not progress if there are no elementsto be processed. That means in case of gap in the incoming data, event time will not progress and forexample the window operator will not be triggered and thus existing windows will not be able to produce anyoutput data.

To circumvent this one can use periodic watermark assigners that don’t only assign based onelement timestamps. An example solution could be an assigner that switches to using current processing timeas the time basis after not observing new events for a while.

Sources can be marked as idle using SourceFunction.SourceContext#markAsTemporarilyIdle. For details please refer to the Javadoc ofthis method as well as StreamStatus.

Debugging Watermarks

Please refer to the Debugging Windows & Event Time section for debuggingwatermarks at runtime.

How operators are processing watermarks

As a general rule, operators are required to completely process a given watermark before forwarding it downstream. For example,WindowOperator will first evaluate which windows should be fired, and only after producing all of the output triggered bythe watermark will the watermark itself be sent downstream. In other words, all elements produced due to occurrence of a watermarkwill be emitted before the watermark.

The same rule applies to TwoInputStreamOperator. However, in this case the current watermark of the operator is defined asthe minimum of both of its inputs.

The details of this behavior are defined by the implementations of the OneInputStreamOperator#processWatermark,TwoInputStreamOperator#processWatermark1 and TwoInputStreamOperator#processWatermark2 methods.