fix the memory leak in skywalking trace reporter (#29140)

Signed-off-by: johnlanni <[email protected]>
envoyproxy · Aug 19, 2023 · 822ef56 · 822ef56
1 parent 76ade2a
commit 822ef56
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/source/extensions/tracers/skywalking/trace_segment_reporter.cc b/source/extensions/tracers/skywalking/trace_segment_reporter.cc
@@ -48,6 +48,11 @@ void TraceSegmentReporter::report(TracingContextPtr tracing_context) {
   ENVOY_LOG(trace, "Try to report segment to SkyWalking Server:\n{}", request.DebugString());
 
   if (stream_ != nullptr) {
+    if (stream_->isAboveWriteBufferHighWatermark()) {
+      ENVOY_LOG(debug, "Failed to report segment to SkyWalking Server since buffer is over limit");
+      tracing_stats_->segments_dropped_.inc();
+      return;
+    }
     tracing_stats_->segments_sent_.inc();
     stream_->sendMessage(request, false);
     return;

diff --git a/test/extensions/tracers/skywalking/trace_segment_reporter_test.cc b/test/extensions/tracers/skywalking/trace_segment_reporter_test.cc
@@ -236,6 +236,23 @@ TEST_F(TraceSegmentReporterTest, CallAsyncCallbackAndNothingTodo) {
   reporter_->onReceiveMessage(std::make_unique<skywalking::v3::Commands>());
 }
 
+TEST_F(TraceSegmentReporterTest, NoReportWithHighWatermark) {
+  setupTraceSegmentReporter("{}");
+
+  TracingContextPtr segment_context =
+      SkyWalkingTestHelper::createSegmentContext(true, "NEW", "PRE");
+  SkyWalkingTestHelper::createSpanStore(segment_context, nullptr, "CHILD");
+
+  EXPECT_CALL(*mock_stream_ptr_, isAboveWriteBufferHighWatermark()).WillOnce(Return(true));
+  EXPECT_CALL(*mock_stream_ptr_, sendMessageRaw_(_, _)).Times(0);
+  reporter_->report(segment_context);
+
+  EXPECT_EQ(0U, mock_scope_.counter("tracing.skywalking.segments_sent").value());
+  EXPECT_EQ(1U, mock_scope_.counter("tracing.skywalking.segments_dropped").value());
+  EXPECT_EQ(0U, mock_scope_.counter("tracing.skywalking.cache_flushed").value());
+  EXPECT_EQ(0U, mock_scope_.counter("tracing.skywalking.segments_flushed").value());
+}
+
 } // namespace
 } // namespace SkyWalking
 } // namespace Tracers