Skip to content

Commit ea43962

Browse files
feat: optimize debug log (#111)
* feat: optimize debug log * feat: add test case
1 parent c34c74f commit ea43962

42 files changed

Lines changed: 2222 additions & 83 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/codecov.yml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,20 @@ comment:
55

66
coverage: # https://docs.codecov.com/docs/codecovyml-reference#coverage
77
precision: 5
8-
range:
9-
- 70.0
10-
- 75.0
8+
range: "80...100"
119
status:
1210
project:
1311
default:
1412
branches:
1513
- ^master$
16-
target: 70.0 # the minimum coverage ratio that the commit must meet to be considered a success.
17-
threshold: 1% # allow the coverage to drop by X%, and posting a success status.
14+
target: 80.0
15+
threshold: 1%
16+
ignore:
17+
- "**/test/**"
18+
- "**/*Test.java"
19+
- "**/*AuthCenter.java"
20+
- "**/*QappPackage.java"
21+
- "**/*TRPCProtocol.java"
22+
parsers:
23+
jacoco:
24+
partials_as_hits: true

trpc-container/trpc-container-default/src/main/java/com/tencent/trpc/container/config/system/Environment.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,6 @@ public Map<String, Object> parseMap(String configPath) {
9393
this.localConfigMap = this.applicationConfigParser.parseMap(configPath);
9494
this.overrideConfig();
9595
if (override) {
96-
logger.debug("use part of system config instead of local yaml config.");
9796
return this.propertySourceParser.parseFlattableMap(this.localFlattableConfigMap);
9897
}
9998
return this.localConfigMap;

trpc-core/src/main/java/com/tencent/trpc/core/cluster/RpcClusterClientManager.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,10 @@ public static void shutdownBackendConfig(BackendConfig backendConfig) {
7171
.ifPresent(proxyMap -> proxyMap.forEach((k, v) -> {
7272
try {
7373
v.close();
74-
logger.debug("Shutdown client:{} backendConfig:{} success", k, backendConfig.toSimpleString());
74+
if (logger.isDebugEnabled()) {
75+
logger.debug("Shutdown client:{} backendConfig:{} success", k,
76+
backendConfig.toSimpleString());
77+
}
7578
} catch (Exception ex) {
7679
logger.error("Shutdown client:{} backendConfig:{},exception", k, backendConfig.toSimpleString(),
7780
ex);
@@ -107,8 +110,10 @@ private static ScheduledFuture<?> startRpcClientCleaner() {
107110
public static void scanUnusedClient() {
108111
Map<BackendConfig, List<RpcClient>> unusedClientMap = Maps.newHashMap();
109112
CLUSTER_MAP.forEach((bConfig, clusterMap) -> {
110-
logger.debug("RpcClusterClient scheduler report clusterName={}, naming={}, num of client is {}",
111-
bConfig.getName(), bConfig.getNamingOptions().getServiceNaming(), clusterMap.keySet().size());
113+
if (logger.isDebugEnabled()) {
114+
logger.debug("RpcClusterClient scheduler report clusterName={}, naming={}, num of client is {}",
115+
bConfig.getName(), bConfig.getNamingOptions().getServiceNaming(), clusterMap.keySet().size());
116+
}
112117
clusterMap.forEach((clientKey, clientValue) -> {
113118
try {
114119
if (isIdleTimeout(bConfig, clientValue)) {

trpc-core/src/main/java/com/tencent/trpc/core/cluster/def/DefClusterInvoker.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,6 @@ private void fillCallInfo(Request request, ServiceInstance serviceInstance) {
210210
Constants.CONTAINER_NAME));
211211
request.getMeta().getCallInfo().setCalleeSetName(serviceInstance.getParameter(
212212
Constants.SET_DIVISION));
213-
logger.debug("[invoke] container:{},set:{}", serviceInstance.getParameter(
214-
Constants.CONTAINER_NAME), serviceInstance.getParameter(Constants.SET_DIVISION));
215213
}
216214
}
217215

trpc-core/src/main/java/com/tencent/trpc/core/common/LifecycleBase.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,9 @@ private synchronized void setStateInternal(LifecycleState state) {
306306
}
307307

308308
private synchronized void setStateInternal(LifecycleState state, Throwable ex) {
309-
logger.debug(">>>Lifecycle state transfer,{obj={}, state({} -> {})}", this, getState(), state);
309+
if (logger.isDebugEnabled()) {
310+
logger.debug(">>>Lifecycle state transfer,{obj={}, state({} -> {})}", this, getState(), state);
311+
}
310312
this.state = state;
311313
fireLifecycleEvent(state, ex);
312314
}

trpc-core/src/main/java/com/tencent/trpc/core/common/config/BackendConfig.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,9 @@ public synchronized void init() {
334334
validateInterceptor();
335335
namingServiceId = toNamingServiceId();
336336
simpleString = "BackendConfig[name=" + name + ", naming=" + namingOptions.getServiceNaming() + "]";
337-
logger.debug("ConsumerConfig initialized:{}", toString());
337+
if (logger.isDebugEnabled()) {
338+
logger.debug("ConsumerConfig initialized:{}", toString());
339+
}
338340
SelectorManager.getManager().validate(namingOptions.getSelectorId());
339341
initRpcClusterClient();
340342
inited = true;

trpc-core/src/main/java/com/tencent/trpc/core/extension/ExtensionClass.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,10 @@ private T createInstance() {
9090
T t = clazz.newInstance();
9191
injectExtension(t, pluginConfig);
9292
initExtension(t);
93-
logger.debug("Create plugin instance (name={}, type={}), config={}) success", name,
94-
extensionType, ExtensionLoader.getPluginConfigMap(extensionType));
93+
if (logger.isDebugEnabled()) {
94+
logger.debug("Create plugin instance (name={}, type={}), config={}) success", name,
95+
extensionType, ExtensionLoader.getPluginConfigMap(extensionType));
96+
}
9597
return t;
9698
} catch (Exception e) {
9799
throw new TRpcExtensionException(

trpc-core/src/main/java/com/tencent/trpc/core/filter/ProviderFilterInvoker.java

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* Tencent is pleased to support the open source community by making tRPC available.
33
*
4-
* Copyright (C) 2023 Tencent.
4+
* Copyright (C) 2023 Tencent.
55
* All rights reserved.
66
*
77
* If you have downloaded a copy of the tRPC source code from Tencent,
@@ -49,7 +49,6 @@ private static <T> ProviderInvoker<T> buildProviderChain(boolean disableDefaultF
4949
: Stream.of(new ProviderInvokerHeadFilter(), new ProviderInvokerTailFilter());
5050
List<Filter> filters = Stream.concat(filterNames.stream().map(FilterManager::get), defaultFilters)
5151
.sorted(Comparator.comparing(Filter::getOrder)).collect(Collectors.toList());
52-
logger.debug("===Build invoke provider filter size: {}", filters.size());
5352

5453
for (int i = filters.size() - 1; i >= 0; i--) {
5554
final Filter filter = filters.get(i);
@@ -68,12 +67,17 @@ public Class<T> getInterface() {
6867
@Override
6968
public CompletionStage<Response> invoke(Request request) {
7069
RpcInvocation inv = request.getInvocation();
71-
logger.debug(">>>Before Invoke provider filter(service={}, rpcServiceName={}, rpcMehthodName={})",
72-
filter.getClass(), inv.getRpcServiceName(), inv.getRpcMethodName());
70+
if (logger.isDebugEnabled()) {
71+
logger.debug(">>>Before Invoke provider filter(service={}, rpcServiceName={}, "
72+
+ "rpcMehthodName={})",
73+
filter.getClass(), inv.getRpcServiceName(), inv.getRpcMethodName());
74+
}
7375

7476
CompletionStage<Response> f = filter.filter(before, request);
75-
logger.debug("<<<After Invoke provider filter(service={}, rpcServiceName={},rpcMehthodName={})",
76-
filter.getClass(), inv.getRpcServiceName(), inv.getRpcMethodName());
77+
if (logger.isDebugEnabled()) {
78+
logger.debug("<<<After Invoke provider filter(service={}, rpcServiceName={},rpcMehthodName={})",
79+
filter.getClass(), inv.getRpcServiceName(), inv.getRpcMethodName());
80+
}
7781

7882
PreconditionUtils.checkArgument(f != null,
7983
"Invoke provider filter(service=%s, rpcServiceName=%s,rpcMehthodName=%s) return Null",

trpc-core/src/main/java/com/tencent/trpc/core/trace/TracerClientFilter.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ public CompletionStage<Response> filter(Invoker<?> invoker, Request request)
4242
Span span = null;
4343
try {
4444
span = buildSpan(invoker, request, context, meta, tracer, parentSpan);
45-
logger.debug("before tjg TraceClientFilter reporting, span: {}", span);
45+
if (logger.isDebugEnabled()) {
46+
logger.debug("before tjg TraceClientFilter reporting, span: {}", span);
47+
}
4648
} catch (Exception e) {
4749
logger.error("create trace client span error: ", e);
4850
}
@@ -59,7 +61,9 @@ public CompletionStage<Response> filter(Invoker<?> invoker, Request request)
5961
updateUpstreamSpanFlag(parentSpan, tempSpan);
6062
finish(tempSpan, request, r, t);
6163
}
62-
logger.debug("after tjg TraceClientFilter reporting, span: {}", tempSpan);
64+
if (logger.isDebugEnabled()) {
65+
logger.debug("after tjg TraceClientFilter reporting, span: {}", tempSpan);
66+
}
6367
} catch (Exception e) {
6468
logger.error("finish span error: ", e);
6569
}

trpc-core/src/main/java/com/tencent/trpc/core/trace/TracerFilter.java

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,9 @@ public abstract Span start(SpanBuilder spanBuilder, RpcContext context, Invoker<
9191
*/
9292
public Tracer getTracer(RpcContext context, RequestMeta meta) throws TRpcException {
9393
try {
94-
logger.debug("c context:{},meta:{}", context, meta);
94+
if (logger.isDebugEnabled()) {
95+
logger.debug("c context:{},meta:{}", context, meta);
96+
}
9597
Tracer tracer = RpcContextUtils.getTracer(context);
9698
if (tracer != null) {
9799
return tracer;
@@ -114,7 +116,9 @@ public Tracer getTracer(RpcContext context, RequestMeta meta) throws TRpcExcepti
114116
logger.error("tracer is null,this self server name is null");
115117
}
116118
}
117-
logger.debug("getTracer tracer:{}}", tracer);
119+
if (logger.isDebugEnabled()) {
120+
logger.debug("getTracer tracer:{}}", tracer);
121+
}
118122
return tracer;
119123
} catch (Exception e) {
120124
logger.error("getTracer error", e);
@@ -133,8 +137,10 @@ public Tracer getTracer(RpcContext context, RequestMeta meta) throws TRpcExcepti
133137
public SpanBuilder createSpanBuilder(Tracer tracer, SpanContext parentSpanContext,
134138
RequestMeta meta) {
135139
try {
136-
logger.debug("createSpanBuilder tracer:{},parentSpanContext:{},meta:{}", tracer,
137-
parentSpanContext, meta);
140+
if (logger.isDebugEnabled()) {
141+
logger.debug("createSpanBuilder tracer:{},parentSpanContext:{},meta:{}", tracer,
142+
parentSpanContext, meta);
143+
}
138144
if (tracer == null) {
139145
return null;
140146
}
@@ -164,7 +170,9 @@ public SpanBuilder createSpanBuilder(Tracer tracer, SpanContext parentSpanContex
164170
*/
165171
public void updateSpanErrorFlag(Response response, Throwable throwable, Span span) {
166172
try {
167-
logger.debug("updateSpanErrorFlag response:{},throwable:{},span:{}", response, throwable, span);
173+
if (logger.isDebugEnabled()) {
174+
logger.debug("updateSpanErrorFlag response:{},throwable:{},span:{}", response, throwable, span);
175+
}
168176
if (span == null) {
169177
return;
170178
}

0 commit comments

Comments
 (0)