[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17053

Aitozi · 2021-08-30T13:04:00Z

What is the purpose of the change

As described in issue , this PR is meant to fix the potential job unrecoverable due to network failure . This is done by add an unhandledErrorListener before start curator client

Tests:
ZookeeperUtilsTest#testStartCuratorFrameworkFailed

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (no)
The public API, i.e., is any changed class annotated with @Public(Evolving): (no)
The serializers: (no)
The runtime per-record code paths (performance sensitive): (no)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: (yes)
The S3 file system connector: (no)

flinkbot · 2021-08-30T13:18:03Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 3e938a7 (Mon Aug 30 13:18:03 UTC 2021)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2021-08-30T13:49:40Z

CI report:

da1ab05 UNKNOWN
cfe260b UNKNOWN
505c576 Azure: SUCCESS
03dc417 Azure: PENDING

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

tillrohrmann

Thanks for creating this PR @Aitozi. I think you are right that we don't handle the case properly where the CuratorZookeeperClient.start fails. In order to do that we have to register an UnhandledErrorListener right away.

I left a couple of comments. Please take a look.

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

flink-runtime/src/test/java/org/apache/flink/runtime/util/ZooKeeperUtilsTest.java

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

tillrohrmann · 2021-08-31T15:19:12Z

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

+        // This handler is only used to handle the error during start phase, and should be
+        // removed after start curator success.
+        UnhandledErrorListener unhandledErrorListener =
+                (message, throwable) -> {
+                    LOG.error(
+                            "Exiting process for unhandled error in start curator framework, "
+                                    + "error message: {}, exiting code: {}",
+                            message,
+                            ZOOKEEPER_FAILURE_EXIT_CODE,
+                            throwable);
+                    System.exit(ZOOKEEPER_FAILURE_EXIT_CODE);
+                };
+        cf.getUnhandledErrorListenable().addListener(unhandledErrorListener);


I am actually wondering whether we shouldn't only register this one handler and remove the listeners in the ZooKeeperLeaderElectionDriver and ZooKeeperLeaderRetrievalDriver because these two listeners would be called for every unhandled exception that occurs in Curator independent of the actual source. Moreover, the current UnhandledErrorListener always call the FatalExitExceptionHandler eventually.

I don't really get your meaning， may be it's should only ?

I think we could safely remove the listener in leaderElectionDriver and leaderRetrievalDriver like you said that，all the three handlers always exit the process now, after one execute other will not be executed. So there is no meaning to register other handlers.

Yes, I meant to only register this one failure handler and remove the listener in leaderElectionDriver and leaderRetrievalDriver.

Aitozi · 2021-09-01T05:31:20Z

Thanks for your review @tillrohrmann . I have addressed most of your comments. Regarding to whether to remove the listener in ZooKeeperLeaderElectionDriver and ZooKeeperLeaderRetrievalDriver, I think it's somehow out of this issue. Maybe I can open another PR to remove them.

tillrohrmann

Thanks for updating this PR @Aitozi. I think it is ok to remove the UnhandledErrorListener from the ZooKeeperLeaderElectionDriver and ZooKeeperLeaderRetrievalDriver as a follow-up step. What we probably should do is to pass in a FatalErrorHandler into the ZooKeeperUtils.startCuratorFramework. That way we can integrate the failure handling with the ClusterEntrypoint, TaskManagerRunner, etc.

tillrohrmann · 2021-09-01T08:53:34Z

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

+                (message, throwable) -> {
+                    LOG.error(
+                            "Exiting process for unhandled error in curator framework, "
+                                    + "error message: {}, exiting code: {}",
+                            message,
+                            ZOOKEEPER_FAILURE_EXIT_CODE,
+                            throwable);
+                    FlinkSecurityManager.forceProcessExit(ZOOKEEPER_FAILURE_EXIT_CODE);


Maybe it is actually better if we can pass in a FatalErrorHandler. That way we can integrate the failure handling with the general logic (e.g. in the ClusterEntrypoint we add additional information if there was a out of memory error).

Then we wouldn't have the problems of how to test for FlinkSecurityManager.forceProcessExit.

Get it, I will add the FatalErrorHandler

Passed FatalErrorHandler to ZookeeperUtils#startCuratorFramework. Please help review again.

Aitozi · 2021-09-02T05:42:03Z

@flinkbot run azure

tillrohrmann

Thanks for updating this PR @Aitozi. I think it looks almost mergeable. I left some suggestions for improvements and a comment how to set the FatalErrorHandler in the RestClusterClient. Please take a look.

tillrohrmann · 2021-09-02T15:05:48Z

flink-clients/src/main/java/org/apache/flink/client/program/rest/RestClusterClient.java

+        this.configuration = checkNotNull(configuration);
+
+        this.restClusterClientConfiguration =
+                RestClusterClientConfiguration.fromConfiguration(configuration);
+
+        if (restClient != null) {
+            this.restClient = restClient;
+        } else {
+            this.restClient = new RestClient(configuration, executorService);
+        }
+
+        this.waitStrategy = checkNotNull(waitStrategy);
+        this.clusterId = checkNotNull(clusterId);
+
+        this.clientHAServices =
+                HighAvailabilityServicesUtils.createClientHAService(
+                        configuration,
+                        exception ->
+                                webMonitorLeaderRetriever.handleError(
+                                        new FlinkException(exception)));
+
+        this.webMonitorRetrievalService = clientHAServices.getClusterRestEndpointLeaderRetriever();
+        this.retryExecutorService =
+                Executors.newSingleThreadScheduledExecutor(
+                        new ExecutorThreadFactory("Flink-RestClusterClient-Retry"));
+        startLeaderRetrievers();


This does not feel right. We are effectively copying the next constructor. I think there must be another solution. Maybe, if we don't specify a ClientHighAvailabilityServices, then we instantiate it with a handler that terminates the process in case of an unhandled exception.

But I think it's strange to directly terminate the client process. And the current webMonitorRetrievalService also just complete the future with exception. I have to copy the constructor mainly due to there is a constructor which accept the StandaloneClientHAServices.

Maybe I can use an ClientHighAvailabilityServicesFactory here to decouple the RestClusterClient with concrete ClientHighAvailabilityServices

Yes, this could be a good solution to decouple these two components a bit better.

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

tillrohrmann · 2021-09-02T15:07:07Z

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

@@ -149,9 +151,12 @@ public static String generateLeaderLatchPath(String path) {
     * Starts a {@link CuratorFramework} instance and connects it to the given ZooKeeper quorum.
     *
     * @param configuration {@link Configuration} object containing the configuration values
+     * @param fatalErrorHandler {@link FatalErrorHandler} fatalErrorHandler to handle unExpected
+     *     error of {@link CuratorFramework}


Suggested change

* error of {@link CuratorFramework}

* errors of {@link CuratorFramework}

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

tillrohrmann · 2021-09-02T15:08:42Z

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java

+                            "Unhandled error in curator framework, error message: {}",
+                            message,
+                            throwable);
+                    // The exception thrown in UnhandledErrorListener will be catch by


Which exception is thrown here?

I comment to draw attention to UnhandledErrorListener will catch all exception when executed. The FatalErrorHandler used here should be aware of this. If a handler just throw an exception may be eat by curator framework.

...src/test/java/org/apache/flink/runtime/checkpoint/ZKCheckpointIDCounterMultiServersTest.java

flink-runtime/src/test/java/org/apache/flink/runtime/util/ZooKeeperUtilsTest.java

Aitozi · 2021-09-02T16:59:32Z

Thanks for your review , I have fixed all of your comments, plz take a look again. @tillrohrmann

Aitozi · 2021-09-02T16:59:41Z

@flinkbot run azure

tillrohrmann

Thanks for updating this PR @Aitozi. I think we are almost done. I only had a few minor comments left concerning the usage of anonymous classes. Once these comments are addressed and Azure gives green light, I will merge this PR.

There are also some merge conflicts. Maybe you can rebase this PR while resolving the last comments onto the latest master. Moreover, it would be awesome if you could create a backport against the release-1.14 branch so that we also run CI for this version before merging it back.

tillrohrmann · 2021-09-02T19:49:41Z

flink-clients/src/main/java/org/apache/flink/client/program/rest/RestClusterClient.java

+                new ClientHighAvailabilityServicesFactory() {
+                    @Override
+                    public ClientHighAvailabilityServices create(
+                            Configuration configuration, FatalErrorHandler fatalErrorHandler)
+                            throws Exception {
+                        return HighAvailabilityServicesUtils.createClientHAService(
+                                configuration, fatalErrorHandler);
+                    }


Let's create a DefaultClientHighAvailabilityServicesFactory that has a singleton INSTANCE that does exactly this here. Then we don't have to use anonymous classes.

tillrohrmann · 2021-09-02T19:51:17Z

flink-clients/src/main/java/org/apache/flink/client/program/rest/RestClusterClient.java

+                        new FatalErrorHandler() {
+                            @Override
+                            public void onFatalError(Throwable exception) {
+                                webMonitorLeaderRetriever.handleError(
+                                        new FlinkException(exception));
+                            }


Suggested change

new FatalErrorHandler() {

@Override

public void onFatalError(Throwable exception) {

webMonitorLeaderRetriever.handleError(

new FlinkException(exception));

}

exception ->

webMonitorLeaderRetriever.handleError(

new FlinkException(exception))

A bit less boilerplate.

dose this means add more error msg?

tillrohrmann · 2021-09-02T19:54:09Z

flink-kubernetes/src/main/java/org/apache/flink/kubernetes/KubernetesClusterDescriptor.java

-                        configuration,
-                        clusterId,
-                        new StandaloneClientHAServices(getWebMonitorAddress(configuration)));
+                String webMonitorAddress = getWebMonitorAddress(configuration);


I would move this into the factory because we don't know whether configuration won't be changed.

I made a wrong thought here, done!

flink-kubernetes/src/main/java/org/apache/flink/kubernetes/KubernetesClusterDescriptor.java

Aitozi · 2021-09-02T23:24:19Z

Having addressed all your concerns, thanks for your review time @tillrohrmann

Aitozi · 2021-09-02T23:34:45Z

Created the backport PR

Aitozi · 2021-09-02T23:35:07Z

@flinkbot run azure

tillrohrmann

Thanks for the update. LGTM. Addressing my last comments while merging this PR.

flink-clients/src/main/java/org/apache/flink/client/program/rest/RestClusterClient.java

tillrohrmann · 2021-09-03T09:06:48Z

flink-kubernetes/src/main/java/org/apache/flink/kubernetes/KubernetesClusterDescriptor.java

+                        new ClientHighAvailabilityServicesFactory() {
+                            @Override
+                            public ClientHighAvailabilityServices create(
+                                    Configuration configuration,
+                                    FatalErrorHandler fatalErrorHandler)
+                                    throws Exception {
+                                return new StandaloneClientHAServices(
+                                        getWebMonitorAddress(configuration));
+                            }


Same here probably.

…andledErrorListener before start zk client This closes apache#17053.

rmetzger added the review=description? label Aug 30, 2021

Aitozi force-pushed the zk-handler branch from 3e938a7 to da1ab05 Compare August 30, 2021 14:14

Aitozi changed the title ~~[FLINK-36488942][HA]Handle curator framework start error by register fatalErrorHandler befor start zk client~~ [FLINK-36488942][HA]Handle curator framework start error by register fatalErrorHandler before start zk client Aug 30, 2021

Aitozi force-pushed the zk-handler branch from cca9d28 to ffd10da Compare August 30, 2021 23:59

Aitozi changed the title ~~[FLINK-36488942][HA]Handle curator framework start error by register fatalErrorHandler before start zk client~~ [FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorHandler before start zk client Aug 30, 2021

rmetzger added the component=Runtime/Coordination label Aug 31, 2021

Aitozi force-pushed the zk-handler branch from 928f43c to 2a176d1 Compare August 31, 2021 02:40

Aitozi changed the title ~~[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorHandler before start zk client~~ [FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client Aug 31, 2021

Aitozi commented Aug 31, 2021

View reviewed changes

flink-runtime/src/main/java/org/apache/flink/runtime/util/ZooKeeperUtils.java Outdated Show resolved Hide resolved

tillrohrmann requested changes Aug 31, 2021

View reviewed changes

tillrohrmann requested changes Sep 1, 2021

View reviewed changes

Aitozi force-pushed the zk-handler branch from 7946c81 to 0b57946 Compare September 1, 2021 14:59

tillrohrmann requested changes Sep 2, 2021

View reviewed changes

Aitozi force-pushed the zk-handler branch 2 times, most recently from fd4a9eb to 948cd08 Compare September 2, 2021 16:56

tillrohrmann approved these changes Sep 2, 2021

View reviewed changes

Aitozi force-pushed the zk-handler branch from 948cd08 to 505c576 Compare September 2, 2021 23:21

Aitozi mentioned this pull request Sep 2, 2021

[BP-1.14][FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17130

Merged

tillrohrmann approved these changes Sep 3, 2021

View reviewed changes

tillrohrmann pushed a commit to Aitozi/flink that referenced this pull request Sep 3, 2021

[FLINK-24021][HA]Handle curator framework start error by register Unh…

03dc417

…andledErrorListener before start zk client This closes apache#17053.

tillrohrmann force-pushed the zk-handler branch from 505c576 to 03dc417 Compare September 3, 2021 09:16

[FLINK-24021][HA]Handle curator framework start error by register Unh…

6b4f8a4

…andledErrorListener before start zk client This closes apache#17053.

tillrohrmann force-pushed the zk-handler branch from 03dc417 to 6b4f8a4 Compare September 3, 2021 13:04

tillrohrmann closed this in 6b4f8a4 Sep 3, 2021

tillrohrmann merged commit 6b4f8a4 into apache:master Sep 3, 2021

niklassemmler pushed a commit to niklassemmler/flink that referenced this pull request Feb 3, 2022

[FLINK-24021][HA]Handle curator framework start error by register Unh…

759c541

…andledErrorListener before start zk client This closes apache#17053.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17053

[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17053

Aitozi commented Aug 30, 2021 •

edited

flinkbot commented Aug 30, 2021

flinkbot commented Aug 30, 2021 •

edited

tillrohrmann left a comment

tillrohrmann Aug 31, 2021

Aitozi Aug 31, 2021

tillrohrmann Sep 1, 2021

Aitozi commented Sep 1, 2021

tillrohrmann left a comment

tillrohrmann Sep 1, 2021

tillrohrmann Sep 1, 2021

Aitozi Sep 1, 2021

Aitozi Sep 1, 2021

Aitozi commented Sep 2, 2021

tillrohrmann left a comment

tillrohrmann Sep 2, 2021

Aitozi Sep 2, 2021

Aitozi Sep 2, 2021 •

edited

tillrohrmann Sep 2, 2021

tillrohrmann Sep 2, 2021

tillrohrmann Sep 2, 2021

Aitozi Sep 2, 2021

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

tillrohrmann left a comment •

edited

tillrohrmann Sep 2, 2021

tillrohrmann Sep 2, 2021

Aitozi Sep 2, 2021

tillrohrmann Sep 2, 2021

Aitozi Sep 2, 2021

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

tillrohrmann left a comment

tillrohrmann Sep 3, 2021

	* error of {@link CuratorFramework}
	* errors of {@link CuratorFramework}

[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17053

[FLINK-24021][HA]Handle curator framework start error by register UnhandledErrorListener before start zk client #17053

Conversation

Aitozi commented Aug 30, 2021 • edited

What is the purpose of the change

Does this pull request potentially affect one of the following parts:

flinkbot commented Aug 30, 2021

Automated Checks

Review Progress

flinkbot commented Aug 30, 2021 • edited

CI report:

tillrohrmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi commented Sep 1, 2021

tillrohrmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi commented Sep 2, 2021

tillrohrmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi Sep 2, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

tillrohrmann left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

Aitozi commented Sep 2, 2021

tillrohrmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Aitozi commented Aug 30, 2021 •

edited

flinkbot commented Aug 30, 2021 •

edited

Aitozi Sep 2, 2021 •

edited

tillrohrmann left a comment •

edited