透過 Spring Cloud Sleuth 和 Cloud Trace 進行分散式追蹤

1. 總覽

分散式追蹤對於深入瞭解多層微服務架構，以及觀察該架構的運作情形至關重要。當您將服務鏈結至服務呼叫時 (從服務 A 到服務 B 再到服務 C)，請務必瞭解呼叫是否成功，以及每個步驟的延遲時間。

在 Spring Boot 中，您可以使用 Spring Cloud Sleuth，將分散式追蹤記錄檢測無縫新增至應用程式。預設情況下，它可以將追蹤資料轉送至 Zipkin。

Google Cloud Platform 提供 Cloud Trace 代管服務，可讓您儲存追蹤資料，不必管理自己的 Zipkin 執行個體或儲存空間。Cloud Trace 也能產生延遲分布報告，並自動偵測效能回歸。

您可以透過下列兩種方式，從 Spring Boot 應用程式使用 Cloud Trace：

使用 Stackdriver Trace Zipkin Proxy，並將 Spring Cloud Sleuth 設定為使用這個 Proxy 做為 Zipkin 端點
或者，您也可以使用 Spring Cloud GCP Trace，與 Spring Cloud Sleuth 無縫整合，並直接將追蹤記錄資料轉送至 Cloud Trace。

在本程式碼研究室中，您將瞭解如何建構新的 Spring Boot 應用程式，並使用 Spring Cloud GCP Trace 進行分散式追蹤。

課程內容

如何建立 Spring Boot Java 應用程式並設定 Cloud Trace。

軟硬體需求

Google Cloud Platform 專案
Chrome 或 Firefox 瀏覽器
熟悉標準 Linux 文字編輯器，例如 Vim、EMAC 或 Nano

您會如何使用這項教學課程？

僅閱讀

閱讀並完成練習

您對建構 HTML/CSS 網頁應用程式的體驗滿意嗎？

新手

中級

熟練

您對使用 Google Cloud Platform 服務的體驗有何評價？

新手

中級

熟練

2. 設定和需求

自修實驗室環境設定

登入 Google Cloud 控制台，然後建立新專案或重複使用現有專案。如果沒有 Gmail 或 Google Workspace 帳戶，請先建立帳戶。

專案名稱是這個專案參與者的顯示名稱。這是 Google API 未使用的字元字串。你隨時可以更新。
專案 ID 在所有 Google Cloud 專案中都是不重複的，而且設定後即無法變更。Cloud 控制台會自動產生專屬字串，通常您不需要在意該字串為何。在大多數程式碼研究室中，您需要參照專案 ID (通常標示為 PROJECT_ID)。如果您不喜歡產生的 ID，可以產生另一個隨機 ID。你也可以嘗試使用自己的名稱，看看是否可用。完成這個步驟後就無法變更，且專案期間會維持不變。
請注意，有些 API 會使用第三個值，也就是「專案編號」。如要進一步瞭解這三種值，請參閱說明文件。

接著，您需要在 Cloud 控制台中啟用帳單，才能使用 Cloud 資源/API。完成這個程式碼研究室的費用不高，甚至可能完全免費。如要關閉資源，避免在本教學課程結束後繼續產生費用，請刪除您建立的資源或專案。Google Cloud 新使用者可參加價值$300 美元的免費試用計畫。

Google Cloud Shell

雖然可以透過筆電遠端操作 Google Cloud 和 Kubernetes，但在本程式碼研究室中，我們將使用 Google Cloud Shell，也就是在雲端執行的指令列環境。

啟用 Cloud Shell

在 Cloud 控制台，點選「啟用 Cloud Shell」圖示。

如果您是首次啟動 Cloud Shell，系統會顯示中繼畫面，說明這個指令列環境。如果出現中繼畫面，請按一下「繼續」。

佈建並連至 Cloud Shell 預計只需要幾分鐘。

這部虛擬機器已載入所有必要的開發工具，並提供永久的 5 GB 主目錄，而且可在 Google Cloud 運作，大幅提升網路效能並強化驗證功能。本程式碼研究室幾乎所有工作都可在瀏覽器上完成。

連至 Cloud Shell 後，您應該會看到驗證已完成，專案也已設為獲派的專案 ID。

在 Cloud Shell 中執行下列指令，確認您已通過驗證：

gcloud auth list

指令輸出

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

