如何让Netflix Ribbon记录负载均衡选中的服务实例日志？

我之前刚好碰到过和你一样的需求——不想在每个服务实例里加日志，只想在Zuul这边集中看到Ribbon选了哪个实例。给你几个实用的方案，亲测有效：

方案1：自定义Ribbon负载均衡规则（IRule） #

通过扩展Ribbon默认的负载均衡规则，在选择实例后直接记录日志，这种方式能精准捕获Ribbon的选择结果：

1. 编写自定义Rule类，继承默认的ZoneAvoidanceRule（或者你正在使用的其他Rule）：

import com.netflix.loadbalancer.Server;
import com.netflix.loadbalancer.ZoneAvoidanceRule;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class LoggingRibbonRule extends ZoneAvoidanceRule {
    private static final Logger logger = LoggerFactory.getLogger(LoggingRibbonRule.class);

    @Override
    public Server choose(Object key) {
        Server selectedServer = super.choose(key);
        if (selectedServer != null) {
            logger.info("Ribbon selected service instance: {}:{}", 
                selectedServer.getHost(), selectedServer.getPort());
        }
        return selectedServer;
    }
}

2. 配置让Ribbon使用这个自定义规则：
   • 如果只想对某个服务生效，在application.yml中添加：

   your-target-service-id:
     ribbon:
       NFLoadBalancerRuleClassName: com.your.package.LoggingRibbonRule
   

   • 如果要全局生效所有服务，在启动类上添加注解：

   @SpringBootApplication
   @RibbonClients(defaultConfiguration = LoggingRibbonRule.class)
   public class ZuulServerApplication {
       public static void main(String[] args) {
           SpringApplication.run(ZuulServerApplication.class, args);
       }
   }
   

方案2：利用Zuul前置过滤器（PreFilter） #

Zuul在路由请求时会把Ribbon选中的实例信息存在RequestContext中，我们可以通过自定义过滤器直接读取并记录：

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.cloud.netflix.ribbon.RibbonCommandContext;
import org.springframework.stereotype.Component;

@Component
public class RibbonInstanceLoggingFilter extends ZuulFilter {
    private static final Logger logger = LoggerFactory.getLogger(RibbonInstanceLoggingFilter.class);

    @Override
    public String filterType() {
        return "pre"; // 前置过滤器，在路由前执行
    }

    @Override
    public int filterOrder() {
        return 10; // 确保顺序在Ribbon路由选择之后
    }

    @Override
    public boolean shouldFilter() {
        // 只对走Ribbon路由的请求生效
        return RequestContext.getCurrentContext().get("ribbonCommandContext") != null;
    }

    @Override
    public Object run() {
        RibbonCommandContext ribbonContext = (RibbonCommandContext) 
            RequestContext.getCurrentContext().get("ribbonCommandContext");
        
        if (ribbonContext != null && ribbonContext.getServer() != null) {
            String requestUri = RequestContext.getCurrentContext().getRequest().getRequestURI();
            logger.info("Zuul routed request '{}' to service instance: {}:{}",
                requestUri, ribbonContext.getServer().getHost(), ribbonContext.getServer().getPort());
        }
        return null;
    }
}

这个方案的优势是完全基于Zuul的扩展机制，不需要修改Ribbon的核心规则，日志会和Zuul的请求日志关联起来，更便于排查问题。

方案3：开启Ribbon调试日志（快速但日志量较大） #

如果只是临时排查问题，可以直接开启Ribbon的调试日志，它会输出包括实例选择过程在内的详细信息：

在application.yml中添加日志配置：

logging:
  level:
    com.netflix.loadbalancer: DEBUG

缺点是日志量会比较大，包含很多Ribbon内部的调试信息，需要你自己筛选关键内容，适合临时排查使用。

内容的提问来源于stack exchange，提问作者user2455862