Skip to content

[Fix-18274] Fix client heartbeat not updated after database out of service for longer than session timeout time #18275

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
qiong-zhou wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

[Fix-18274] Fix client heartbeat not updated after database out of service for longer than session timeout time #18275

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6b64f1f
Fix issue #18274
qiong-zhou May 20, 2026
e14254b
Fix issue #18274
qiong-zhou May 21, 2026
a72dab4
Merge branch 'dev' into Fix-18274
SbloodyS May 25, 2026
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
7 changes: 7 additions & 0 deletions ...pache/dolphinscheduler/plugin/registry/jdbc/mapper/JdbcRegistryClientHeartbeatMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

import org.apache.dolphinscheduler.plugin.registry.jdbc.model.DO.JdbcRegistryClientHeartbeat;

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;

import java.util.List;
Expand All @@ -30,4 +31,10 @@ public interface JdbcRegistryClientHeartbeatMapper extends BaseMapper<JdbcRegist
@Select("select * from t_ds_jdbc_registry_client_heartbeat")
List<JdbcRegistryClientHeartbeat> selectAll();

@Insert("INSERT INTO t_ds_jdbc_registry_client_heartbeat(id, client_name, last_heartbeat_time, connection_config, create_time) "
+
"VALUES(#{id}, #{clientName}, #{lastHeartbeatTime}, #{connectionConfig}, NOW()) " +
"ON DUPLICATE KEY UPDATE " +
"last_heartbeat_time = #{lastHeartbeatTime}")
Comment thread
qiong-zhou marked this conversation as resolved.
Outdated
void upsert(JdbcRegistryClientHeartbeat clientHeartbeat);
}
6 changes: 6 additions & 0 deletions ...apache/dolphinscheduler/plugin/registry/jdbc/repository/JdbcRegistryClientRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ public boolean updateById(JdbcRegistryClientHeartbeatDTO jdbcRegistryClientHeart
return jdbcRegistryClientHeartbeatMapper.updateById(jdbcRegistryClientHeartbeat) == 1;
}

public void upsert(JdbcRegistryClientHeartbeatDTO clientHeartbeatDTO) {
JdbcRegistryClientHeartbeat clientHeartbeat =
JdbcRegistryClientHeartbeatDTO.toJdbcRegistryClientHeartbeat(clientHeartbeatDTO);
jdbcRegistryClientHeartbeatMapper.upsert(clientHeartbeat);
}

public void insert(JdbcRegistryClientHeartbeatDTO jdbcRegistryClient) {
checkNotNull(jdbcRegistryClient.getId());
JdbcRegistryClientHeartbeat jdbcRegistryClientHeartbeat =
Expand Down
2 changes: 1 addition & 1 deletion ...main/java/org/apache/dolphinscheduler/plugin/registry/jdbc/server/JdbcRegistryServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ private void refreshClientsHeartbeat() {
}
JdbcRegistryClientHeartbeatDTO clone = jdbcRegistryClientHeartbeatDTO.clone();
clone.setLastHeartbeatTime(now);
jdbcRegistryClientRepository.updateById(jdbcRegistryClientHeartbeatDTO);
jdbcRegistryClientRepository.upsert(jdbcRegistryClientHeartbeatDTO);

@ruanwenjun ruanwenjun May 20, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's better don't use upsert here, if the client heartbeat has been removed, then we should shutdown, since the server might have been failovered by other server.

@qiong-zhou qiong-zhou May 20, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

If the client is not down. The connection to the database is unreachable within more than a session timeout time. When the database is available, the client will send the heartbeat with the same client ID.
You mean in this case, the client should generate an new client ID and insert a new client record?

@ruanwenjun ruanwenjun May 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If the session times out and the heartbeat is removed, the server/client should stop rather than reinsert a heartbeat, because at this point other servers may have already detected that the heartbeat is down and initiated fault-tolerance procedures.

@ruanwenjun ruanwenjun May 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

A more recommended approach would be to throw an exception when

jdbcRegistryClientRepository.updateById(jdbcRegistryClientHeartbeatDTO);

fails, and make refreshClientsHeartbeat return directly when jdbcRegistryServerState == JdbcRegistryServerState.DISCONNECTED.

@qiong-zhou qiong-zhou May 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

So this client should be restarted manually to register it again?

@ruanwenjun ruanwenjun May 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The client shouldn't restarted, it should shutdown

@qiong-zhou qiong-zhou May 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sorry, I'm confused. How to register this client again?

@ruanwenjun ruanwenjun May 21, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

When a session times out, indicating that the client has disconnected, a disconnection event must be triggered, and the service will automatically terminate without requiring re-registration.

@ruanwenjun ruanwenjun May 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We’d better avoid using upsert, as it may lead to split-brain issues. When the session times out, the service should terminate itself. If we want to improve failure tolerance, we should increase the session timeout instead.

jdbcRegistryClientHeartbeatDTO.setLastHeartbeatTime(clone.getLastHeartbeatTime());
}
if (jdbcRegistryServerState == JdbcRegistryServerState.SUSPENDED) {
Expand Down
Loading