Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
services: move classes with protobuf dependency into io.grpc.protobuf…
….services (#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.
- Loading branch information
Showing
34 changed files
with
488 additions
and
209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
services/src/main/java/io/grpc/protobuf/services/BinaryLogs.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /* | ||
| * Copyright 2018, gRPC Authors All rights reserved. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.protobuf.services; | ||
|
|
||
| import io.grpc.BinaryLog; | ||
| import io.grpc.ExperimentalApi; | ||
| import java.io.IOException; | ||
|
|
||
| @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4017") | ||
| public final class BinaryLogs { | ||
| /** | ||
| * Creates a binary log that writes to a temp file. <b>Warning:</b> this implementation is | ||
| * not performance optimized, and RPCs will experience back pressure if disk IO does not keep | ||
| * up. | ||
| */ | ||
| public static BinaryLog createBinaryLog() throws IOException { | ||
| return new BinaryLogProviderImpl(); | ||
| } | ||
|
|
||
| /** | ||
| * Deprecated and will be removed in a future version of gRPC. | ||
| */ | ||
| @Deprecated | ||
| public static BinaryLog createBinaryLog(BinaryLogSink sink) throws IOException { | ||
| return new BinaryLogProviderImpl(sink); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a binary log with a custom {@link BinaryLogSink} for receiving the logged data, | ||
| * and a config string as defined by | ||
| * <a href="https://github.com/grpc/proposal/blob/master/A16-binary-logging.md"> | ||
| * A16-binary-logging</a>. | ||
| */ | ||
| public static BinaryLog createBinaryLog(BinaryLogSink sink, String configStr) throws IOException { | ||
| return new BinaryLogProviderImpl(sink, configStr); | ||
| } | ||
|
|
||
| private BinaryLogs() {} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
234 changes: 234 additions & 0 deletions
234
services/src/main/java/io/grpc/protobuf/services/ChannelzService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,234 @@ | ||
| /* | ||
| * Copyright 2018 The gRPC Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.grpc.protobuf.services; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import io.grpc.ExperimentalApi; | ||
| import io.grpc.InternalChannelz; | ||
| import io.grpc.InternalChannelz.ChannelStats; | ||
| import io.grpc.InternalChannelz.ServerList; | ||
| import io.grpc.InternalChannelz.ServerSocketsList; | ||
| import io.grpc.InternalChannelz.ServerStats; | ||
| import io.grpc.InternalChannelz.SocketStats; | ||
| import io.grpc.InternalInstrumented; | ||
| import io.grpc.Status; | ||
| import io.grpc.StatusRuntimeException; | ||
| import io.grpc.channelz.v1.ChannelzGrpc; | ||
| import io.grpc.channelz.v1.GetChannelRequest; | ||
| import io.grpc.channelz.v1.GetChannelResponse; | ||
| import io.grpc.channelz.v1.GetServerRequest; | ||
| import io.grpc.channelz.v1.GetServerResponse; | ||
| import io.grpc.channelz.v1.GetServerSocketsRequest; | ||
| import io.grpc.channelz.v1.GetServerSocketsResponse; | ||
| import io.grpc.channelz.v1.GetServersRequest; | ||
| import io.grpc.channelz.v1.GetServersResponse; | ||
| import io.grpc.channelz.v1.GetSocketRequest; | ||
| import io.grpc.channelz.v1.GetSocketResponse; | ||
| import io.grpc.channelz.v1.GetSubchannelRequest; | ||
| import io.grpc.channelz.v1.GetSubchannelResponse; | ||
| import io.grpc.channelz.v1.GetTopChannelsRequest; | ||
| import io.grpc.channelz.v1.GetTopChannelsResponse; | ||
| import io.grpc.stub.StreamObserver; | ||
|
|
||
| /** | ||
| * The channelz service provides stats about a running gRPC process. | ||
| */ | ||
| @ExperimentalApi("https://github.com/grpc/grpc-java/issues/4206") | ||
| public final class ChannelzService extends ChannelzGrpc.ChannelzImplBase { | ||
| private final InternalChannelz channelz; | ||
| private final int maxPageSize; | ||
|
|
||
| /** | ||
| * Creates an instance. | ||
| */ | ||
| public static ChannelzService newInstance(int maxPageSize) { | ||
| return new ChannelzService(InternalChannelz.instance(), maxPageSize); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| ChannelzService(InternalChannelz channelz, int maxPageSize) { | ||
| this.channelz = channelz; | ||
| this.maxPageSize = maxPageSize; | ||
| } | ||
|
|
||
| /** Returns top level channel aka {@link io.grpc.ManagedChannel}. */ | ||
| @Override | ||
| public void getTopChannels( | ||
| GetTopChannelsRequest request, StreamObserver<GetTopChannelsResponse> responseObserver) { | ||
| InternalChannelz.RootChannelList rootChannels | ||
| = channelz.getRootChannels(request.getStartChannelId(), maxPageSize); | ||
|
|
||
| GetTopChannelsResponse resp; | ||
| try { | ||
| resp = ChannelzProtoUtil.toGetTopChannelResponse(rootChannels); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| /** Returns a top level channel aka {@link io.grpc.ManagedChannel}. */ | ||
| @Override | ||
| public void getChannel( | ||
| GetChannelRequest request, StreamObserver<GetChannelResponse> responseObserver) { | ||
| InternalInstrumented<ChannelStats> s = channelz.getRootChannel(request.getChannelId()); | ||
| if (s == null) { | ||
| responseObserver.onError( | ||
| Status.NOT_FOUND.withDescription("Can't find channel " + request.getChannelId()) | ||
| .asRuntimeException()); | ||
| return; | ||
| } | ||
|
|
||
| GetChannelResponse resp; | ||
| try { | ||
| resp = GetChannelResponse | ||
| .newBuilder() | ||
| .setChannel(ChannelzProtoUtil.toChannel(s)) | ||
| .build(); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| /** Returns servers. */ | ||
| @Override | ||
| public void getServers( | ||
| GetServersRequest request, StreamObserver<GetServersResponse> responseObserver) { | ||
| ServerList servers = channelz.getServers(request.getStartServerId(), maxPageSize); | ||
|
|
||
| GetServersResponse resp; | ||
| try { | ||
| resp = ChannelzProtoUtil.toGetServersResponse(servers); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| /** Returns a server. */ | ||
| @Override | ||
| public void getServer( | ||
| GetServerRequest request, StreamObserver<GetServerResponse> responseObserver) { | ||
| InternalInstrumented<ServerStats> s = channelz.getServer(request.getServerId()); | ||
| if (s == null) { | ||
| responseObserver.onError( | ||
| Status.NOT_FOUND.withDescription("Can't find server " + request.getServerId()) | ||
| .asRuntimeException()); | ||
| return; | ||
| } | ||
|
|
||
| GetServerResponse resp; | ||
| try { | ||
| resp = GetServerResponse | ||
| .newBuilder() | ||
| .setServer(ChannelzProtoUtil.toServer(s)) | ||
| .build(); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| /** Returns a subchannel. */ | ||
| @Override | ||
| public void getSubchannel( | ||
| GetSubchannelRequest request, StreamObserver<GetSubchannelResponse> responseObserver) { | ||
| InternalInstrumented<ChannelStats> s = channelz.getSubchannel(request.getSubchannelId()); | ||
| if (s == null) { | ||
| responseObserver.onError( | ||
| Status.NOT_FOUND.withDescription("Can't find subchannel " + request.getSubchannelId()) | ||
| .asRuntimeException()); | ||
| return; | ||
| } | ||
|
|
||
| GetSubchannelResponse resp; | ||
| try { | ||
| resp = GetSubchannelResponse | ||
| .newBuilder() | ||
| .setSubchannel(ChannelzProtoUtil.toSubchannel(s)) | ||
| .build(); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| /** Returns a socket. */ | ||
| @Override | ||
| public void getSocket( | ||
| GetSocketRequest request, StreamObserver<GetSocketResponse> responseObserver) { | ||
| InternalInstrumented<SocketStats> s = channelz.getSocket(request.getSocketId()); | ||
| if (s == null) { | ||
| responseObserver.onError( | ||
| Status.NOT_FOUND.withDescription("Can't find socket " + request.getSocketId()) | ||
| .asRuntimeException()); | ||
| return; | ||
| } | ||
|
|
||
| GetSocketResponse resp; | ||
| try { | ||
| resp = | ||
| GetSocketResponse.newBuilder().setSocket(ChannelzProtoUtil.toSocket(s)).build(); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| @Override | ||
| public void getServerSockets( | ||
| GetServerSocketsRequest request, StreamObserver<GetServerSocketsResponse> responseObserver) { | ||
| ServerSocketsList serverSockets | ||
| = channelz.getServerSockets(request.getServerId(), request.getStartSocketId(), maxPageSize); | ||
| if (serverSockets == null) { | ||
| responseObserver.onError( | ||
| Status.NOT_FOUND.withDescription("Can't find server " + request.getServerId()) | ||
| .asRuntimeException()); | ||
| return; | ||
| } | ||
|
|
||
| GetServerSocketsResponse resp; | ||
| try { | ||
| resp = ChannelzProtoUtil.toGetServerSocketsResponse(serverSockets); | ||
| } catch (StatusRuntimeException e) { | ||
| responseObserver.onError(e); | ||
| return; | ||
| } | ||
|
|
||
| responseObserver.onNext(resp); | ||
| responseObserver.onCompleted(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.