Skip to content

xuy-UID2-4341-change-log-level Refine response logging #1183

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
clarkxuyang merged 3 commits into from
Dec 5, 2024
Merged

xuy-UID2-4341-change-log-level Refine response logging #1183

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a51139e
Refine response logging
clarkxuyang Dec 3, 2024
ace1676
update
clarkxuyang Dec 4, 2024
5585b9b
update
clarkxuyang Dec 5, 2024
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
2 changes: 1 addition & 1 deletion src/main/java/com/uid2/operator/service/JsonParseUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public static JsonArray parseArray(JsonObject object, String key, RoutingContext
try {
outArray = object.getJsonArray(key);
} catch (ClassCastException e) {
ResponseUtil.ClientError(rc, String.format("%s must be an array", key));
ResponseUtil.LogInfoAndSend400Response(rc, String.format("%s must be an array", key));
return null;
}
return outArray;
Expand Down
91 changes: 43 additions & 48 deletions src/main/java/com/uid2/operator/service/ResponseUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package com.uid2.operator.service;

import com.uid2.operator.monitoring.TokenResponseStatsCollector;
import com.uid2.operator.vertx.UIDOperatorVerticle;
import com.uid2.shared.model.TokenVersion;
import com.uid2.shared.store.ISiteStore;
import io.vertx.core.http.HttpHeaders;
Expand Down Expand Up @@ -64,19 +63,28 @@ public static void SuccessV2(RoutingContext rc, Object body) {
rc.data().put("response", json);
}

public static void ClientError(RoutingContext rc, String message) {
Warning(ResponseStatus.ClientError, 400, rc, message);
public static void LogInfoAndSend400Response(RoutingContext rc, String message) {
LogInfoAndSendResponse(ResponseStatus.ClientError, 400, rc, message);
}

public static void SendClientErrorResponseAndRecordStats(String errorStatus, int statusCode, RoutingContext rc, String message, Integer siteId, TokenResponseStatsCollector.Endpoint endpoint, TokenResponseStatsCollector.ResponseStatus responseStatus, ISiteStore siteProvider, TokenResponseStatsCollector.PlatformType platformType)
{
Warning(errorStatus, statusCode, rc, message);
if (ResponseStatus.ClientError.equals(errorStatus) ||
ResponseStatus.InvalidAppName.equals(errorStatus) ||
ResponseStatus.InvalidHttpOrigin.equals(errorStatus))
{
LogInfoAndSendResponse(errorStatus, statusCode, rc, message);
}
else {
LogWarningAndSendResponse(errorStatus, statusCode, rc, message);
}

recordTokenResponseStats(siteId, endpoint, responseStatus, siteProvider, null, platformType);
}

public static void SendServerErrorResponseAndRecordStats(RoutingContext rc, String message, Integer siteId, TokenResponseStatsCollector.Endpoint endpoint, TokenResponseStatsCollector.ResponseStatus responseStatus, ISiteStore siteProvider, Exception exception, TokenResponseStatsCollector.PlatformType platformType)
{
Error(ResponseStatus.UnknownError, 500, rc, message, exception);
LogErrorAndSendResponse(ResponseStatus.UnknownError, 500, rc, message, exception);
rc.fail(500);
recordTokenResponseStats(siteId, endpoint, responseStatus, siteProvider, null, platformType);
}
Expand All @@ -97,62 +105,40 @@ public static JsonObject Response(String status, String message) {
return json;
}

public static void Error(String errorStatus, int statusCode, RoutingContext rc, String message) {
logError(errorStatus, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
public static void LogErrorAndSendResponse(String errorStatus, int statusCode, RoutingContext rc, String message) {
String msg = ComposeMessage(errorStatus, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
LOGGER.error(msg);
final JsonObject json = Response(errorStatus, message);
rc.response().setStatusCode(statusCode).putHeader(HttpHeaders.CONTENT_TYPE, "application/json")
.end(json.encode());
}

public static void Error(String errorStatus, int statusCode, RoutingContext rc, String message, Exception exception) {
logError(errorStatus, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress(), exception);
public static void LogErrorAndSendResponse(String errorStatus, int statusCode, RoutingContext rc, String message, Exception exception) {
String msg = ComposeMessage(errorStatus, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
LOGGER.error(msg, exception);
final JsonObject json = Response(errorStatus, message);
rc.response().setStatusCode(statusCode).putHeader(HttpHeaders.CONTENT_TYPE, "application/json")
.end(json.encode());
}

public static void Warning(String status, int statusCode, RoutingContext rc, String message) {
logWarning(status, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
public static void LogInfoAndSendResponse(String status, int statusCode, RoutingContext rc, String message) {
String msg = ComposeMessage(status, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
LOGGER.info(msg);
final JsonObject json = Response(status, message);
rc.response().setStatusCode(statusCode).putHeader(HttpHeaders.CONTENT_TYPE, "application/json")
.end(json.encode());
}

private static void logError(String errorStatus, int statusCode, String message, RoutingContextReader contextReader, String clientAddress) {
JsonObject errorJsonObj = JsonObject.of(
"errorStatus", errorStatus,
"contact", contextReader.getContact(),
"siteId", contextReader.getSiteId(),
"statusCode", statusCode,
"clientAddress", clientAddress,
"message", message
);
final String linkName = contextReader.getLinkName();
if (!linkName.isBlank()) {
errorJsonObj.put(SecureLinkValidatorService.SERVICE_LINK_NAME, linkName);
}
final String serviceName = contextReader.getServiceName();
if (!serviceName.isBlank()) {
errorJsonObj.put(SecureLinkValidatorService.SERVICE_NAME, serviceName);
}
LOGGER.error("Error response to http request. " + errorJsonObj.encode());
}

private static void logError(String errorStatus, int statusCode, String message, RoutingContextReader contextReader, String clientAddress, Exception exception) {
String errorMessage = "Error response to http request. " + JsonObject.of(
"errorStatus", errorStatus,
"contact", contextReader.getContact(),
"siteId", contextReader.getSiteId(),
"path", contextReader.getPath(),
"statusCode", statusCode,
"clientAddress", clientAddress,
"message", message
).encode();
LOGGER.error(errorMessage, exception);
public static void LogWarningAndSendResponse(String status, int statusCode, RoutingContext rc, String message) {
String msg = ComposeMessage(status, statusCode, message, new RoutingContextReader(rc), rc.request().remoteAddress().hostAddress());
LOGGER.warn(msg);
final JsonObject json = Response(status, message);
rc.response().setStatusCode(statusCode).putHeader(HttpHeaders.CONTENT_TYPE, "application/json")
.end(json.encode());
}

private static void logWarning(String status, int statusCode, String message, RoutingContextReader contextReader, String clientAddress) {
JsonObject warnMessageJsonObject = JsonObject.of(
private static String ComposeMessage(String status, int statusCode, String message, RoutingContextReader contextReader, String clientAddress) {
JsonObject msgJsonObject = JsonObject.of(
"errorStatus", status,
"contact", contextReader.getContact(),
"siteId", contextReader.getSiteId(),
Expand All @@ -165,14 +151,22 @@ private static void logWarning(String status, int statusCode, String message, Ro
final String origin = contextReader.getOrigin();
if (statusCode >= 400 && statusCode < 500) {
if (referer != null) {
warnMessageJsonObject.put("referer", referer);
msgJsonObject.put("referer", referer);
}
if (origin != null) {
warnMessageJsonObject.put("origin", origin);
msgJsonObject.put("origin", origin);
}
}
String warnMessage = "Warning response to http request. " + warnMessageJsonObject.encode();
LOGGER.warn(warnMessage);

final String linkName = contextReader.getLinkName();
if (!linkName.isBlank()) {
msgJsonObject.put(SecureLinkValidatorService.SERVICE_LINK_NAME, linkName);
}
final String serviceName = contextReader.getServiceName();
if (!serviceName.isBlank()) {
msgJsonObject.put(SecureLinkValidatorService.SERVICE_NAME, serviceName);
}
return "Response to http request. " + msgJsonObject.encode();
}

public static class ResponseStatus {
Expand All @@ -183,6 +177,7 @@ public static class ResponseStatus {
public static final String InvalidToken = "invalid_token";
public static final String ExpiredToken = "expired_token";
public static final String GenericError = "error";
public static final String InvalidClient = "invalid_client";
public static final String UnknownError = "unknown";
public static final String InsufficientUserConsent = "insufficient_user_consent";
public static final String InvalidHttpOrigin = "invalid_http_origin";
Expand Down
Loading
Loading