1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
// Copyright 2018 The Bazel 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 com.google.devtools.build.lib.remote.logging;
import com.google.bytestream.ByteStreamGrpc;
import com.google.devtools.build.lib.remote.logging.RemoteExecutionLog.LogEntry;
import com.google.devtools.build.lib.remote.util.TracingMetadataUtils;
import com.google.devtools.build.lib.util.io.AsynchronousFileOutputStream;
import com.google.devtools.remoteexecution.v1test.ActionCacheGrpc;
import com.google.devtools.remoteexecution.v1test.ContentAddressableStorageGrpc;
import com.google.devtools.remoteexecution.v1test.ExecutionGrpc;
import com.google.devtools.remoteexecution.v1test.RequestMetadata;
import com.google.watcher.v1.WatcherGrpc;
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.ForwardingClientCall;
import io.grpc.ForwardingClientCallListener;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.Status;
import javax.annotation.Nullable;
/** Client interceptor for logging details of certain gRPC calls. */
public class LoggingInterceptor implements ClientInterceptor {
AsynchronousFileOutputStream rpcLogFile;
/** Constructs a LoggingInterceptor which logs RPC calls to the given file. */
public LoggingInterceptor(AsynchronousFileOutputStream rpcLogFile) {
this.rpcLogFile = rpcLogFile;
}
/**
* Returns a {@link LoggingHandler} to handle logging details for the specified method. If there
* is no handler for the given method, returns {@code null}.
*
* @param method Method to return handler for.
*/
@SuppressWarnings("rawtypes")
protected <ReqT, RespT> @Nullable LoggingHandler selectHandler(
MethodDescriptor<ReqT, RespT> method) {
if (method == ExecutionGrpc.getExecuteMethod()) {
return new ExecuteHandler();
} else if (method == WatcherGrpc.getWatchMethod()) {
return new WatchHandler();
} else if (method == ActionCacheGrpc.getGetActionResultMethod()) {
return new GetActionResultHandler();
} else if (method == ContentAddressableStorageGrpc.getFindMissingBlobsMethod()) {
return new FindMissingBlobsHandler();
} else if (method == ByteStreamGrpc.getReadMethod()) {
return new ReadHandler();
} else if (method == ByteStreamGrpc.getWriteMethod()) {
return new WriteHandler();
}
return null;
}
@Override
public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
MethodDescriptor<ReqT, RespT> method, CallOptions callOptions, Channel next) {
ClientCall<ReqT, RespT> call = next.newCall(method, callOptions);
LoggingHandler<ReqT, RespT> handler = selectHandler(method);
if (handler != null) {
return new LoggingForwardingCall<>(call, handler, method);
} else {
return call;
}
}
/**
* Wraps client call to log call details by building a {@link LogEntry} and writing it to the RPC
* log file.
*/
private class LoggingForwardingCall<ReqT, RespT>
extends ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT> {
private final LoggingHandler<ReqT, RespT> handler;
private final LogEntry.Builder entryBuilder;
protected LoggingForwardingCall(
ClientCall<ReqT, RespT> delegate,
LoggingHandler<ReqT, RespT> handler,
MethodDescriptor<ReqT, RespT> method) {
super(delegate);
this.handler = handler;
this.entryBuilder = LogEntry.newBuilder().setMethodName(method.getFullMethodName());
}
@Override
public void start(Listener<RespT> responseListener, Metadata headers) {
RequestMetadata metadata = TracingMetadataUtils.requestMetadataFromHeaders(headers);
if (metadata != null) {
entryBuilder.setMetadata(metadata);
}
super.start(
new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(
responseListener) {
@Override
public void onMessage(RespT message) {
handler.handleResp(message);
super.onMessage(message);
}
@Override
public void onClose(Status status, Metadata trailers) {
entryBuilder.setStatus(makeStatusProto(status));
entryBuilder.setDetails(handler.getDetails());
rpcLogFile.write(entryBuilder.build());
super.onClose(status, trailers);
}
},
headers);
}
@Override
public void sendMessage(ReqT message) {
handler.handleReq(message);
super.sendMessage(message);
}
}
/** Converts io.grpc.Status to com.google.rpc.Status proto for logging. */
private static com.google.rpc.Status makeStatusProto(Status status) {
String message = "";
if (status.getCause() != null) {
message = status.getCause().toString();
} else if (status.getDescription() != null) {
message = status.getDescription();
}
return com.google.rpc.Status.newBuilder()
.setCode(status.getCode().value())
.setMessage(message)
.build();
}
}
|
