我们如何在 Spring MVC 项目中使用 Spring Cloud Sleuth？

Posted 2023-02-27

【中文标题】我们如何在 Spring MVC 项目中使用 Spring Cloud Sleuth？

【英文标题】：How can we use Spring Cloud Sleuth with spring MVC project?

【发布时间】：2020-05-10 11:51:21

【问题描述】：

我正在尝试将 spring cloud sleuth 与 spring web mvc 项目一起使用。我们正在将来自 spring web mvc 的请求发送到另一个 spring boot 项目。我需要在 UI 中显示 traceID 和 spanId。我们怎样才能做到这一点？

编辑

用于 Spring Boot 应用程序的 POM.xml。我使用的是最新版本的Spring Boot，并添加了spring cloud sleuth的依赖。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.4.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.test</groupId>
<artifactId>demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>demo</name>
<description>Demo project for Spring Boot</description>

<properties>
    <java.version>1.8</java.version>
    <spring-cloud.version>Hoxton.SR1</spring-cloud.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-sleuth</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
</dependencies>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>$spring-cloud.version</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

Web MVC 代码：我正在使用 spring rest 模板并从 spring web mvc 应用程序调用 spring boot 服务。

@Controller
public class HelloController 

    @Autowired
    RestTemplate restTemplate;

    private Logger logger = Logger.getLogger(HelloController.class);

    @GetMapping("/hello")
    public String hello(Model model) 
        logger.info("Hello from controller");
        ResponseEntity<String> entity = restTemplate.getForEntity("http://localhost:8092/test", String.class);
        String response = entity.getBody();
        logger.info("Response from Service: "+ response);
        model.addAttribute("name", "Test");
        return "welcome";
    

【问题讨论】：

你如何称呼你的 spring-boot 项目？你在使用 RestTemplate 吗？

是的，我正在使用 RestTemplate。

您能否分享您的 spring-boot 应用程序的 pom.xml 以及您的 spring-mvc 应用程序中的示例代码 [您从中调用 spring-boot 应用程序的代码]

添加了 pom.xml 和 web mvc 代码

当你说你想在 UI 上显示 span_id 和 trace_id 时，这是否意味着你的应用程序的 UI 或者你可以想到像 zipkin 这样你可以根据 span_id/trace_id 等查看和搜索的东西。

【参考方案1】：

为此，您需要注入 Tracer bean，然后如果您调用 tracer.currentSpan().context().traceIdString() 和 tracer.currentSpan().context().spanIdString()。

【讨论】：

我们可以在跟踪日志时使用这个trace_id和span_id吗？我的意思是我们需要有一个在 UI 中使用的相关 ID（如 zipkin）

对不起，我不明白这个问题。如果您使用 Sleuth，您将获得完整的日志相关性，日志确实包含跟踪 ID 和跨度 ID。在问问题之前您是否尝试过使用它？或者您确实使用了它，但在日志中看不到跟踪 ID 和跨度 ID？您是否更改了默认的日志记录格式？一般来说，如果你只是将 starter-sleuth 添加到类路径中，你就会得到开箱即用的日志记录相关性。

是的，我尝试过使用 Sleuth，但实际的问题是，即使在更改日志格式后，我也没有在 Spring MVC 项目中获得 trace/span-id。我可以在 Spring Boot 项目中看到相关 ID，但在 Spring MVC 项目中看不到。

如果没有弹簧靴，Sleuth 将无法工作。你可以直接使用 Brave 项目

是否需要在spring MVC和spring Boot应用中都配置Brave？