tejasiyer-dev commented on code in PR #40543:
URL: https://github.com/apache/beam/pull/40543#discussion_r4623849632
##########
sdks/java/core/src/main/java/org/apache/beam/sdk/util/BundleLifter.java:
##########
@@ -57,89 +89,340 @@ public class BundleLifter<T> extends
PTransform<PCollection<T>, PCollectionTuple
final TupleTag<T> smallBatchTag;
final TupleTag<T> largeBatchTag;
- final int threshold;
+ final long threshold;
+ final long maxBufferedBytes;
+ final int maxLiftedKeys;
final SerializableFunction<T, Integer> elementSizer;
+ final @Nullable SerializableFunction<T, ? extends @Nullable Object> keyFn;
+
+ /** The default memory cap: twice the threshold. */
+ static long defaultMaxBufferedBytes(long threshold) {
+ return threshold > Long.MAX_VALUE / 2 ? Long.MAX_VALUE : 2 * threshold;
+ }
/**
- * A DoFn that buffers elements within a bundle and outputs them to
different tags in
- * finish_bundle based on the total bundle size.
+ * A DoFn that buffers elements per key within a bundle and outputs them to
the large tag once a
+ * key reaches the threshold, or to the small tag otherwise.
*
* @param <T> The type of elements being processed.
*/
static class BundleLiftDoFn<T> extends DoFn<T, Void> {
private static final Logger LOG =
LoggerFactory.getLogger(BundleLiftDoFn.class);
+ /** The key shared by all elements without a key, or whose key function
returns null. */
+ private static final Object UNKEYED = new Object();
+
final TupleTag<T> smallBatchTag;
final TupleTag<T> largeBatchTag;
- final int threshold;
+ final long threshold;
+ final long maxBufferedBytes;
+ final int maxLiftedKeys;
final SerializableFunction<T, Integer> elementSizer;
+ final @Nullable SerializableFunction<T, ? extends @Nullable Object> keyFn;
- private transient @MonotonicNonNull List<T> buffer;
- private transient long bundleSizeBytes;
- private transient @Nullable MultiOutputReceiver receiver;
+ // Per-bundle state, allocated once in setup and cleared at the start of
each bundle.
+ private transient @MonotonicNonNull Map<Object, KeyBuffer<T>> buffers;
+ private transient @MonotonicNonNull Set<Object> liftedKeys;
+ // Reset in startBundle; not transient so SpotBugs doesn't flag them as
unrestored state.
+ private long bufferedBytes;
+ // Set once the memory cap is exceeded or the lifted key limit is reached
in this bundle: keys
+ // that are neither buffered nor lifted are no longer tracked and go to
the small output
+ // immediately.
+ private boolean keysFinalized;
BundleLiftDoFn(
TupleTag<T> smallBatchTag,
TupleTag<T> largeBatchTag,
- int threshold,
+ long threshold,
SerializableFunction<T, Integer> elementSizer) {
+ this(smallBatchTag, largeBatchTag, threshold, elementSizer, null);
+ }
+
+ BundleLiftDoFn(
+ TupleTag<T> smallBatchTag,
+ TupleTag<T> largeBatchTag,
+ long threshold,
+ SerializableFunction<T, Integer> elementSizer,
+ @Nullable SerializableFunction<T, ? extends @Nullable Object> keyFn) {
+ this(
+ smallBatchTag,
+ largeBatchTag,
+ threshold,
+ defaultMaxBufferedBytes(threshold),
+ elementSizer,
+ keyFn);
+ }
+
+ BundleLiftDoFn(
+ TupleTag<T> smallBatchTag,
+ TupleTag<T> largeBatchTag,
+ long threshold,
+ long maxBufferedBytes,
+ SerializableFunction<T, Integer> elementSizer,
+ @Nullable SerializableFunction<T, ? extends @Nullable Object> keyFn) {
+ this(
+ smallBatchTag,
+ largeBatchTag,
+ threshold,
+ maxBufferedBytes,
+ Integer.MAX_VALUE,
+ elementSizer,
+ keyFn);
+ }
+
+ BundleLiftDoFn(
+ TupleTag<T> smallBatchTag,
+ TupleTag<T> largeBatchTag,
+ long threshold,
+ long maxBufferedBytes,
+ int maxLiftedKeys,
+ SerializableFunction<T, Integer> elementSizer,
+ @Nullable SerializableFunction<T, ? extends @Nullable Object> keyFn) {
this.smallBatchTag = smallBatchTag;
this.largeBatchTag = largeBatchTag;
this.threshold = threshold;
+ this.maxBufferedBytes = maxBufferedBytes;
+ this.maxLiftedKeys = maxLiftedKeys;
this.elementSizer = elementSizer;
+ this.keyFn = keyFn;
+ }
+
+ @Setup
+ public void setup() {
+ buffers = new LinkedHashMap<>();
+ liftedKeys = new HashSet<>();
}
@StartBundle
public void startBundle() {
- buffer = new ArrayList<>();
- receiver = null;
- bundleSizeBytes = 0L;
+ checkStateNotNull(buffers, "Buffers should be set by setup.").clear();
+ checkStateNotNull(liftedKeys, "Lifted keys should be set by
setup.").clear();
+ bufferedBytes = 0L;
+ keysFinalized = false;
}
@ProcessElement
- public void processElement(@Element T element, MultiOutputReceiver mor) {
- if (receiver == null) {
- receiver = mor;
+ public void processElement(
+ @Element T element,
+ @Timestamp Instant timestamp,
+ BoundedWindow window,
+ PaneInfo pane,
+ MultiOutputReceiver receiver) {
+ Map<Object, KeyBuffer<T>> buffers =
+ checkStateNotNull(this.buffers, "Buffers should be set by setup.");
+ Set<Object> liftedKeys =
+ checkStateNotNull(this.liftedKeys, "Lifted keys should be set by
setup.");
+
+ Object key;
+ if (keyFn == null) {
+ key = UNKEYED;
+ } else {
+ @Nullable Object userKey = keyFn.apply(element);
+ key = new WindowedKey(window, pane, userKey == null ? UNKEYED :
userKey);
+ }
+
+ if (liftedKeys.contains(key)) {
+ // This key already reached the threshold in this bundle; stream it
through.
+ receiver.get(largeBatchTag).output(element);
+ return;
+ }
+
+ KeyBuffer<T> buffer = buffers.get(key);
+ if (buffer == null) {
+ if (keysFinalized) {
+ // The memory cap was exceeded earlier in this bundle; don't track
new keys.
+ receiver.get(smallBatchTag).output(element);
+ return;
+ }
+ buffer = new KeyBuffer<>();
+ buffers.put(key, buffer);
+ }
+ long elementBytes = elementSizer.apply(element);
+ buffer.add(new BufferedElement<>(element, timestamp, window, pane),
elementBytes);
+ bufferedBytes += elementBytes;
+
+ if (buffer.sizeBytes >= threshold) {
+ buffers.remove(key);
+ bufferedBytes -= buffer.sizeBytes;
+ liftedKeys.add(key);
+ LOG.debug(
+ "Key reached {} estimated bytes; emitting {} buffered elements to
tag: '{}'",
+ buffer.sizeBytes,
+ buffer.elements.size(),
+ largeBatchTag.getId());
+ emit(buffer, receiver.get(largeBatchTag));
+ if (liftedKeys.size() >= maxLiftedKeys) {
+ // No other key can be lifted in this bundle; release the remaining
buffers.
+ keysFinalized = true;
+ OutputReceiver<T> small = receiver.get(smallBatchTag);
+ for (KeyBuffer<T> other : buffers.values()) {
+ emit(other, small);
+ }
+ buffers.clear();
+ bufferedBytes = 0L;
+ }
+ return;
+ }
+
+ // Anything that isn't in lifted keys or buffers is sent to small keys
immediately.
+ if (bufferedBytes > maxBufferedBytes) {
+ keysFinalized = true;
+ evictSmallestKeys(buffers, receiver.get(smallBatchTag));
}
- checkArgumentNotNull(buffer, "Buffer should be set by startBundle.");
- buffer.add(element);
- bundleSizeBytes += elementSizer.apply(element);
}
@FinishBundle
- public void finishBundle() {
- checkArgumentNotNull(buffer, "Buffer should be set by startBundle.");
- if (buffer.isEmpty()) {
- return;
+ public void finishBundle(FinishBundleContext context) {
+ Map<Object, KeyBuffer<T>> buffers =
+ checkStateNotNull(this.buffers, "Buffers should be set by setup.");
+ for (KeyBuffer<T> buffer : buffers.values()) {
+ LOG.debug(
+ "Emitting {} elements of {} estimated bytes to tag: '{}'",
+ buffer.elements.size(),
+ buffer.sizeBytes,
+ smallBatchTag.getId());
+ for (BufferedElement<T> e : buffer.elements) {
+ context.output(smallBatchTag, e.value, e.timestamp, e.window);
Review Comment:
FinishBundleContext.output has no pane parameter, and saving OutputReceiver
from processElement to call emit here throws a NullPointerException on Runner
v2. Moved to #41468.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]