在 Google Cloud 上設定具備微服務可觀察性的 gRPC 應用程式

C++

1. 連線至 VM 執行個體後，請執行下列指令。

   sudo apt-get update -y
   sudo apt-get install -y git build-essential clang
   git clone -b v1.54.0 https://github.com/grpc/grpc.git --depth=1
   

Go

1. 確認您已安裝 Go。

   sudo apt-get install -y git
   sudo apt install wget
   wget https://go.dev/dl/go1.20.2.linux-amd64.tar.gz
   sudo rm -rf /usr/local/go && sudo tar -C /usr/local -xzf \
   go1.20.2.linux-amd64.tar.gz
   export PATH=$PATH:/usr/local/go/bin
   

2. 複製 gRPC-Go 範例。

   git clone https://github.com/grpc/grpc-go.git
   cd grpc-go/
   git checkout -b run-observability-example
   875c97a94dca8093bf01ff2fef490fbdd576373d
   

Java

1. 連線至 VM 執行個體後，請確認已安裝 Java 8 以上版本。

   sudo apt update
   sudo apt upgrade
   sudo apt install git
   sudo apt-get install -y openjdk-11-jdk-headless
   

2. 複製 grpc-java 存放區。

   export EXAMPLES_VERSION=v1.54.1
   git clone -b $EXAMPLES_VERSION --single-branch --depth=1 \
   https://github.com/grpc/grpc-java.git
   

C++

從 gRPC C++ v1.54 開始，您可以使用 C++ 搭配微服務可觀測性。範例存放區位於 GitHub。

1. 觀測功能僅支援 Bazel 建構系統。將目標 grpcpp_gcp_observability 新增為依附元件。

2. 如要啟用微服務可觀測性，需要額外的依附元件 (可觀測性模組)，以及對現有 gRPC 用戶端、伺服器或兩者進行下列程式碼變更：

   #include <grpcpp/ext/gcp_observability.h>
   
   int main(int argc, char** argv) {
     auto observability = grpc::GcpObservability::Init();
     assert(observability.ok());
     …
     // Observability data flushed when object goes out of scope
   }
   

   在執行任何 gRPC 作業 (包括建立管道、伺服器或憑證) 之前，請先叫用下列項目：

   grpc::GcpObservability::Init();
   

   這會傳回 absl::StatusOr<GcpObservability>，請儲存該值。狀態有助於判斷可觀測性是否已成功初始化。隨附的 GcpObservability 物件會控管可觀測性的生命週期，並在超出範圍時自動關閉及清除可觀測性資料。

Go

1. gRPC Go v1.54.0 以上版本支援微服務可觀測性外掛程式。範例存放區位於 GitHub。

使用 Go 模組時，如要啟用微服務可觀測性，需要可觀測性模組和下列程式碼：

import "google.golang.org/grpc/gcp/observability"

func main() {
  ctx, cancel := context.WithTimeout(context.Background(), time.Second)
  defer cancel()
  if err := observability.Start(ctx); err != nil {
    log.Warning("Unable to start gRPC observability:", err)
  }
  defer observability.End()
  …
}

observability.Start 呼叫會剖析環境變數中的設定、建立相應的匯出工具，並將收集邏輯注入呼叫後建立的用戶端連線和伺服器。延遲的 observability.End 呼叫會清除資源，並確保緩衝資料在應用程式關閉前排清。

更新應用程式程式碼後，請執行下列指令來更新 go.mod 檔案。

go mod tidy

Java

如要將微服務觀測功能與 Java 應用程式搭配使用，請修改建構作業，加入 grpc-gcp-observability 構件。使用 gRPC 1.54.1 以上版本。

在 Gradle 和 Maven 建構工具部分的建構程式碼片段中，grpcVersion 會設為 1.54.1。

範例存放區位於 GitHub。

1. 如要順利檢測 Java 應用程式，以取得微服務可觀測性，請將下列程式碼新增至 main()。

...
import io.grpc.gcp.observability.GcpObservability;
...

// Main application class
...

