This is an automated email from the ASF dual-hosted git repository.
zuston pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-uniffle.git
The following commit(s) were added to refs/heads/master by this push:
new 3fde80c16 [#2046] fix(coordinator): Rename RSS_CLIENT_TYPE to
RSS_COORDINATOR_CLIENT_TYPE (#2047)
3fde80c16 is described below
commit 3fde80c1660d7fe7060e4b601a0c7be99caa3d24
Author: xumanbu <jam...@vipshop.com>
AuthorDate: Mon Aug 19 11:11:16 2024 +0800
[#2046] fix(coordinator): Rename RSS_CLIENT_TYPE to
RSS_COORDINATOR_CLIENT_TYPE (#2047)
## What changes were proposed in this pull request?
Rename RSS_CLIENT_TYPE to RSS_COORDINATOR_CLIENT_TYPE
### Why are the changes needed?
The RssClientConf#RSS_CLIENT_TYPE is used for creating ShuffleReaderClient
and ShuffleWriteClient, while the RssBaseConf#RSS_CLIENT_TYPE is for creating
CoordinatorClient in the ShuffleServer. This may cause confusion in the code.
Fix: #2046
### Does this PR introduce _any_ user-facing change?
YES.
### How was this patch tested?
NONEED
---
.../src/main/java/org/apache/uniffle/common/config/RssBaseConf.java | 6 +++---
docs/server_guide.md | 3 ++-
.../src/main/java/org/apache/uniffle/server/RegisterHeartBeat.java | 2 +-
3 files changed, 6 insertions(+), 5 deletions(-)
diff --git
a/common/src/main/java/org/apache/uniffle/common/config/RssBaseConf.java
b/common/src/main/java/org/apache/uniffle/common/config/RssBaseConf.java
index 71d2d5460..cdaf59f19 100644
--- a/common/src/main/java/org/apache/uniffle/common/config/RssBaseConf.java
+++ b/common/src/main/java/org/apache/uniffle/common/config/RssBaseConf.java
@@ -151,11 +151,11 @@ public class RssBaseConf extends RssConf {
.defaultValue(1024L * 1024L * 1024L)
.withDescription("Max size of rpc message (byte)");
- public static final ConfigOption<ClientType> RSS_CLIENT_TYPE =
- ConfigOptions.key("rss.rpc.client.type")
+ public static final ConfigOption<ClientType> RSS_COORDINATOR_CLIENT_TYPE =
+ ConfigOptions.key("rss.coordinator.rpc.client.type")
.enumType(ClientType.class)
.defaultValue(ClientType.GRPC)
- .withDescription("client type for rss");
+ .withDescription("client type for coordinator rpc client.");
public static final ConfigOption<StorageType> RSS_STORAGE_TYPE =
ConfigOptions.key("rss.storage.type")
diff --git a/docs/server_guide.md b/docs/server_guide.md
index a187bb419..b8002aced 100644
--- a/docs/server_guide.md
+++ b/docs/server_guide.md
@@ -72,6 +72,7 @@ This document will introduce how to deploy Uniffle shuffle
servers.
| Property Name | Default
| Description
[...]
|----------------------------------------------------------|------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| rss.coordinator.quorum | -
| Coordinator quorum
[...]
+| rss.coordinator.rpc.client.type | GRPC
| The client type for
coordinator rpc client.
[...]
| rss.rpc.server.type | GRPC
| Shuffle server type,
supports GRPC_NETTY, GRPC. The default value is GRPC. But we recommend using
GRPC_NETTY to enable Netty on the server side for better stability and
performance.
[...]
| rss.rpc.server.port | 19999
| RPC port for Shuffle
server, if set zero, grpc server start on random port.
[...]
| rss.rpc.netty.pageSize | 4096
| The value of pageSize
for PooledByteBufAllocator when using gRPC internal Netty on the server-side.
This configuration will only take effect when rss.rpc.server.type is set to
GRPC_NETTY.
[...]
@@ -240,4 +241,4 @@ In this case, you can set the following parameters to allow
mimalloc to return m
```
export MIMALLOC_PURGE_DELAY=0
-```
\ No newline at end of file
+```
diff --git
a/server/src/main/java/org/apache/uniffle/server/RegisterHeartBeat.java
b/server/src/main/java/org/apache/uniffle/server/RegisterHeartBeat.java
index 736b05581..d18f29cd7 100644
--- a/server/src/main/java/org/apache/uniffle/server/RegisterHeartBeat.java
+++ b/server/src/main/java/org/apache/uniffle/server/RegisterHeartBeat.java
@@ -58,7 +58,7 @@ public class RegisterHeartBeat {
CoordinatorClientFactory factory = CoordinatorClientFactory.getInstance();
this.coordinatorClients =
factory.createCoordinatorClient(
- conf.get(ShuffleServerConf.RSS_CLIENT_TYPE),
this.coordinatorQuorum);
+ conf.get(ShuffleServerConf.RSS_COORDINATOR_CLIENT_TYPE),
this.coordinatorQuorum);
this.shuffleServer = shuffleServer;
this.heartBeatExecutorService =
ThreadUtils.getDaemonFixedThreadPool(
