Skip to content

Observability: Add gp_session_id and gp_command_count to MDC #111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MisterRaindrop merged 2 commits into from
Jun 8, 2026
Merged

Observability: Add gp_session_id and gp_command_count to MDC #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4ee386
Observability: Add gp_session_id and gp_command_count to MDC
ostinru May 31, 2026
b2708ce
review: add new parameters to log4j2
ostinru Jun 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions ...rc/main/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,17 @@
@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";
Comment thread
MisterRaindrop marked this conversation as resolved.
// 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;

Expand Down Expand Up @@ -60,10 +69,16 @@ private void insertIntoMDC(HttpServletRequest request) {
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);
}

/**
Expand All @@ -73,5 +88,7 @@ private void clearMDC() {
// 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);
}
}
2 changes: 1 addition & 1 deletion server/pxf-service/src/templates/conf/pxf-log4j2.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
35 changes: 35 additions & 0 deletions ...est/java/org/apache/cloudberry/pxf/service/spring/PxfContextMdcLogEnhancerFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ void testNonPxfContextRequest() throws ServletException, IOException {
// always removes
verify(mdcMock).remove("segmentId");
verify(mdcMock).remove("sessionId");
verify(mdcMock).remove("ssid");
verify(mdcMock).remove("ccnt");
verifyNoMoreInteractions(mdcMock);
}

Expand All @@ -54,9 +56,13 @@ void testPxfContextRequest() throws ServletException, IOException {

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);
}

Expand All @@ -70,9 +76,34 @@ void testPxfContextRequestWithServerName() throws ServletException, IOException

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);
}

Expand All @@ -86,9 +117,13 @@ void testPxfContextEncodedRequest() throws ServletException, IOException {

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);
}
}
Loading