public static void main(String[] args) {
...
  // call GcpObservability.grpcInit() to initialize & get observability
  GcpObservability observability = GcpObservability.grpcInit();

...
  // call close() on the observability instance to shutdown observability
  observability.close();
...
}

請注意，您必須先呼叫 GcpObservability.grpcInit()，才能建立任何 gRPC 管道或伺服器。GcpObservability.grpcInit() 函式會讀取微服務可觀測性設定，並使用該設定建立每個管道和伺服器中記錄、指標和追蹤功能所需的全域攔截器和追蹤器。GcpObservability.grpcInit() 是執行緒安全，且必須呼叫一次。這個方法會傳回 GcpObservability 的例項，您必須儲存這個例項，才能在稍後呼叫 close()。

GcpObservability.close() 會取消分配資源。之後建立的任何頻道或伺服器都不會記錄任何內容。

GcpObservability 會實作 java.lang.AutoCloseable，如果您使用 try-with-resource，系統會自動關閉 java.lang.AutoCloseable，如下所示：

...
import io.grpc.gcp.observability.GcpObservability;
...

// Main application class
...

public static void main(String[] args) {
...
  // call GcpObservability.grpcInit() to initialize & get observability
  try (GcpObservability observability = GcpObservability.grpcInit()) {

...
  } // observability.close() called implicitly
...
}

使用 Gradle 建構工具

如果您使用 Gradle 建構工具，請加入下列項目：

def grpcVersion = '1.54.1'

...

dependencies {
...
implementation "io.grpc:grpc-gcp-observability:${grpcVersion}"
...
}

使用 Maven 建構工具 (pom.xml)

如果您使用 Maven 建構工具，請加入下列項目：

<properties>
...
<grpc.version>1.54.1</grpc.version>
...
</properties>

...

<dependencies>
...
<dependency>
<groupId>io.grpc</groupId>
<artifactId>grpc-gcp-observability</artifactId>
<version>${grpc.version}</version>
</dependency>
...
</dependencies>

C++

1. 建立 VM 的 SSH 工作階段。

2. 匯出環境變數。按照上述步驟建立 server_config.json。

     export GOOGLE_CLOUD_PROJECT=$PROJECT_ID
     export GRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/server_config.json"
   

3. 執行伺服器應用程式 shell cd grpc tools/bazel run examples/cpp/gcp_observability/helloworld:greeter_server

Go

1. 建立 VM 的 SSH 工作階段。

2. 匯出環境變數。按照上述步驟建立 server_config.json。

   export GRPC_GCP_OBSERVABILITY_CONFIG_FILE=./server/serverConfig.json
   

3. 執行伺服器應用程式 shell go run ./server/main.go

Java

1. 在 examples 目錄中開啟 README 檔案，然後按照檔案中的操作說明操作。
2. 當指示要求您開啟另一個終端機視窗時，請發出下列指令： shell gcloud compute ssh --project=$PROJECT_ID grpc-observability-vm

C++

1. 建立另一個連往 VM 的 SSH 工作階段。

2. 匯出環境變數。按照上述步驟建立 client_config.json 檔案。

     export GOOGLE_CLOUD_PROJECT=$PROJECT_ID
     export GRPC_GCP_OBSERVABILITY_CONFIG_FILE="$(pwd)/examples/cpp/gcp_observability/helloworld/client_config.json"
   

3. 執行用戶端應用程式

   cd grpc
   tools/bazel run examples/cpp/gcp_observability/helloworld:greeter_client
   

Go

1. 建立另一個連往 VM 的 SSH 工作階段。
2. 匯出環境變數。使用上述步驟建立 client_config.json 檔案。 shell export GRPC_GCP_OBSERVABILITY_CONFIG_FILE=./client/clientConfig.json

3. 執行用戶端應用程式

   cd grpc-go/examples/features/observability
   go run ./client/main.go
   

Java

1. 在範例目錄中開啟 README 檔案，然後按照檔案中的操作說明操作。
2. 當操作說明要求您開啟另一個終端機視窗時，請發出下列指令： shell gcloud compute ssh --project=$PROJECT_ID grpc-observability-vm