Skip to content

Add controller execution time tracking to query responses #17709

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

Closed
Akanksha-kedia wants to merge 1 commit into from
Closed

Add controller execution time tracking to query responses #17709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
41 changes: 37 additions & 4 deletions ...ontroller/src/main/java/org/apache/pinot/controller/api/resources/PinotQueryResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public StreamingOutput handleGetSql(@QueryParam("sql") String sqlQuery, @QueryPa
public StreamingOutput handleTimeSeriesQueryRange(@QueryParam("language") String language,
@QueryParam("query") String query, @QueryParam("start") String start, @QueryParam("end") String end,
@QueryParam("step") String step, @Context HttpHeaders httpHeaders) {
return executeTimeSeriesQueryCatching(httpHeaders, language, query, start, end, step);
return executeTimeSeriesQueryCatching(httpHeaders, language, query, start, end, step, Map.of(), null, false);
}

@POST
Expand Down Expand Up @@ -680,11 +680,44 @@ public StreamingOutput sendRequestRaw(String url, String method, String query, O
Map<String, String> headers) {
return outputStream -> {
final long startTime = System.currentTimeMillis();
sendRequestRaw(url, method, requestJson.toString(), headers, outputStream);

/* START GENAI@CLINE */
// Use a temporary buffer to capture the broker response
java.io.ByteArrayOutputStream tempBuffer = new java.io.ByteArrayOutputStream();
sendRequestRaw(url, method, requestJson.toString(), headers, tempBuffer);
final long queryTime = System.currentTimeMillis() - startTime;
LOGGER.info("Query: {} Time: {}ms", query, queryTime);

// Parse the broker response, add controller execution time as an additional field, and write to output
try {
String brokerResponseStr = tempBuffer.toString(StandardCharsets.UTF_8.name());
ObjectNode brokerResponseJson = (ObjectNode) JsonUtils.stringToJsonNode(brokerResponseStr);
// Add controller execution time as an additional field in the response
brokerResponseJson.put("controllerExecutionTimeMs", queryTime);
JsonUtils.objectToOutputStream(brokerResponseJson, outputStream);
} catch (Exception e) {
// If parsing fails, just write the original response
LOGGER.warn("Failed to add controller execution time to broker response", e);
outputStream.write(tempBuffer.toByteArray());
}
/* END GENAI@CLINE */
};
}

/* START GENAI@CLINE */
public StreamingOutput sendTimeSeriesRequestRaw(String url, String method, String query, ObjectNode requestJson,
Map<String, String> headers) {
return outputStream -> {
final long startTime = System.currentTimeMillis();

// For timeseries requests, just forward the raw response without modification
// since timeseries responses have a different structure (PinotBrokerTimeSeriesResponse)
sendRequestRaw(url, method, requestJson.toString(), headers, outputStream);
final long queryTime = System.currentTimeMillis() - startTime;
LOGGER.info("TimeSeries Query: {} Time: {}ms", query, queryTime);
};
}
/* END GENAI@CLINE */

private static StreamingOutput constructQueryExceptionResponse(QueryErrorCode errorCode, String message) {
return outputStream -> {
Expand Down Expand Up @@ -769,11 +802,11 @@ private StreamingOutput sendTimeSeriesRequestToBroker(String language, String qu
queryOptions.forEach(queryOptionsNode::put);
requestJson.set("queryOptions", queryOptionsNode);
}
return sendRequestRaw(url, "POST", query, requestJson, headers);
return sendTimeSeriesRequestRaw(url, "POST", query, requestJson, headers);
} else {
// Use GET /timeseries/api/v1/query_range endpoint (Prometheus compatible API)
String url = getTimeSeriesQueryURL(protocol, hostName, port, language, query, start, end, step);
return sendRequestRaw(url, "GET", query, JsonUtils.newObjectNode(), headers);
return sendTimeSeriesRequestRaw(url, "GET", query, JsonUtils.newObjectNode(), headers);
}
}

Expand Down
6 changes: 5 additions & 1 deletion ...ion-tests/src/test/java/org/apache/pinot/integration/tests/TimeSeriesIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,11 @@ public void testControllerTimeseriesEndpoints()
);
JsonNode result = getTimeseriesQuery(getControllerBaseApiUrl(), query, QUERY_START_TIME_SEC, QUERY_END_TIME_SEC,
getHeaders());
assertEquals(result.get("status").asText(), "success");

// Add null check for status field
JsonNode statusNode = result.get("status");
assertNotNull(statusNode, "Status field should not be null in timeseries query response");
assertEquals(statusNode.asText(), "success");

// Call /timeseries/languages.
var statusCodeAndResponse = sendGetRequestWithStatusCode(
Expand Down
Loading