微服務可觀察性參考資訊

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

設定資料

下表定義了環境變數中的設定資料。

export GRPC_GCP_OBSERVABILITY_CONFIG='{
    "project_id": "your-project-here",
    "cloud_monitoring": {
    }
}'

export GRPC_GCP_OBSERVABILITY_CONFIG='{
    "project_id": "your-project-here",
    "cloud_trace": {
    }
}'

追蹤定義

本節提供追蹤功能的相關資訊。

追蹤內容傳播

跨服務追蹤功能才能運作，服務擁有者必須支援從上游 (或自行啟動) 收到的追蹤內容傳播至下游。追蹤記錄會透過 gRPC 中繼資料在服務之間傳播。請務必啟用 Cloud Monitoring、Cloud Logging、Cloud Trace API 和 Microservices API，讓這個設定中的服務將遙測資料回報給適當的服務。

如果沒有傳播支援功能，下游服務就無法為追蹤產生跨度。現有的跨度不會受到影響。微服務可觀測性外掛程式支援 OpenCensus 二進位格式，可用於編碼和編碼追蹤記錄內容。

時距數量

區間的名稱格式如下：

時距標籤

整合功能會提供不同的跨度標籤。

對於嘗試區間，系統會附加兩個重試相關的額外屬性 (區間標籤)：

指標定義

系統會提供下列指標，並在名為「微服務 (gRPC) 監控」的資訊主頁中顯示，以便針對常見的使用者歷程進行監控。

以下是 gRPC 用戶端指標的指標：

可用的 gRPC 伺服器端指標如下：

上表中的每個分布都包含以下值區的直方圖：

• 大小 (以位元組為單位)：0、1024、2048、4096、16384、65536、262144、1048576、4194304、16777216、67108864、268435456、1073741824、4294967296

• 延遲時間 (以毫秒為單位)：0、0.01、0.05、0.1、0.3、0.6、0.8、1、2、3、4、5、6、8、10、13、16、20、25、30、40、50、65、80、100、130、160、200、250、300、400、500、650、800、1000、2000、5000、10000、20000、50000、100000

標記說明：

• grpc_client_method：完整的 gRPC 方法名稱，包括套件、服務和方法，例如 google.bigtable.v2.Bigtable/CheckAndMutateRow
• grpc_client_status：收到的 gRPC 伺服器狀態碼，例如 OK、CANCELLED、DEADLINE_EXCEEDED
• grpc_server_method：完整的 gRPC 方法名稱，包括套件、服務和方法，例如 com.exampleapi.v4.BookshelfService/Checkout
• grpc_server_status：gRPC 伺服器傳回的狀態碼，例如 OK、CANCELLED、DEADLINE_EXCEEDED

記錄檔定義

微服務觀測記錄會使用記錄名稱上傳至 Cloud Logging (PROJECT_ID 是代表專案的字串預留位置)：

logName=projects/[PROJECT_ID]/logs/microservices.googleapis.com%2Fobservability%2Fgrpc

以下是產生記錄檔的 JSON 表示法：

{
    "authority": string,
    "callId": string,
    "type": string,
    "logger": string,
    "serviceName": string,
    "methodName": string,
    "peer": {
        "type": string,
        "address": string,
        "ipPort": int
    },
    "payload": {
        "timeout": string,
        "metadata":
            {
                string: string,
                string: string
            },
        "statusCode": string,
        "statusMessage": string,
        "statusDetails": string,
        "message": string,
        "messageLength": int,
    },
    "sequenceId": int
}

下表說明記錄項目中的欄位：

資源標籤

資源標籤可識別產生可觀察性資料的來源。每個資源標籤都是鍵/值組合，其中鍵是特定來源環境 (例如 GKE 或 Compute Engine) 的預先定義值。

針對 GKE 部署的指標和追蹤，系統會預設填入資源標籤，但容器名稱和命名空間名稱除外。您可以使用 Downward API 填入缺少的值。

以下是環境變數鍵：

• CONTAINER_NAME
• NAMESPACE

例如，以下 env 部分包含兩個資源標籤：

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    run: app1
  name: app1
spec:
  replicas: 2
  selector:
    matchLabels:
      run: app1
  template:
    metadata:
      labels:
        run: app1
    spec:
      containers:
        - image: 'o11y-examples:1.00'
          name: container1
          ports:
            - protocol: TCP
              containerPort: 50051
          env:
            - name: CONTAINER_NAME
              value: container1
            - name: NAMESPACE
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace

自訂標籤

自訂標籤代表觀察性資料中使用者提供的其他資訊。標籤由鍵和值組成。鍵/值組合會以跨距標籤的形式附加至追蹤資料、以指標標籤的形式附加至指標資料，以及以記錄項目標籤的形式附加至記錄資料。所有自訂標籤都是 STRING 類型。

您可以在設定中提供自訂標籤，方法是指定 labels 的鍵/值組合清單。實作會讀取設定，並為每個鍵/值組合建立獨立的標籤，然後將標籤附加至可觀察性資料。例如：

"labels": {
    "DATACENTER": "SAN_JOSE_DC",
    "APP_ID": "24512"
  }

每個記錄項目都包含下列額外標籤：

{
   "DATACENTER": "SAN_JOSE_DC"
   "APP_ID": "24512"
}

後續步驟

• 如要瞭解指標種類和類型，請參閱值類型和指標類型。
• 如要瞭解發布管道，請參閱發布管道參考頁面。
• 如要瞭解如何製作分布指標的圖表，請參閱「分布指標」。
• 如要瞭解單位 (例如 1、ms 和 By)，請參閱 MetricDescriptor 參考資料中的單位欄位。