Skip to content

Commit bab1fe3

Browse files
voidzcyvoidzcy
authored
services: move classes with protobuf dependency into io.grpc.protobuf.services (grpc#8056)
To separately manage services/classes with and without protobuf dependency in services package, we are moving classes with protobuf dependency into io.grpc.protobuf.services. This includes healthchecking, reflection, channelz, and binlogging. Forwarding classes are created to avoid breaking existing users, while they are marked as deprecated to notify users to migrate.
1 parent eb67648 commit bab1fe3

34 files changed

Lines changed: 488 additions & 209 deletions

‎interop-testing/src/main/java/io/grpc/testing/integration/XdsTestServer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@
3030
import io.grpc.StatusRuntimeException;
3131
import io.grpc.health.v1.HealthCheckResponse.ServingStatus;
3232
import io.grpc.netty.NettyServerBuilder;
33+
import io.grpc.protobuf.services.HealthStatusManager;
3334
import io.grpc.protobuf.services.ProtoReflectionService;
3435
import io.grpc.services.AdminInterface;
35-
import io.grpc.services.HealthStatusManager;
3636
import io.grpc.stub.StreamObserver;
3737
import io.grpc.testing.integration.Messages.SimpleRequest;
3838
import io.grpc.testing.integration.Messages.SimpleResponse;

‎services/BUILD.bazel‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ package(default_visibility = ["//visibility:public"])
55
java_library(
66
name = "binarylog",
77
srcs = [
8-
"src/main/java/io/grpc/services/BinaryLogProvider.java",
9-
"src/main/java/io/grpc/services/BinaryLogProviderImpl.java",
10-
"src/main/java/io/grpc/services/BinaryLogSink.java",
11-
"src/main/java/io/grpc/services/BinlogHelper.java",
12-
"src/main/java/io/grpc/services/InetAddressUtil.java",
13-
"src/main/java/io/grpc/services/TempFileSink.java",
8+
"src/main/java/io/grpc/protobuf/services/BinaryLogProvider.java",
9+
"src/main/java/io/grpc/protobuf/services/BinaryLogProviderImpl.java",
10+
"src/main/java/io/grpc/protobuf/services/BinaryLogSink.java",
11+
"src/main/java/io/grpc/protobuf/services/BinlogHelper.java",
12+
"src/main/java/io/grpc/protobuf/services/InetAddressUtil.java",
13+
"src/main/java/io/grpc/protobuf/services/TempFileSink.java",
1414
],
1515
deps = [
1616
"//api",
@@ -26,7 +26,8 @@ java_library(
2626
java_library(
2727
name = "channelz",
2828
srcs = [
29-
"src/main/java/io/grpc/services/ChannelzProtoUtil.java",
29+
"src/main/java/io/grpc/protobuf/services/ChannelzProtoUtil.java",
30+
"src/main/java/io/grpc/protobuf/services/ChannelzService.java",
3031
"src/main/java/io/grpc/services/ChannelzService.java",
3132
],
3233
deps = [
@@ -66,7 +67,8 @@ java_library(
6667
java_library(
6768
name = "health",
6869
srcs = [
69-
"src/main/java/io/grpc/services/HealthServiceImpl.java",
70+
"src/main/java/io/grpc/protobuf/services/HealthServiceImpl.java",
71+
"src/main/java/io/grpc/protobuf/services/HealthStatusManager.java",
7072
"src/main/java/io/grpc/services/HealthStatusManager.java",
7173
],
7274
deps = [

services/src/main/java/io/grpc/services/BinaryLogProvider.java renamed to services/src/main/java/io/grpc/protobuf/services/BinaryLogProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import com.google.common.annotations.VisibleForTesting;
2020
import com.google.common.base.Preconditions;

services/src/main/java/io/grpc/services/BinaryLogProviderImpl.java renamed to services/src/main/java/io/grpc/protobuf/services/BinaryLogProviderImpl.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import com.google.common.base.Preconditions;
2020
import io.grpc.CallOptions;

services/src/main/java/io/grpc/services/BinaryLogSink.java renamed to services/src/main/java/io/grpc/protobuf/services/BinaryLogSink.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import com.google.protobuf.MessageLite;
2020
import io.grpc.ExperimentalApi;

‎services/src/main/java/io/grpc/protobuf/services/BinaryLogs.java‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2018, gRPC Authors All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.protobuf.services;
18+
19+
import io.grpc.BinaryLog;
20+
import io.grpc.ExperimentalApi;
21+
import java.io.IOException;
22+
23+
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4017")
24+
public final class BinaryLogs {
25+
/**
26+
* Creates a binary log that writes to a temp file. <b>Warning:</b> this implementation is
27+
* not performance optimized, and RPCs will experience back pressure if disk IO does not keep
28+
* up.
29+
*/
30+
public static BinaryLog createBinaryLog() throws IOException {
31+
return new BinaryLogProviderImpl();
32+
}
33+
34+
/**
35+
* Deprecated and will be removed in a future version of gRPC.
36+
*/
37+
@Deprecated
38+
public static BinaryLog createBinaryLog(BinaryLogSink sink) throws IOException {
39+
return new BinaryLogProviderImpl(sink);
40+
}
41+
42+
/**
43+
* Creates a binary log with a custom {@link BinaryLogSink} for receiving the logged data,
44+
* and a config string as defined by
45+
* <a href="https://github.com/grpc/proposal/blob/master/A16-binary-logging.md">
46+
* A16-binary-logging</a>.
47+
*/
48+
public static BinaryLog createBinaryLog(BinaryLogSink sink, String configStr) throws IOException {
49+
return new BinaryLogProviderImpl(sink, configStr);
50+
}
51+
52+
private BinaryLogs() {}
53+
}

services/src/main/java/io/grpc/services/BinlogHelper.java renamed to services/src/main/java/io/grpc/protobuf/services/BinlogHelper.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import static com.google.common.base.Preconditions.checkArgument;
2020
import static com.google.common.base.Preconditions.checkNotNull;
2121
import static com.google.common.base.Preconditions.checkState;
22-
import static io.grpc.services.BinaryLogProvider.BYTEARRAY_MARSHALLER;
22+
import static io.grpc.protobuf.services.BinaryLogProvider.BYTEARRAY_MARSHALLER;
2323

2424
import com.google.common.annotations.VisibleForTesting;
2525
import com.google.common.base.Charsets;

services/src/main/java/io/grpc/services/ChannelzProtoUtil.java renamed to services/src/main/java/io/grpc/protobuf/services/ChannelzProtoUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import com.google.common.base.Preconditions;
2020
import com.google.common.util.concurrent.ListenableFuture;

‎services/src/main/java/io/grpc/protobuf/services/ChannelzService.java‎

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,234 @@
1+
/*
2+
* Copyright 2018 The gRPC Authors
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package io.grpc.protobuf.services;
18+
19+
import com.google.common.annotations.VisibleForTesting;
20+
import io.grpc.ExperimentalApi;
21+
import io.grpc.InternalChannelz;
22+
import io.grpc.InternalChannelz.ChannelStats;
23+
import io.grpc.InternalChannelz.ServerList;
24+
import io.grpc.InternalChannelz.ServerSocketsList;
25+
import io.grpc.InternalChannelz.ServerStats;
26+
import io.grpc.InternalChannelz.SocketStats;
27+
import io.grpc.InternalInstrumented;
28+
import io.grpc.Status;
29+
import io.grpc.StatusRuntimeException;
30+
import io.grpc.channelz.v1.ChannelzGrpc;
31+
import io.grpc.channelz.v1.GetChannelRequest;
32+
import io.grpc.channelz.v1.GetChannelResponse;
33+
import io.grpc.channelz.v1.GetServerRequest;
34+
import io.grpc.channelz.v1.GetServerResponse;
35+
import io.grpc.channelz.v1.GetServerSocketsRequest;
36+
import io.grpc.channelz.v1.GetServerSocketsResponse;
37+
import io.grpc.channelz.v1.GetServersRequest;
38+
import io.grpc.channelz.v1.GetServersResponse;
39+
import io.grpc.channelz.v1.GetSocketRequest;
40+
import io.grpc.channelz.v1.GetSocketResponse;
41+
import io.grpc.channelz.v1.GetSubchannelRequest;
42+
import io.grpc.channelz.v1.GetSubchannelResponse;
43+
import io.grpc.channelz.v1.GetTopChannelsRequest;
44+
import io.grpc.channelz.v1.GetTopChannelsResponse;
45+
import io.grpc.stub.StreamObserver;
46+
47+
/**
48+
* The channelz service provides stats about a running gRPC process.
49+
*/
50+
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4206")
51+
public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase {
52+
private final InternalChannelz channelz;
53+
private final int maxPageSize;
54+
55+
/**
56+
* Creates an instance.
57+
*/
58+
public static ChannelzService newInstance(int maxPageSize) {
59+
return new ChannelzService(InternalChannelz.instance(), maxPageSize);
60+
}
61+
62+
@VisibleForTesting
63+
ChannelzService(InternalChannelz channelz, int maxPageSize) {
64+
this.channelz = channelz;
65+
this.maxPageSize = maxPageSize;
66+
}
67+
68+
/** Returns top level channel aka {@link io.grpc.ManagedChannel}. */
69+
@Override
70+
public void getTopChannels(
71+
GetTopChannelsRequest request, StreamObserver<GetTopChannelsResponse> responseObserver) {
72+
InternalChannelz.RootChannelList rootChannels
73+
= channelz.getRootChannels(request.getStartChannelId(), maxPageSize);
74+
75+
GetTopChannelsResponse resp;
76+
try {
77+
resp = ChannelzProtoUtil.toGetTopChannelResponse(rootChannels);
78+
} catch (StatusRuntimeException e) {
79+
responseObserver.onError(e);
80+
return;
81+
}
82+
83+
responseObserver.onNext(resp);
84+
responseObserver.onCompleted();
85+
}
86+
87+
/** Returns a top level channel aka {@link io.grpc.ManagedChannel}. */
88+
@Override
89+
public void getChannel(
90+
GetChannelRequest request, StreamObserver<GetChannelResponse> responseObserver) {
91+
InternalInstrumented<ChannelStats> s = channelz.getRootChannel(request.getChannelId());
92+
if (s == null) {
93+
responseObserver.onError(
94+
Status.NOT_FOUND.withDescription("Can't find channel " + request.getChannelId())
95+
.asRuntimeException());
96+
return;
97+
}
98+
99+
GetChannelResponse resp;
100+
try {
101+
resp = GetChannelResponse
102+
.newBuilder()
103+
.setChannel(ChannelzProtoUtil.toChannel(s))
104+
.build();
105+
} catch (StatusRuntimeException e) {
106+
responseObserver.onError(e);
107+
return;
108+
}
109+
110+
responseObserver.onNext(resp);
111+
responseObserver.onCompleted();
112+
}
113+
114+
/** Returns servers. */
115+
@Override
116+
public void getServers(
117+
GetServersRequest request, StreamObserver<GetServersResponse> responseObserver) {
118+
ServerList servers = channelz.getServers(request.getStartServerId(), maxPageSize);
119+
120+
GetServersResponse resp;
121+
try {
122+
resp = ChannelzProtoUtil.toGetServersResponse(servers);
123+
} catch (StatusRuntimeException e) {
124+
responseObserver.onError(e);
125+
return;
126+
}
127+
128+
responseObserver.onNext(resp);
129+
responseObserver.onCompleted();
130+
}
131+
132+
/** Returns a server. */
133+
@Override
134+
public void getServer(
135+
GetServerRequest request, StreamObserver<GetServerResponse> responseObserver) {
136+
InternalInstrumented<ServerStats> s = channelz.getServer(request.getServerId());
137+
if (s == null) {
138+
responseObserver.onError(
139+
Status.NOT_FOUND.withDescription("Can't find server " + request.getServerId())
140+
.asRuntimeException());
141+
return;
142+
}
143+
144+
GetServerResponse resp;
145+
try {
146+
resp = GetServerResponse
147+
.newBuilder()
148+
.setServer(ChannelzProtoUtil.toServer(s))
149+
.build();
150+
} catch (StatusRuntimeException e) {
151+
responseObserver.onError(e);
152+
return;
153+
}
154+
155+
responseObserver.onNext(resp);
156+
responseObserver.onCompleted();
157+
}
158+
159+
/** Returns a subchannel. */
160+
@Override
161+
public void getSubchannel(
162+
GetSubchannelRequest request, StreamObserver<GetSubchannelResponse> responseObserver) {
163+
InternalInstrumented<ChannelStats> s = channelz.getSubchannel(request.getSubchannelId());
164+
if (s == null) {
165+
responseObserver.onError(
166+
Status.NOT_FOUND.withDescription("Can't find subchannel " + request.getSubchannelId())
167+
.asRuntimeException());
168+
return;
169+
}
170+
171+
GetSubchannelResponse resp;
172+
try {
173+
resp = GetSubchannelResponse
174+
.newBuilder()
175+
.setSubchannel(ChannelzProtoUtil.toSubchannel(s))
176+
.build();
177+
} catch (StatusRuntimeException e) {
178+
responseObserver.onError(e);
179+
return;
180+
}
181+
182+
responseObserver.onNext(resp);
183+
responseObserver.onCompleted();
184+
}
185+
186+
/** Returns a socket. */
187+
@Override
188+
public void getSocket(
189+
GetSocketRequest request, StreamObserver<GetSocketResponse> responseObserver) {
190+
InternalInstrumented<SocketStats> s = channelz.getSocket(request.getSocketId());
191+
if (s == null) {
192+
responseObserver.onError(
193+
Status.NOT_FOUND.withDescription("Can't find socket " + request.getSocketId())
194+
.asRuntimeException());
195+
return;
196+
}
197+
198+
GetSocketResponse resp;
199+
try {
200+
resp =
201+
GetSocketResponse.newBuilder().setSocket(ChannelzProtoUtil.toSocket(s)).build();
202+
} catch (StatusRuntimeException e) {
203+
responseObserver.onError(e);
204+
return;
205+
}
206+
207+
responseObserver.onNext(resp);
208+
responseObserver.onCompleted();
209+
}
210+
211+
@Override
212+
public void getServerSockets(
213+
GetServerSocketsRequest request, StreamObserver<GetServerSocketsResponse> responseObserver) {
214+
ServerSocketsList serverSockets
215+
= channelz.getServerSockets(request.getServerId(), request.getStartSocketId(), maxPageSize);
216+
if (serverSockets == null) {
217+
responseObserver.onError(
218+
Status.NOT_FOUND.withDescription("Can't find server " + request.getServerId())
219+
.asRuntimeException());
220+
return;
221+
}
222+
223+
GetServerSocketsResponse resp;
224+
try {
225+
resp = ChannelzProtoUtil.toGetServerSocketsResponse(serverSockets);
226+
} catch (StatusRuntimeException e) {
227+
responseObserver.onError(e);
228+
return;
229+
}
230+
231+
responseObserver.onNext(resp);
232+
responseObserver.onCompleted();
233+
}
234+
}

services/src/main/java/io/grpc/services/HealthCheckingLoadBalancerFactory.java renamed to services/src/main/java/io/grpc/protobuf/services/HealthCheckingLoadBalancerFactory.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* limitations under the License.
1515
*/
1616

17-
package io.grpc.services;
17+
package io.grpc.protobuf.services;
1818

1919
import static com.google.common.base.Preconditions.checkNotNull;
2020
import static com.google.common.base.Preconditions.checkState;

0 commit comments

Comments
 (0)