Standardizing Log Formats and Using traceId for Faster Backend Issue Resolution

In daily backend work, missing or poorly formatted logs make bug location difficult and increase resolution time, especially for high‑impact bugs that can cause significant GMV loss. Fast, accurate logging is therefore a key metric of a developer's effectiveness.

The author recommends defining a unified LogObject class that contains fields such as eventName , traceId , userId , msg , costTime , request , response , and others . Using this object ensures consistent log format and simplifies aggregation.

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
import com.fasterxml.jackson.annotation.JsonProperty;

public class LogObject {
    @JsonProperty(index = 1)
    private String eventName;
    @JsonProperty(index = 2)
    private String traceId;
    @JsonProperty(index = 3)
    private String msg;
    @JsonProperty(index = 4)
    private long costTime;
    @JsonProperty(index = 6)
    private Integer userId;
    @JsonProperty(index = 7)
    private Object others;
    @JsonProperty(index = 8)
    private Object request;
    @JsonProperty(index = 9)
    private Object response;
    // getters and chain‑style setters omitted for brevity
}

Using chain‑style setters makes it easy to populate the object in one fluent statement, for example:

long endTime = System.currentTimeMillis();
LogObject logObject = new LogObject();
logObject.setEventName(methodName)
         .setMsg(msg)
         .setTraceId(traceId)
         .setUserId(backendId)
         .setRequest(liveRoomPushOrderReqDto)
         .setResponse(response)
         .setCostTime(endTime - beginTime);
LOGGER.info(JSON.toJSONString(logObject));

Placing both request and response in the same log entry helps trace the full context without needing separate grep operations. An example JSON log is shown, containing event name, traceId, message, cost time, request parameters, and response data.

For generating a traceId , a simple method is to concatenate the API name with System.currentTimeMillis() . This identifier can be passed through all downstream services (marketing, order, payment) so that a single grep traceId reveals the entire call chain.

Two implementation strategies are discussed: (1) manually adding traceId in each service method, which has minimal overhead and is suitable for ultra‑high‑performance scenarios; (2) using AOP with thread‑local storage to inject the traceId automatically, which reduces code intrusion but adds a slight performance cost.

The article concludes with a reminder to add traceId to all micro‑service calls, especially in aggregation layers, to simplify debugging and improve operational efficiency.