This is an automated email from the ASF dual-hosted git repository.
MisterRaindrop pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudberry-pxf.git
The following commit(s) were added to refs/heads/main by this push:
new 33a19141 Observability: Add gp_session_id and gp_command_count to MDC
(#111)
33a19141 is described below
commit 33a191410a8e2dfa221f14aa2473f512f8bd7713
Author: Nikolay Antonov <[email protected]>
AuthorDate: Mon Jun 8 11:31:48 2026 +0300
Observability: Add gp_session_id and gp_command_count to MDC (#111)
* Observability: Add gp_session_id and gp_command_count to MDC
* review: add new parameters to log4j2
---
.../spring/PxfContextMdcLogEnhancerFilter.java | 21 +++++++++++--
.../pxf-service/src/templates/conf/pxf-log4j2.xml | 2 +-
.../spring/PxfContextMdcLogEnhancerFilterTest.java | 35 ++++++++++++++++++++++
3 files changed, 55 insertions(+), 3 deletions(-)
diff --git
a/server/pxf-service/src/main/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilter.java
b/server/pxf-service/src/main/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilter.java
index 04e2bb7a..a8d93050 100644
---
a/server/pxf-service/src/main/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilter.java
+++
b/server/pxf-service/src/main/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilter.java
@@ -21,8 +21,17 @@ import java.io.IOException;
@Component
public class PxfContextMdcLogEnhancerFilter extends OncePerRequestFilter {
+ // sessionId: composite PXF request identifier formed as
"<X-GP-XID>:<X-GP-OPTIONS-SERVER>",
+ // where XID is the Greenplum transaction id and the server name defaults
to "default".
+ // Groups all log records produced while serving a single PXF request.
private static final String MDC_SESSION_ID = "sessionId";
+ // segmentId: the Greenplum segment id (X-GP-SEGMENT-ID) that issued the
PXF request.
private static final String MDC_SEGMENT_ID = "segmentId";
+ // ssid: query session identifier from pg_stat_activity system view.
+ private static final String MDC_SSID = "ssid";
+ // ccnt: the command number within this session as shown by
gp_command_count.
+ // All records associated with the query will have the same ccnt.
+ private static final String MDC_CCNT = "ccnt";
private final HttpHeaderDecoder decoder;
@@ -60,10 +69,16 @@ public class PxfContextMdcLogEnhancerFilter extends
OncePerRequestFilter {
String serverName =
StringUtils.defaultIfBlank(decoder.getHeaderValue("X-GP-OPTIONS-SERVER",
request, encoded), "default");
String sessionId = String.format("%s:%s", xid, serverName);
String segmentId = decoder.getHeaderValue("X-GP-SEGMENT-ID", request,
encoded);
+ String gpSessionId = decoder.getHeaderValue("X-GP-SESSION-ID",
request, encoded);
+ String gpCommandCount = decoder.getHeaderValue("X-GP-COMMAND-COUNT",
request, encoded);
MDC.put(MDC_SESSION_ID, sessionId);
MDC.put(MDC_SEGMENT_ID, segmentId);
- log.debug("MDC: Added {}={}", MDC_SESSION_ID, sessionId);
- log.debug("MDC: Added {}={}", MDC_SEGMENT_ID, segmentId);
+ MDC.put(MDC_SSID, gpSessionId);
+ MDC.put(MDC_CCNT, gpCommandCount);
+ log.trace("MDC: Added {}={}", MDC_SESSION_ID, sessionId);
+ log.trace("MDC: Added {}={}", MDC_SEGMENT_ID, segmentId);
+ log.trace("MDC: Added {}={}", MDC_SSID, gpSessionId);
+ log.trace("MDC: Added {}={}", MDC_CCNT, gpCommandCount);
}
/**
@@ -73,5 +88,7 @@ public class PxfContextMdcLogEnhancerFilter extends
OncePerRequestFilter {
// removing possibly non-existent item is OK
MDC.remove(MDC_SEGMENT_ID);
MDC.remove(MDC_SESSION_ID);
+ MDC.remove(MDC_SSID);
+ MDC.remove(MDC_CCNT);
}
}
diff --git a/server/pxf-service/src/templates/conf/pxf-log4j2.xml
b/server/pxf-service/src/templates/conf/pxf-log4j2.xml
index d684cc2a..de6dc3e7 100644
--- a/server/pxf-service/src/templates/conf/pxf-log4j2.xml
+++ b/server/pxf-service/src/templates/conf/pxf-log4j2.xml
@@ -2,7 +2,7 @@
<Configuration status="WARN">
<Properties>
<Property name="LOG_EXCEPTION_CONVERSION_WORD">%xwEx</Property>
- <Property name="LOG_LEVEL_PATTERN">%5p
[%X{sessionId}:%-3X{segmentId}]</Property>
+ <Property name="LOG_LEVEL_PATTERN">%5p
[%X{sessionId}:%-3X{segmentId}][ssid=%X{ssid},ccnt=%X{ccnt}]</Property>
<Property name="LOG_DATEFORMAT_PATTERN">yyyy-MM-dd HH:mm:ss.SSS
zzz</Property>
<Property
name="CONSOLE_LOG_PATTERN">%clr{%d{${LOG_DATEFORMAT_PATTERN}}}{faint}
%clr{${LOG_LEVEL_PATTERN}} %clr{%pid}{magenta} %clr{---}{faint}
%clr{[%15.15t]}{faint} %clr{%-40.40c{1.}}{cyan} %clr{:}{faint}
%m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}</Property>
<Property name="FILE_LOG_PATTERN">%d{${LOG_DATEFORMAT_PATTERN}}
${LOG_LEVEL_PATTERN} %pid --- [%-9.10t] %-40.40c{1.} :
%m%n${sys:LOG_EXCEPTION_CONVERSION_WORD}</Property>
diff --git
a/server/pxf-service/src/test/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilterTest.java
b/server/pxf-service/src/test/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilterTest.java
index 5b97caef..18230611 100644
---
a/server/pxf-service/src/test/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilterTest.java
+++
b/server/pxf-service/src/test/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilterTest.java
@@ -42,6 +42,8 @@ class PxfContextMdcLogEnhancerFilterTest {
// always removes
verify(mdcMock).remove("segmentId");
verify(mdcMock).remove("sessionId");
+ verify(mdcMock).remove("ssid");
+ verify(mdcMock).remove("ccnt");
verifyNoMoreInteractions(mdcMock);
}
@@ -54,9 +56,13 @@ class PxfContextMdcLogEnhancerFilterTest {
verify(mdcMock).put("sessionId", "transaction:id:default");
verify(mdcMock).put("segmentId", "5");
+ verify(mdcMock).put("ssid", null);
+ verify(mdcMock).put("ccnt", null);
verify(mdcMock).remove("segmentId");
verify(mdcMock).remove("sessionId");
+ verify(mdcMock).remove("ssid");
+ verify(mdcMock).remove("ccnt");
verifyNoMoreInteractions(mdcMock);
}
@@ -70,9 +76,34 @@ class PxfContextMdcLogEnhancerFilterTest {
verify(mdcMock).put("sessionId", "transaction:id:s3");
verify(mdcMock).put("segmentId", "5");
+ verify(mdcMock).put("ssid", null);
+ verify(mdcMock).put("ccnt", null);
verify(mdcMock).remove("segmentId");
verify(mdcMock).remove("sessionId");
+ verify(mdcMock).remove("ssid");
+ verify(mdcMock).remove("ccnt");
+ verifyNoMoreInteractions(mdcMock);
+ }
+
+ @Test
+ void testPxfContextRequestWithGpSessionId() throws ServletException,
IOException {
+
+ mockRequest.addHeader("X-GP-XID", "transaction:id");
+ mockRequest.addHeader("X-GP-SEGMENT-ID", "5");
+ mockRequest.addHeader("X-GP-SESSION-ID", "12345");
+ mockRequest.addHeader("X-GP-COMMAND-COUNT", "7");
+ filter.doFilter(mockRequest, mockResponse, mockFilterChain);
+
+ verify(mdcMock).put("sessionId", "transaction:id:default");
+ verify(mdcMock).put("segmentId", "5");
+ verify(mdcMock).put("ssid", "12345");
+ verify(mdcMock).put("ccnt", "7");
+
+ verify(mdcMock).remove("segmentId");
+ verify(mdcMock).remove("sessionId");
+ verify(mdcMock).remove("ssid");
+ verify(mdcMock).remove("ccnt");
verifyNoMoreInteractions(mdcMock);
}
@@ -86,9 +117,13 @@ class PxfContextMdcLogEnhancerFilterTest {
verify(mdcMock).put("sessionId", "transaction:id:default");
verify(mdcMock).put("segmentId", "5");
+ verify(mdcMock).put("ssid", null);
+ verify(mdcMock).put("ccnt", null);
verify(mdcMock).remove("segmentId");
verify(mdcMock).remove("sessionId");
+ verify(mdcMock).remove("ssid");
+ verify(mdcMock).remove("ccnt");
verifyNoMoreInteractions(mdcMock);
}
}
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
