优秀的编程知识分享平台

网站首页 > 技术文章 正文

高并发系统中的自定义日志埋点:从问题定位到解决的全流程详解

nanyue 2024-12-29 04:54:41 技术文章 4 ℃

背景
在高并发系统中,通常不会打印除参数校验失败或捕获异常之外的日志,以防止对接口的性能产生影响。然而,当遇到请求不符合预期的情况时,快速定位问题变得至关重要。Pfinder提供的链路监控主要关注性能层面的监控,无法满足具体逻辑排查的需求。

本文将详细介绍如何通过自定义通用上下文和日志埋点,来解决高并发系统中请求异常时的问题排查。



实现自定义日志埋点的通用上下文

通用上下文(CommonContext)的作用

创建通用上下文的目的是跟踪一个请求的生命周期。根据请求的特殊标识,决定是否记录关键日志,然后返回给调用方,以识别具体执行了什么逻辑,从而快速排查问题。

含:

  • 记录日志的字段
  • 通用参数
  • 计算中间结果

示例代码:

@Slf4j
@Data
public class CommonContext {
    // 日志
    private StringBuffer logSb = new StringBuffer();
    // 日志开关
    private boolean isDebug;

    // 通用参数
    private boolean compare = false;
    // 中间结果
    private Set<Integer> targetSet = new HashSet<>();

    public void clearContext() {
        targetSet = Collections.emptySet();
        compare = false;
    }

    public void debug(String message) {
        if (!isDebug || StringUtils.isEmpty(message)) {
            return;
        }
        logSb.append(message).append("\t\n");
    }

    public void debug(String format, Object... argArray) {
        if (!isDebug) {
            return;
        }
        String[] msgArray = new String[argArray.length];
        for (int i = 0; i < argArray.length; i++) {
            msgArray[i] = JSON.toJSONString(argArray[i]);
        }
        FormattingTuple ft = MessageFormatter.arrayFormat(format, msgArray);
        logSb.append(ft.getMessage()).append("\t\n");
    }

    public void debugEnd() {
        if (!isDebug) {
            return;
        }
        String msg = logSb.toString();
        log.info(msg);
    }
}

使用示例

通过在方法中启用上下文日志记录,在特定条件下捕获请求过程中的关键日志信息。

方法使用示例:

@Override
public Response method(Request request) {
    if (checkParam(request)) {
        log.error("request param error:{}", JSON.toJSONString(request));
        return Response.failed(ResponseCode.PARAM_INVALID);
    }

    CallerInfo info = Profiler.registerInfo(Ump.getUmpKey(xxxx), false, true);
    ParamVO paramVO = request.getParam();

    try {
        CommonContext context = new CommonContext();
        context.setDebug(Constants.SPECIAL_UUID.equals(request.getUuid()));

        Long userId = paramVO.getUserId();
        context.setCompare(paramVO.getCompare());

        context.debug("输入参数:{}", paramVO);
        List result = userAppService.match(context, paramVO);
        context.debug("输出结果:{}", result);
        context.clearContext();

        Response response = Response.success(result);
        context.debugEnd(response);
        return response;
    } catch (Exception e) {
        log.error("method error", e);
        Profiler.functionError(info);
        return Response.failed(ResponseCode.ERROR);
    } finally {
        Profiler.registerInfoEnd(info);
    }
}

说明:

  1. 开启日志开关:当识别到指定的 uuid,开启上下文日志记录。
  2. 防止结果影响循环:对于批量接口,在每个循环体内执行 context.clearContext(),防止中间结果影响后续处理。
  3. 关键日志记录:通过 context.debug() 记录关键日志信息,并可附加到 Response#message,随响应返回。

存在的问题与注意点

在记录日志时,要确保:

  • 避免无意义信息:日志中信息应尽量简洁、直观,避免记录无意义的信息。
  • 性能影响:选择关键信息记录,避免日志信息过大影响系统性能。

示例:

context.debug("activityList:{}", activityList.stream()
        .map(ActivityInfo::toString)
        .collect(Collectors.joining("######")));

进一步优化日志记录

动态配置日志级别

通过动态配置日志级别,可以在生产环境下有选择地开启或关闭详细日志记录,减少系统的性能损耗。

示例:

public class LogConfig {
    private static final Logger logger = LoggerFactory.getLogger(LogConfig.class);
    private static final String DEFAULT_LOG_LEVEL = "INFO";

    public static void setLogLevel(String logLevel) {
        LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory();
        ch.qos.logback.classic.Logger rootLogger = loggerContext.getLogger(Logger.ROOT_LOGGER_NAME);
        rootLogger.setLevel(Level.toLevel(logLevel, Level.valueOf(DEFAULT_LOG_LEVEL)));
        logger.info("Log level set to {}", logLevel);
    }
}

总结

通过自定义通用上下文和日志埋点,可以在高并发系统中有效记录请求的生命周期和关键日志,快速定位和解决问题。自定义日志埋点不仅提高了问题排查的效率,同时也减少了对系统性能的影响。结合动态日志级别控制等优化手段,可以灵活调整日志记录策略,全面提升系统的稳定性和可维护性。

京东云提供了高效的云服务平台,助力企业提升系统稳定性和性能。

如果你觉得本篇文章对你有帮助,请点赞、分享,欢迎探讨相关技术问题。你的支持是我们前进的动力!

更多高并发系统优化技巧,关注我们,不错过每一篇精彩内容!?

最近发表
标签列表