Skip to content

[FLINK-33022] Log an error when enrichers defined as part of the configuration can not be found/loaded #23386

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

Merged
merged 1 commit into from
Sep 15, 2023
Merged

[FLINK-33022] Log an error when enrichers defined as part of the configuration can not be found/loaded #23386

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
14 changes: 10 additions & 4 deletions flink-runtime/src/main/java/org/apache/flink/runtime/failure/FailureEnricherUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ public static Collection<FailureEnricher> getFailureEnrichers(
@VisibleForTesting
static Collection<FailureEnricher> getFailureEnrichers(
final Configuration configuration, final PluginManager pluginManager) {
Set<String> includedEnrichers = getIncludedFailureEnrichers(configuration);
final Set<String> enrichersToLoad = getIncludedFailureEnrichers(configuration);
// When empty, NO enrichers will be started.
if (includedEnrichers.isEmpty()) {
if (enrichersToLoad.isEmpty()) {
return Collections.emptySet();
}
final Iterator<FailureEnricherFactory> factoryIterator =
Expand All @@ -87,7 +87,7 @@ static Collection<FailureEnricher> getFailureEnrichers(
final FailureEnricherFactory failureEnricherFactory = factoryIterator.next();
final FailureEnricher failureEnricher =
failureEnricherFactory.createFailureEnricher(configuration);
if (includedEnrichers.contains(failureEnricher.getClass().getName())) {
if (enrichersToLoad.remove(failureEnricher.getClass().getName())) {
failureEnrichers.add(failureEnricher);
LOG.info(
"Found failure enricher {} at {}.",
Expand All @@ -102,10 +102,16 @@ static Collection<FailureEnricher> getFailureEnrichers(
LOG.debug(
"Excluding failure enricher {}, not configured in enricher list ({}).",
failureEnricherFactory.getClass().getName(),
includedEnrichers);
enrichersToLoad);
}
}

if (!enrichersToLoad.isEmpty()) {
LOG.error(
"The following failure enrichers were configured but not found on the classpath: {}.",
enrichersToLoad);
}

return filterInvalidEnrichers(failureEnrichers);
}

Expand Down
15 changes: 14 additions & 1 deletion flink-runtime/src/test/java/org/apache/flink/runtime/failure/FailureEnricherUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,20 @@ public void testGetFailureEnrichers() {
FailureEnricherUtils.getFailureEnrichers(configuration, createPluginManager());
assertThat(enrichers).hasSize(1);
// verify that the failure enricher was created and returned
assertThat(enrichers.iterator().next()).isInstanceOf(TestEnricher.class);
assertThat(enrichers)
.satisfiesExactly(
enricher -> assertThat(enricher).isInstanceOf(TestEnricher.class));

// Valid plus Invalid Name combination
configuration.set(
JobManagerOptions.FAILURE_ENRICHERS_LIST,
FailureEnricherUtilsTest.class.getName() + "," + TestEnricher.class.getName());
final Collection<FailureEnricher> validInvalidEnrichers =
FailureEnricherUtils.getFailureEnrichers(configuration, createPluginManager());
assertThat(validInvalidEnrichers).hasSize(1);
assertThat(validInvalidEnrichers)
.satisfiesExactly(
enricher -> assertThat(enricher).isInstanceOf(TestEnricher.class));
}

@Test
Expand Down