Skip to content

[HUDI-9624] Warn when event-time field is set without watermark tracking #18721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1fanwang wants to merge 1 commit into
base: master
Choose a base branch
from
+58 −0
Open

[HUDI-9624] Warn when event-time field is set without watermark tracking #18721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions hudi-client/hudi-client-common/src/main/java/org/apache/hudi/config/HoodieWriteConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import org.apache.hudi.common.fs.FileSystemRetryConfig;
import org.apache.hudi.common.model.HoodieCleaningPolicy;
import org.apache.hudi.common.model.HoodieFailedWritesCleaningPolicy;
import org.apache.hudi.common.model.HoodiePayloadProps;
import org.apache.hudi.common.model.HoodiePreWriteCleanerPolicy;
import org.apache.hudi.common.model.HoodieFileFormat;
import org.apache.hudi.common.model.HoodieRecordMerger;
Expand Down Expand Up @@ -3862,6 +3863,23 @@ private void validate() {
checkArgument(lookbackCommits >= 0,
String.format("%s must be non-negative, but was %d",
ROLLING_METADATA_TIMELINE_LOOKBACK_COMMITS.key(), lookbackCommits));

validateEventTimeConfigs();
}

private void validateEventTimeConfigs() {
Copy link
Copy Markdown
Contributor

@hudi-agent hudi-agent May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 nit: validateEventTimeConfigs reads like it enforces a constraint and throws on failure — which is what other validate* methods in this builder typically do. Since this one only logs a warning, a name like warnIfEventTimeWatermarkNotTracked would more accurately signal the intent to future readers.

- AI-generated; verify before applying. React 👍/👎 to flag quality.

// Event-time field is configured but watermark tracking is off — the field
// will be ignored at commit time. Surface a hint so the user can opt in via
// TRACK_EVENT_TIME_WATERMARK.
String eventTimeFieldName = writeConfig.getString(HoodiePayloadProps.PAYLOAD_EVENT_TIME_FIELD_PROP_KEY);
if (!StringUtils.isNullOrEmpty(eventTimeFieldName)
&& !writeConfig.getBooleanOrDefault(TRACK_EVENT_TIME_WATERMARK)) {
log.warn("{}={} is configured but {}={}; event-time watermark metadata will not be tracked. "
+ "Set {}=true to record event-time watermark in commit metadata.",
HoodiePayloadProps.PAYLOAD_EVENT_TIME_FIELD_PROP_KEY, eventTimeFieldName,
TRACK_EVENT_TIME_WATERMARK.key(), writeConfig.getBooleanOrDefault(TRACK_EVENT_TIME_WATERMARK),
Copy link
Copy Markdown
Contributor

@hudi-agent hudi-agent May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 nit: getBooleanOrDefault(TRACK_EVENT_TIME_WATERMARK) is called again here, but inside this branch it's always false (that's what the if condition guards on). Extracting it to a local boolean trackWatermark = ... before the if and reusing it in both places would avoid the redundant config lookup and make the relationship explicit.

- AI-generated; verify before applying. React 👍/👎 to flag quality.

TRACK_EVENT_TIME_WATERMARK.key());
}
Comment on lines +3866 to +3882
Copy link
Copy Markdown
Collaborator

@lokeshj1703 lokeshj1703 May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can extract this logic to a separate method like validateEventTimeConfigs within this function.

Copy link
Copy Markdown
Author

@1fanwang 1fanwang May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in c3d3f45 — extracted to validateEventTimeConfigs() called at the end of validate().

}

public HoodieWriteConfig build() {
Expand Down
40 changes: 40 additions & 0 deletions ...client/hudi-client-common/src/test/java/org/apache/hudi/config/TestHoodieWriteConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import org.apache.hudi.common.engine.EngineType;
import org.apache.hudi.common.model.HoodieCleaningPolicy;
import org.apache.hudi.common.model.HoodieFailedWritesCleaningPolicy;
import org.apache.hudi.common.model.HoodiePayloadProps;
import org.apache.hudi.common.model.HoodieTableType;
import org.apache.hudi.common.model.WriteConcurrencyMode;
import org.apache.hudi.common.table.HoodieTableConfig;
Expand All @@ -40,6 +41,12 @@
import org.apache.hudi.index.HoodieIndex;
import org.apache.hudi.keygen.constant.KeyGeneratorOptions;

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.Logger;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.Property;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.EnumSource;
Expand All @@ -48,9 +55,11 @@
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
Expand Down Expand Up @@ -908,4 +917,35 @@ public void testUpdatesStrategyNotOverriddenWhenExplicitlySet() {
.build();
assertEquals(customStrategy, writeConfig.getClusteringUpdatesStrategyClass());
}

@Test
public void testWarnsWhenEventTimeFieldSetWithoutWatermarkTracking() {
Properties props = new Properties();
props.setProperty(HoodiePayloadProps.PAYLOAD_EVENT_TIME_FIELD_PROP_KEY, "ts");
// hoodie.write.track.event.time.watermark is not set; default is false.
List<LogEvent> captured = new ArrayList<>();
AbstractAppender appender = new AbstractAppender(
"CaptureAppender", null, null, true, Property.EMPTY_ARRAY) {
@Override
public void append(LogEvent event) {
captured.add(event.toImmutable());
}
};
appender.start();
Logger logger = (Logger) LogManager.getLogger(HoodieWriteConfig.class);
logger.addAppender(appender);
try {
HoodieWriteConfig.newBuilder().withPath("/tmp").withProperties(props).build();
} finally {
logger.removeAppender(appender);
appender.stop();
}
boolean foundHint = captured.stream()
.filter(e -> e.getLevel() == Level.WARN)
.map(e -> e.getMessage().getFormattedMessage())
.anyMatch(msg -> msg.contains(HoodiePayloadProps.PAYLOAD_EVENT_TIME_FIELD_PROP_KEY)
&& msg.contains(HoodieWriteConfig.TRACK_EVENT_TIME_WATERMARK.key()));
assertTrue(foundHint,
"Expected warning hint about TRACK_EVENT_TIME_WATERMARK when event-time field is set without tracking");
}
}