在 Cloud Shell 中執行下列指令，確認 gcloud 指令知道您的專案：

gcloud config list project

指令輸出

[core]
project = <PROJECT_ID>

如未設定，請輸入下列指令手動設定專案：

gcloud config set project <PROJECT_ID>

指令輸出

Updated property [core/project].

3. 建立新的 Spring Boot REST 服務

啟動 Cloud Shell 後，您可以使用指令列，透過 Spring Initializr 產生新的 Spring Boot 應用程式：

$ curl https://start.spring.io/starter.tgz -d packaging=jar \
  -d bootVersion=2.7.6 \
  -d dependencies=web,lombok,cloud-gcp,distributed-tracing \
  -d jvmVersion=17 \
  -d type=maven-project \
  -d baseDir=trace-service-one | tar -xzvf - \
  && cd trace-service-one

新增類別，建立新的 REST 控制器：

src/main/java/com/example/demo/WorkController.java

package com.example.demo;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Random;

@RestController
@Slf4j
public class WorkController {
  Random r = new Random();

  public void meeting() {
    try {
      log.info("meeting...");
      // Delay for random number of milliseconds.
      Thread.sleep(r.nextInt(500));
    } catch (InterruptedException e) {
    }
  }

  @GetMapping("/")
  public String work() {
    // What is work? Meetings!
    // When you hit this URL, it'll call meetings() 5 times.
    // Each time will have a random delay.
    log.info("starting to work");
    for (int i = 0; i < 5; i++) {
      this.meeting();
    }
    log.info("finished!");
    return "finished work!";
  }
}

請確認應用程式的 JVM 版本是否正確：

$ export JAVA_HOME=/usr/lib/jvm/java-1.17.0-openjdk-amd64

您可以使用 Spring Boot 外掛程式正常啟動 Spring Boot 應用程式。我們在本實驗室中略過測試：

$ ./mvnw -DskipTests spring-boot:run

應用程式啟動後，請點選 Cloud Shell 工具列中的「網頁預覽」圖示，然後選擇「透過以下通訊埠預覽：8080」。

稍待片刻後，您應該會看到結果：

在 Cloud Shell 中，您也應該會看到含有追蹤 ID 和範圍 ID 的記錄訊息：

4. 使用 Cloud Trace

啟用 Cloud Trace API

如要使用 Cloud Trace 儲存追蹤資料，請先啟用 Cloud Trace API。如要啟用 API，請執行下列指令：

$ gcloud services enable cloudtrace.googleapis.com

設定應用程式預設憑證

在本實驗室中，您需要設定應用程式預設憑證。Spring Cloud GCP Trace 啟動器會自動擷取這項憑證。

首先，請登入：

$ gcloud auth application-default login
You are running on a Google Compute Engine virtual machine.
The service credentials associated with this virtual machine
will automatically be used by Application Default
Credentials, so it is not necessary to use this command.
If you decide to proceed anyway, your user credentials may be visible
to others with access to this virtual machine. Are you sure you want
to authenticate with your personal account?
Do you want to continue (Y/n)? Y

Go to the following link in your browser:
    https://accounts.google.com/o/oauth2/auth...
Enter verification code: ...

按一下連結開啟新的瀏覽器分頁，然後按一下「允許」

然後將驗證碼複製並貼回 Cloud Shell，然後按下 Enter 鍵。畫面上會顯示下列訊息：

Credentials saved to file: [/tmp/tmp.jm9bnQ4R9Q/application_default_credentials.json]
These credentials will be used by any library that requests
Application Default Credentials.

新增 Spring Cloud GCP Trace

在這項服務中，我們已使用 Spring Cloud Sleuth 進行追蹤。請新增 Spring Cloud GCP Trace 啟動器，將資料轉送至 Cloud Trace。

新增 Spring Cloud GCP Trace 依附元件：

pom.xml

<project>
  ...
  <dependencies>
    ...
    <!-- Add Cloud Trace Starter -->
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>spring-cloud-gcp-starter-trace</artifactId>
    </dependency>
  </dependencies>
  ...
</project>

根據預設，Spring Cloud Sleuth 不會對每個要求取樣。為簡化測試，請在 application.properties 中將取樣率提高至 100%，確保我們能看到追蹤資料，並忽略部分不重要的網址：

$ echo "
spring.sleuth.sampler.probability=1.0
spring.sleuth.web.skipPattern=(^cleanup.*|.+favicon.*)
" > src/main/resources/application.properties

