kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Optimize gRPC Log reporter to set service name for the first element (#206)

This commit is contained in:
吴晟 Wu Sheng 2022-06-15 23:17:14 +08:00 committed by GitHub
parent 88a7778637
commit b83865f6cd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 54 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGES.md
View File

@ -24,6 +24,7 @@ Release Notes.
* Add type name checking in ArgumentTypeNameMatch and ReturnTypeNameMatch
* Highlight ArgumentTypeNameMatch and ReturnTypeNameMatch type naming rule in docs/en/setup/service-agent/java-agent/Java-Plugin-Development-Guide.md
* Fix FileWriter scheduled task NPE
* Optimize gRPC Log reporter to set service name for the first element in the streaming.(No change for Kafka reporter)
#### Documentation

61
apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/remote/LogReportServiceClient.java
View File

@ -21,7 +21,6 @@ package org.apache.skywalking.apm.agent.core.remote;
import io.grpc.Channel;
import io.grpc.stub.StreamObserver;
import java.util.List;
import java.util.Objects;
import java.util.Properties;
import java.util.concurrent.TimeUnit;
@ -42,10 +41,10 @@ import org.apache.skywalking.apm.network.logging.v3.LogData;
import org.apache.skywalking.apm.network.logging.v3.LogReportServiceGrpc;
@DefaultImplementor
public class LogReportServiceClient implements BootService, GRPCChannelListener, IConsumer<LogData> {
public class LogReportServiceClient implements BootService, GRPCChannelListener, IConsumer<LogData.Builder> {
private static final ILog LOGGER = LogManager.getLogger(LogReportServiceClient.class);
private volatile DataCarrier<LogData> carrier;
private volatile DataCarrier<LogData.Builder> carrier;
private volatile GRPCChannelStatus status;
private volatile LogReportServiceGrpc.LogReportServiceStub logReportServiceStub;
@ -70,7 +69,7 @@ public class LogReportServiceClient implements BootService, GRPCChannelListener,
}
public void produce(LogData logData) {
public void produce(LogData.Builder logData) {
if (Objects.nonNull(logData) && !carrier.produce(logData)) {
if (LOGGER.isDebugEnable()) {
LOGGER.debug("One log has been abandoned, cause by buffer is full.");
@ -84,7 +83,7 @@ public class LogReportServiceClient implements BootService, GRPCChannelListener,
}
@Override
public void consume(final List<LogData> dataList) {
public void consume(final List<LogData.Builder> dataList) {
if (CollectionUtil.isEmpty(dataList)) {
return;
}
@ -95,31 +94,39 @@ public class LogReportServiceClient implements BootService, GRPCChannelListener,
StreamObserver<LogData> logDataStreamObserver = logReportServiceStub
.withDeadlineAfter(Collector.GRPC_UPSTREAM_TIMEOUT, TimeUnit.SECONDS)
.collect(
new StreamObserver<Commands>() {
@Override
public void onNext(final Commands commands) {
new StreamObserver<Commands>() {
@Override
public void onNext(final Commands commands) {
}
}
@Override
public void onError(final Throwable throwable) {
status.finished();
LOGGER.error(throwable, "Try to send {} log data to collector, with unexpected exception.",
dataList.size()
);
ServiceManager.INSTANCE
.findService(GRPCChannelManager.class)
.reportError(throwable);
}
@Override
public void onError(final Throwable throwable) {
status.finished();
LOGGER.error(throwable, "Try to send {} log data to collector, with unexpected exception.",
dataList.size()
);
ServiceManager.INSTANCE
.findService(GRPCChannelManager.class)
.reportError(throwable);
}
@Override
public void onCompleted() {
status.finished();
}
});
@Override
public void onCompleted() {
status.finished();
}
});
for (final LogData logData : dataList) {
logDataStreamObserver.onNext(logData);
boolean isFirst = true;
for (final LogData.Builder logData : dataList) {
if (isFirst) {
// Only set service name of the first element in one stream
// https://github.com/apache/skywalking-data-collect-protocol/blob/master/logging/Logging.proto
// Log collecting protocol defines LogData#service is required in the first element only.
logData.setService(Config.Agent.SERVICE_NAME);
isFirst = false;
}
logDataStreamObserver.onNext(logData.build());
}
logDataStreamObserver.onCompleted();
status.wait4Finish();
@ -127,7 +134,7 @@ public class LogReportServiceClient implements BootService, GRPCChannelListener,
}
@Override
public void onError(final List<LogData> data, final Throwable t) {
public void onError(final List<LogData.Builder> data, final Throwable t) {
LOGGER.error(t, "Try to consume {} log data to sender, with unexpected exception.", data.size());
}

9
apm-sniffer/apm-toolkit-activation/apm-toolkit-log4j-1.x-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/log/log4j/v1/x/log/GRPCLogAppenderInterceptor.java
View File

@ -74,12 +74,11 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
*
* @param appender the real {@link AppenderSkeleton appender}
* @param event {@link LoggingEvent}
* @return {@link LogData} with filtered trace context in order to reduce the cost on the network
* @return {@link LogData.Builder} with filtered trace context in order to reduce the cost on the network
*/
private LogData transform(final AppenderSkeleton appender, LoggingEvent event) {
private LogData.Builder transform(final AppenderSkeleton appender, LoggingEvent event) {
LogData.Builder builder = LogData.newBuilder()
.setTimestamp(event.getTimeStamp())
.setService(Config.Agent.SERVICE_NAME)
.setServiceInstance(Config.Agent.INSTANCE_NAME)
.setTraceContext(TraceContext.newBuilder()
.setTraceId(ContextManager.getGlobalTraceId())
@ -102,12 +101,12 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
builder.setEndpoint(primaryEndpointName);
}
return -1 == ContextManager.getSpanId() ? builder.build()
return -1 == ContextManager.getSpanId() ? builder
: builder.setTraceContext(TraceContext.newBuilder()
.setTraceId(ContextManager.getGlobalTraceId())
.setSpanId(ContextManager.getSpanId())
.setTraceSegmentId(ContextManager.getSegmentId())
.build()).build();
.build());
}
private String transformLogText(final AppenderSkeleton appender, final LoggingEvent event) {

8
apm-sniffer/apm-toolkit-activation/apm-toolkit-log4j-2.x-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/log/log4j/v2/x/log/GRPCLogAppenderInterceptor.java
View File

@ -80,7 +80,7 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
* @param event {@link LogEvent}
* @return {@link LogData} with filtered trace context in order to reduce the cost on the network
*/
private LogData transform(final AbstractAppender appender, LogEvent event) {
private LogData.Builder transform(final AbstractAppender appender, LogEvent event) {
LogTags.Builder logTags = LogTags.newBuilder()
.addData(KeyStringValuePair.newBuilder()
.setKey("level").setValue(event.getLevel().toString()).build())
@ -123,14 +123,14 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
.setTraceId(context.getTraceId())
.setSpanId(context.getSpanId())
.setTraceSegmentId(context.getTraceSegmentId())
.build()).build();
.build());
} else {
return -1 == ContextManager.getSpanId() ? builder.build()
return -1 == ContextManager.getSpanId() ? builder
: builder.setTraceContext(TraceContext.newBuilder()
.setTraceId(ContextManager.getGlobalTraceId())
.setSpanId(ContextManager.getSpanId())
.setTraceSegmentId(ContextManager.getSegmentId())
.build()).build();
.build());
}
}

6
apm-sniffer/apm-toolkit-activation/apm-toolkit-logback-1.x-activation/src/main/java/org/apache/skywalking/apm/toolkit/activation/log/logback/v1/x/log/GRPCLogAppenderInterceptor.java
View File

@ -80,7 +80,7 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
* @param event {@link ILoggingEvent}
* @return {@link LogData} with filtered trace context in order to reduce the cost on the network
*/
private LogData transform(final OutputStreamAppender<ILoggingEvent> appender, ILoggingEvent event) {
private LogData.Builder transform(final OutputStreamAppender<ILoggingEvent> appender, ILoggingEvent event) {
LogTags.Builder logTags = LogTags.newBuilder()
.addData(KeyStringValuePair.newBuilder()
.setKey("level").setValue(event.getLevel().toString()).build())
@ -118,12 +118,12 @@ public class GRPCLogAppenderInterceptor implements InstanceMethodsAroundIntercep
builder.setEndpoint(primaryEndpointName);
}
return -1 == ContextManager.getSpanId() ? builder.build()
return -1 == ContextManager.getSpanId() ? builder
: builder.setTraceContext(TraceContext.newBuilder()
.setTraceId(ContextManager.getGlobalTraceId())
.setSpanId(ContextManager.getSpanId())
.setTraceSegmentId(ContextManager.getSegmentId())
.build()).build();
.build());
}
private String transformLogText(final OutputStreamAppender<ILoggingEvent> appender, final ILoggingEvent event) {

12
apm-sniffer/optional-reporter-plugins/kafka-reporter-plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaLogReporterServiceClient.java
View File

@ -23,6 +23,7 @@ import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.utils.Bytes;
import org.apache.skywalking.apm.agent.core.boot.OverrideImplementor;
import org.apache.skywalking.apm.agent.core.boot.ServiceManager;
import org.apache.skywalking.apm.agent.core.conf.Config;
import org.apache.skywalking.apm.agent.core.remote.LogReportServiceClient;
import org.apache.skywalking.apm.agent.core.util.CollectionUtil;
import org.apache.skywalking.apm.network.logging.v3.LogData;
@ -41,18 +42,21 @@ public class KafkaLogReporterServiceClient extends LogReportServiceClient implem
}
@Override
public void produce(final LogData logData) {
public void produce(final LogData.Builder logData) {
super.produce(logData);
}
@Override
public void consume(final List<LogData> dataList) {
public void consume(final List<LogData.Builder> dataList) {
if (producer == null || CollectionUtil.isEmpty(dataList)) {
return;
}
for (LogData data : dataList) {
producer.send(new ProducerRecord<>(topic, data.getService(), Bytes.wrap(data.toByteArray())));
for (LogData.Builder data : dataList) {
// Kafka Log reporter sends one log per time.
// Every time, service name should be set to keep data integrity.
data.setService(Config.Agent.SERVICE_NAME);
producer.send(new ProducerRecord<>(topic, data.getService(), Bytes.wrap(data.build().toByteArray())));
}
}