Primitive to shift the watermark while assigning timestamps
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 205
Description
There is a general need, especially important in the presence of SplittableDoFn, to be able to assign new timestamps to elements without making them late or droppable.
- DoFn.withAllowedTimestampSkew is inadequate, because it simply allows one to produce late data, but does not allow one to shift the watermark so the new data is on-time.
- For a SplittableDoFn, one may receive an element such as the name of a log file that contains elements for the day preceding the log file. The timestamp on the filename must currently be the beginning of the log. If such elements are constantly flowing, it may be OK, but since we don't know that element is coming, in that absence of data, the watermark may advance. We need a way to keep it far enough back even in the absence of data holding it back.
One idea is a new primitive ShiftWatermark / AdjustTimestamps with the following pieces:
- A constant duration (positive or negative) D by which to shift the watermark.
- A function from TimestampedElement to new timestamp that is \>= t **** D
So, for example, AdjustTimestamps(<-60 minutes\>, f) would allow f to make timestamps up to 60 minutes earlier.
With this primitive added, outputWithTimestamp and withAllowedTimestampSkew could be removed, simplifying DoFn.
Alternatively, all of this functionality could be bolted on to DoFn.
This ticket is not a proposal, but a record of the issue and ideas that were mentioned.
Imported from Jira [BEAM-644](https://issues.apache.org/jira/browse/BEAM-644). Original Jira may contain additional context.
Reported by: kenn.
Contributor guide
Research direction
Start with the DoFn APIs named in the issue, especially withAllowedTimestampSkew and outputWithTimestamp, and review how SplittableDoFn handles timestamps and watermarks. Determine whether watermark shifting belongs in a new ShiftWatermark or AdjustTimestamps primitive or in DoFn, then define tests that demonstrate earlier timestamps remain on-time and are not droppable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- stream-processing
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100