再次執行應用程式，並使用 Cloud Shell 網頁預覽功能查看應用程式：

$ export GOOGLE_CLOUD_PROJECT=`gcloud config list --format 'value(core.project)'`
$ ./mvnw -DskipTests spring-boot:run

根據預設，Spring Cloud GCP Trace 會批次處理追蹤資料，並每 10 秒傳送一次，或是在收到最少數量的追蹤資料時傳送。這項設定可供調整，詳情請參閱 Spring Cloud GCP Trace 參考說明文件。

向服務發出要求：

$ curl localhost:8080

在 Cloud 控制台中，依序前往「Operations」→「Trace」→「Trace list」

在頂端將時間範圍縮小至 1 小時。「自動重新載入」預設為開啟。因此，追蹤資料一抵達，就會顯示在控制台中！

追蹤記錄資料應會在 30 秒左右顯示。

按一下藍色圓點，即可查看追蹤詳細資料：

非常簡單！

5. 建立第二個 Spring Boot 網頁應用程式

按一下「+」圖示，開啟新的 Cloud Shell 工作階段：

在新工作階段中，建立第二個 Spring Boot 應用程式：

$ curl https://start.spring.io/starter.tgz -d packaging=jar \
  -d bootVersion=2.7.6 \
  -d dependencies=web,lombok,cloud-gcp,distributed-tracing \
  -d jvmVersion=17 \
  -d type=maven-project \
  -d baseDir=trace-service-two | tar -xzvf - \
  && cd trace-service-two

新增類別，建立新的 REST 控制器：

src/main/java/com/example/demo/MeetingController.java

package com.example.demo;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Random;

@RestController
@Slf4j
public class MeetingController {
  Random r = new Random();

  @GetMapping("/meet")
  public String meeting() {
    try {
      log.info("meeting...");
      Thread.sleep(r.nextInt(500 - 20 + 1) + 20);
    } catch (InterruptedException e) {
    }
    return "finished meeting";
  }
}

在 pom.xml 中新增 Spring Cloud GCP Trace

pom.xml

<project>
  ...
  <dependencies>
    ...
    <!-- Add Cloud Trace starter -->
    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>spring-cloud-gcp-starter-trace</artifactId>
    </dependency>
  </dependencies>
  ...
</project>

將 Sleuth 設為對 100% 的要求取樣：

src/main/resources/application.properties

$ echo "
spring.sleuth.sampler.probability=1.0
spring.sleuth.web.skipPattern=(^cleanup.*|.+favicon.*)
" > src/main/resources/application.properties

最後，您可以使用 Spring Boot 外掛程式，在通訊埠 8081 上啟動 Spring Boot 應用程式：

$ export GOOGLE_CLOUD_PROJECT=`gcloud config list --format 'value(core.project)'`
$ ./mvnw -DskipTests spring-boot:run -Dspring-boot.run.jvmArguments="-Dserver.port=8081"

6. 更新 First Service 以使用 Second Service

在 trace-service-two 執行期間，返回第一個 Cloud Shell 工作階段視窗，並修改 trace-service-one。

首先，初始化新的 RestTemplate Bean：

src/main/java/com/example/demo/DemoApplication.java

package com.example.demo;

...

import org.springframework.web.client.RestTemplate;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class DemoApplication {
        @Bean
        public RestTemplate restTemplate() {
                return new RestTemplate();
        }
        
        public static void main(String[] args) {
                SpringApplication.run(DemoApplication.class, args);
        }
}

在 WorkController.meeting() 中，撥出電話給會議服務。

src/main/java/com/example/demo/WorkController.java

package com.example.demo;

...
import org.springframework.web.client.RestTemplate;
import org.springframework.beans.factory.annotation.Autowired;

@RestController
@Slf4j
public class WorkController {
  @Autowired
  RestTemplate restTemplate;

  public void meeting() {
    String result = restTemplate.getForObject("http://localhost:8081/meet", String.class);
    log.info(result);
  }

  ...
}

再次啟動服務，並從指令列觸發端點：

$ export GOOGLE_CLOUD_PROJECT=`gcloud config list --format 'value(core.project)'`

# The '&' places the process in the background. Bring it back to the foreground with 'fg'.
$ ./mvnw -DskipTests spring-boot:run &

$ curl localhost:8080