為服務設定容器健康狀態檢查

Cloud Run 健康狀態檢查可確保容器執行個體正常運作，且能夠處理流量。透過 Cloud Run 健康狀態檢查，您可以自訂容器何時準備好接收要求，以及容器何時應視為健康狀態不良而需要重新啟動。

用途

您可以設定兩種類型的健康狀態檢查探測器：

• 啟動探測會判斷容器是否已啟動，並準備好接受流量。

  • 設定啟動探測時，有效性檢查會停用，直到啟動探測判斷容器已啟動為止，以免干擾服務啟動。
  • 如果您對啟動緩慢的容器使用有效性檢查，啟動探測就特別實用，因為啟動探測可防止容器在啟動並執行前過早關閉。

• 有效性探測會判斷是否要重新啟動容器。

  • 如果發生錯誤，重新啟動容器可提高服務可用性。
  • 執行中的探測器會重新啟動無法以任何其他方式復原的個別執行個體。這類事件主要用於無法復原的執行個體故障，例如服務正在執行但無法繼續運作的死結。您可以使用自訂機構政策，為每個容器設定存活探查。

如果服務發生重複啟動或有效性探測失敗的情況，Cloud Run 會限制執行個體重新啟動次數，避免發生不受控的當機迴圈。

重要事項： 如果使用 HTTP 探查，服務必須使用 HTTP/1，這是 Cloud Run 的預設設定。HTTP 健康狀態檢查探測不支援 HTTP/2。

設定探測

變更任何設定都會建立新的修訂版本。除非您明確做出更新，改變這項設定，否則後續的修訂版本也會自動取得這個設定。

設定啟動探測

您可以使用 Google Cloud 控制台、YAML 或 Terraform 設定 HTTP、TCP 和 gRPC 探測器：

控制台

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探查，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

1. 前往 Google Cloud 控制台的「Cloud Run」頁面：

   前往 Cloud Run

2. 如果是新服務，請展開「容器、磁碟區、網路與安全性」，顯示健康狀態檢查選項。如果是現有服務，請按一下要設定的服務，然後按一下「編輯並部署」，顯示健康狀態檢查選項。

3. 在「Container(s)」(容器) 部分中，前往「Health checks」(健康狀態檢查)，然後按一下「Add health check」(新增健康狀態檢查)，開啟「Add health check」(新增健康狀態檢查)設定面板。

4. 在「Select health check type」(選取健康狀態檢查類型) 選單中，選取要新增的健康狀態檢查類型。

5. 在「選取探測類型」選單中，選取要使用的探測類型，例如 HTTP 或 gRPC。系統會顯示探針設定表單。

6. 請注意，探針設定會因探針類型而異。設定探針：

   • 如果您使用 HTTP 探測：

     • 請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

     • 使用「路徑」欄位指定端點的相對路徑，例如 /。

     • 選取「HTTP 標頭」核取方塊，指定選用的自訂標頭。 在「名稱」欄位中指定標頭名稱，並在「值」欄位中指定標頭值。按一下「新增 HTTP 標頭」，指定更多標頭。

   • 如果您使用 gRPC 探針，請確保容器映像檔實作 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

   • 在「Port」(通訊埠) 部分，指定服務使用的容器通訊埠。

   • 在「初始延遲」中，指定容器啟動後，要等待多少秒才執行第一次探測。請指定介於 0 秒到 240 秒之間的值。預設值為 0 秒。

   • 在「Period」(週期) 中，指定執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定介於 1 秒到 240 秒之間的值。預設值為 10 秒。

   • 在「失敗門檻」中，指定關閉容器前要重試探測的次數。預設值為 3。

   • 在「Timeout」(逾時) 欄位中，指定探測逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。

7. 按一下「新增」即可新增門檻

gcloud

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

TCP 啟動

執行下列指令：

  gcloud run deploy SERVICE \
      --image=IMAGE_URL \
      --startup-probe tcpSocket.port=CONTAINER_PORT,initialDelaySeconds=DELAY,failureThreshold=THRESHOLD,timeoutSeconds=TIMEOUT,periodSeconds=PERIOD

取代：

• SERVICE 改為您的 Cloud Run 服務名稱。
• IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
• (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
• DELAY 是容器啟動後，到執行第一項探測作業之前，這段時間間隔的秒數。請指定介於 0 秒到 240 秒之間的值。預設值為 0 秒。
• (選用) TIMEOUT，等待探測逾時的秒數。這個值不得超過為 periodSeconds 指定的值。 請指定介於 1 到 240 之間的值。 預設值是 1。
• THRESHOLD，並指定在關閉容器前重新嘗試探測的次數。預設值為 3。
• PERIOD，並指定執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。

HTTP 啟動

執行下列指令：

  gcloud run deploy SERVICE \
      --image=IMAGE_URL \
      --startup-probe httpGet.path=PATH,httpGet.port=CONTAINER_PORT,initialDelaySeconds=DELAY,failureThreshold=THRESHOLD,timeoutSeconds=TIMEOUT,periodSeconds=PERIOD

取代：

• SERVICE 改為您的 Cloud Run 服務名稱。
• IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
• PATH，並將 HTTP 端點的相對路徑加進去，例如 /ready。
• (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
• (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
• (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
• (選用) TIMEOUT 是探測作業逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。
• (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。

啟動 gRPC

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

執行下列指令：

  gcloud run deploy SERVICE \
      --image=IMAGE_URL \
      --startup-probe grpc.port=CONTAINER_PORT,grpc.service=GRPC_SERVICE,initialDelaySeconds=DELAY,failureThreshold=THRESHOLD,timeoutSeconds=TIMEOUT,periodSeconds=PERIOD

取代：

• SERVICE 改為您的 Cloud Run 服務名稱。
• IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
• (選用) GRPC_SERVICE。如果已設定，系統會在呼叫 grpc.health.v1.Health.Check RPC 時，將這個值用於 grpc.health.v1.HealthCheckRequest 的服務欄位。
• (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
• (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
• (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
• (選用) TIMEOUT 是探測作業逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。
• (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。

YAML

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

TCP 啟動

1. 如要建立新服務，請略過這個步驟。如要更新現有服務，請下載其 YAML 設定：

   gcloud run services describe SERVICE --format export > service.yaml

2. 如圖所示設定 startupProbe 屬性：

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
    name: SERVICE
   spec:
    template:
      metadata:
      spec:
        containers:
        - image: IMAGE_URL
          startupProbe:
            tcpSocket:
              port: CONTAINER_PORT
            initialDelaySeconds: DELAY
            timeoutSeconds: TIMEOUT
            failureThreshold: THRESHOLD
            periodSeconds: PERIOD

   取代：

   • SERVICE 改為您的 Cloud Run 服務名稱。
   • IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
   • DELAY 是容器啟動後，到執行第一項探測作業之前，這段時間間隔的秒數。請指定介於 0 秒到 240 秒之間的值。預設值為 0 秒。
   • (選用) TIMEOUT，等待探測逾時的秒數。這個值不得超過為 periodSeconds 指定的值。 請指定介於 1 到 240 之間的值。 預設值是 1。
   • THRESHOLD，並指定在關閉容器前重新嘗試探測的次數。預設值為 3。
   • PERIOD，並指定執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。
3. 使用下列指令建立或更新服務：

   gcloud run services replace service.yaml

HTTP 啟動

1. 如要建立新服務，請略過這個步驟。如要更新現有服務，請下載其 YAML 設定：

   gcloud run services describe SERVICE --format export > service.yaml

2. 請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

3. 如圖所示設定 startupProbe 屬性：

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: SERVICE
   spec:
     template:
       metadata:
       spec:
         containers:
         - image: IMAGE_URL
           startupProbe:
             httpGet:
               path: PATH
               port: CONTAINER_PORT
               httpHeaders:
                 - name: HEADER_NAME
                   value: HEADER_VALUE
             initialDelaySeconds: DELAY
             timeoutSeconds: TIMEOUT
             failureThreshold: THRESHOLD
             periodSeconds: PERIOD

   取代：

   • SERVICE 改為您的 Cloud Run 服務名稱。
   • IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • PATH，並將 HTTP 端點的相對路徑加進去，例如 /ready。
   • (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
   • (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
   • (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
   • (選用) httpHeaders 可用於使用 HEADER_NAME 和 HEADER_VALUE 欄位提供多個或重複的自訂標頭，如下所示。
   • (選用) TIMEOUT 是探測作業逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。
   • (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。
4. 使用下列指令建立或更新服務：

   gcloud run services replace service.yaml

啟動 gRPC

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

1. 如要建立新服務，請略過這個步驟。如要更新現有服務，請下載其 YAML 設定：

   gcloud run services describe SERVICE --format export > service.yaml

2. 如圖所示設定 startupProbe 屬性：

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: SERVICE
   spec:
     template:
       metadata:
       spec:
         containers:
         - image: IMAGE_URL
           startupProbe:
             grpc:
               service: GRPC_SERVICE
               port: CONTAINER_PORT
             initialDelaySeconds: DELAY
             timeoutSeconds: TIMEOUT
             failureThreshold: THRESHOLD
             periodSeconds: PERIOD

   取代：

   • SERVICE 改為您的 Cloud Run 服務名稱。
   • IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • (選用) GRPC_SERVICE。如果已設定，系統會在呼叫 grpc.health.v1.Health.Check RPC 時，將這個值用於 grpc.health.v1.HealthCheckRequest 的服務欄位。
   • (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
   • (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
   • (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
   • (選用) TIMEOUT 是探測作業逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。
   • (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定的值應介於 1 秒到 240 秒之間。預設值為 10 秒。
3. 使用下列指令建立或更新服務：

   gcloud run services replace service.yaml

Terraform

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

TCP 啟動

使用 startup_probe 屬性設定 Cloud Run 服務，如下所示：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-healthcheck"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      startup_probe {
        failure_threshold     = 5
        initial_delay_seconds = 10
        timeout_seconds       = 3
        period_seconds        = 3

        tcp_socket {
          port = 8080
        }
      }
    }
  }
}

HTTP 啟動

請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

使用 startup_probe 屬性設定 Cloud Run 服務，如下所示：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-healthcheck"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      startup_probe {
        failure_threshold     = 5
        initial_delay_seconds = 10
        timeout_seconds       = 3
        period_seconds        = 3

        http_get {
          path = "/"
          # Custom headers to set in the request
          # https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloud_run_v2_service#http_headers
          http_headers {
            name  = "Access-Control-Allow-Origin"
            value = "*"
          }
        }
      }
    }
  }
}

啟動 gRPC

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

使用 startup_probe 屬性設定 Cloud Run 服務，如下所示：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-healthcheck"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      # Note: Change to the name of your image
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      startup_probe {
        failure_threshold     = 5
        initial_delay_seconds = 10
        timeout_seconds       = 3
        period_seconds        = 3

        grpc {
          # Note: Change to the name of your pre-existing grpc health status service
          service = "grpc.health.v1.Health"
        }
      }
    }
  }
}

預設 TCP 啟動探測

如果您未明確為新的 Cloud Run 服務設定 TCP 啟動探測，Cloud Run 會自動設定 TCP 啟動探測，並採用下列預設值：

startupProbe:
          timeoutSeconds: 240
          periodSeconds: 240
          failureThreshold: 1

如要變更這些預設值，請按照本頁「探測器設定」一節的說明操作。

啟動探測規定和行為

探針類型	需求條件	行為
TCP 啟動	無	根據預設，Cloud Run 會建立 TCP 連線，在指定通訊埠開啟 TCP Socket。如果 Cloud Run 無法建立連線，表示啟動探針失敗。 如果啟動探針在指定時間 (failureThreshold * periodSeconds) 內未成功，且時間超過 240 秒，系統就會關閉容器。另請參閱「TCP 預設值」。
HTTP 啟動	建立 HTTP 健康狀態檢查端點 使用 HTTP/1	設定探測器後，Cloud Run 會向服務健康狀態檢查端點 (例如 /ready) 發出 HTTP GET 要求。任何 2XX 或 3XX 回應都表示成功，其他則表示失敗。 如果啟動探測器未在指定時間 (failureThreshold * periodSeconds) 內成功，且時間超過 240 秒，系統就會關閉容器。 如果 HTTP 啟動探測器在指定時間內成功，且您已設定 HTTP 執行中探測器，系統就會啟動 HTTP 執行中探測器。
啟動 gRPC	在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定	如果啟動探測在指定時間 (failureThreshold * periodSeconds) 內失敗 (不得超過 240 秒)，系統會關閉容器。

設定 liveness 探測

您可以使用 Google Cloud 控制台、YAML 或 Terraform 設定 HTTP 和 gRPC 探針：

控制台

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探查，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

1. 前往 Google Cloud 控制台的「Cloud Run」頁面：

   前往 Cloud Run

2. 如果是新服務，請展開「容器、磁碟區、網路與安全性」，顯示健康狀態檢查選項。如果是現有服務，請按一下要設定的服務，然後按一下「編輯並部署」，顯示健康狀態檢查選項。

3. 在「Container(s)」(容器) 部分中，前往「Health checks」(健康狀態檢查)，然後按一下「Add health check」(新增健康狀態檢查)，開啟「Add health check」(新增健康狀態檢查)設定面板。

4. 在「Select health check type」(選取健康狀態檢查類型) 選單中，選取要新增的健康狀態檢查類型。

5. 在「選取探測類型」選單中，選取要使用的探測類型，例如 HTTP 或 gRPC。系統會顯示探針設定表單。

6. 請注意，探針設定會因探針類型而異。設定探針：

   • 如果您使用 HTTP 探測：

     • 請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

     • 使用「路徑」欄位指定端點的相對路徑，例如 /。

     • 選取「HTTP 標頭」核取方塊，指定選用的自訂標頭。 在「名稱」欄位中指定標頭名稱，並在「值」欄位中指定標頭值。按一下「新增 HTTP 標頭」，指定更多標頭。

   • 如果您使用 gRPC 探針，請確保容器映像檔實作 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

   • 在「Port」(通訊埠) 部分，指定服務使用的容器通訊埠。

   • 在「初始延遲」中，指定容器啟動後，要等待多少秒才執行第一次探測。請指定介於 0 秒到 240 秒之間的值。預設值為 0 秒。

   • 在「Period」(週期) 中，指定執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。指定介於 1 秒到 240 秒之間的值。預設值為 10 秒。

   • 在「失敗門檻」中，指定關閉容器前要重試探測的次數。預設值為 3。

   • 在「Timeout」(逾時) 欄位中，指定探測逾時前的等待秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 240 之間的值。預設值是 1。

7. 按一下「新增」即可新增門檻

gcloud

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

HTTP 存活度

執行下列指令：

  gcloud run deploy SERVICE \
      --image=IMAGE_URL \
      --liveness-probe httpGet.path=PATH,httpGet.port=CONTAINER_PORT,initialDelaySeconds=DELAY,failureThreshold=THRESHOLD,timeoutSeconds=TIMEOUT,periodSeconds=PERIOD

取代：

• SERVICE 改為您的 Cloud Run 服務名稱。
• IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
• PATH，並將 HTTP 端點的相對路徑加進去，例如 /ready。
• (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
• (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
• (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
• (選用) TIMEOUT，等待探測作業逾時的秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 3600 之間的值。預設值為 1。
• (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。請指定介於 1 秒到 3600 秒之間的值。預設值為 10 秒。

gRPC 存活度

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

執行下列指令：

  gcloud run deploy SERVICE \
      --image=IMAGE_URL \
      --liveness-probe grpc.port=CONTAINER_PORT,grpc.service=GRPC_SERVICE,initialDelaySeconds=DELAY,failureThreshold=THRESHOLD,timeoutSeconds=TIMEOUT,periodSeconds=PERIOD

取代：

• SERVICE 改為您的 Cloud Run 服務名稱。
• IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
• (選用) GRPC_SERVICE。如果已設定，系統會在呼叫 grpc.health.v1.Health.Check RPC 時，將這個值用於 grpc.health.v1.HealthCheckRequest 的服務欄位。
• (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
• (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
• (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
• (選用) TIMEOUT，等待探測作業逾時的秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 3600 之間的值。預設值為 1。
• (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。請指定介於 1 秒到 3600 秒之間的值。預設值為 10 秒。

YAML

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

HTTP 存活度

1. 如要建立新服務，請略過這個步驟。如要更新現有服務，請下載其 YAML 設定：

   gcloud run services describe SERVICE --format export > service.yaml

2. 請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

3. 如圖所示設定 livenessProbe 屬性：

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: SERVICE
   spec:
     template:
       metadata:
       spec:
         containers:
         - image: IMAGE_URL
           livenessProbe:
             httpGet:
               path: PATH
               port: CONTAINER_PORT
               httpHeaders:
                 - name: HEADER_NAME
                   value: HEADER_VALUE
             initialDelaySeconds: DELAY
             timeoutSeconds: TIMEOUT
             failureThreshold: THRESHOLD
             periodSeconds: PERIOD

   取代：

   • SERVICE 改為您的 Cloud Run 服務名稱。
   • IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • PATH，並將 HTTP 端點的相對路徑加進去，例如 /ready。
   • (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
   • (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
   • (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
   • (選用) httpHeaders 可用於使用 HEADER_NAME 和 HEADER_VALUE 欄位提供多個或重複的自訂標頭，如下所示。
   • (選用) TIMEOUT，等待探測作業逾時的秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 3600 之間的值。預設值為 1。
   • (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。請指定介於 1 秒到 3600 秒之間的值。預設值為 10 秒。
4. 使用下列指令建立或更新服務：

   gcloud run services replace service.yaml

gRPC 存活度

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

1. 如要建立新服務，請略過這個步驟。如要更新現有服務，請下載其 YAML 設定：

   gcloud run services describe SERVICE --format export > service.yaml

2. 如圖所示設定 livenessProbe 屬性：

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: SERVICE
   spec:
     template:
       metadata:
       spec:
         containers:
         - image: IMAGE_URL
           livenessProbe:
             grpc:
               port: CONTAINER_PORT
               service: GRPC_SERVICE
             initialDelaySeconds: DELAY
             timeoutSeconds: TIMEOUT
             failureThreshold: THRESHOLD
             periodSeconds: PERIOD

   取代

   • SERVICE 改為您的 Cloud Run 服務名稱。
   • IMAGE_URL 參照容器映像檔，例如： us-docker.pkg.dev/cloudrun/container/hello:latest。如果您使用 Artifact Registry，則必須先建立存放區 REPO_NAME。網址的格式為 LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • (選用) GRPC_SERVICE。如果已設定，系統會在呼叫 grpc.health.v1.Health.Check RPC 時，將這個值用於 grpc.health.v1.HealthCheckRequest 的服務欄位。
   • (選用) CONTAINER_PORT 應設為服務使用的容器通訊埠。
   • (選用) DELAY，代表容器啟動後，要過多久才執行第一次探測。請指定 0 秒到 240 秒之間的值。預設值為 0 秒。
   • (選用) THRESHOLD，指定在關閉容器前重新嘗試探測的次數。預設值為 3。
   • (選用) TIMEOUT，等待探測作業逾時的秒數。這個值不得超過為 periodSeconds 指定的值。請指定介於 1 到 3600 之間的值。預設值為 1。
   • (選用) PERIOD，其中包含執行探查的週期 (以秒為單位)。例如 2，每 2 秒執行一次探查。請指定介於 1 秒到 3600 秒之間的值。預設值為 10 秒。

3. 使用下列指令建立或更新服務：

   gcloud run services replace service.yaml

Terraform

如果您要為 HTTP 探測設定 Cloud Run 服務，請務必在服務程式碼中新增端點，以回應探測。如要設定 gRPC 探針，您必須在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定。

如要瞭解如何套用或移除 Terraform 設定，請參閱「基本 Terraform 指令」。

HTTP 存活度

請確認服務使用 HTTP/1 (Cloud Run 預設值)，而非 HTTP/2。

使用 liveness_probe 屬性設定 Cloud Run 服務，如下所示：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-healthcheck"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      liveness_probe {
        failure_threshold     = 5
        initial_delay_seconds = 10
        timeout_seconds       = 3
        period_seconds        = 3

        http_get {
          path = "/"
          # Custom headers to set in the request
          # https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/cloud_run_v2_service#http_headers
          http_headers {
            name  = "Access-Control-Allow-Origin"
            value = "*"
          }
        }
      }
    }
  }
}

gRPC 存活度

使用 gRPC 探針前，請確認容器映像檔實作了 gRPC 健康狀態檢查通訊協定。詳情請參閱 GRPC 健康狀態檢查通訊協定。

使用 liveness_probe 屬性設定 Cloud Run 服務，如下所示：

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-healthcheck"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      # Note: Change to the name of your image
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      liveness_probe {
        failure_threshold     = 5
        initial_delay_seconds = 10
        timeout_seconds       = 3
        period_seconds        = 3

        # Note: Change to the name of your pre-existing grpc health status service
        grpc {
          service = "grpc.health.v1.Health"
        }
      }
    }
  }
}

有效性探測需求條件和行為

探針類型	需求條件	行為
HTTP 存活度	建立 HTTP 健康狀態檢查端點 使用 HTTP/1	只有在啟動探測作業成功後，系統才會啟動即時性探測作業。完成探測設定並成功執行啟動探測後，Cloud Run 會向服務健康狀態檢查端點 (例如 /health) 發出 HTTP GET 要求。任何 2XX 或 3XX 回應都表示成功，其他則表示失敗。 如果存活探測在指定時間 (failureThreshold * periodSeconds) 內未成功，系統會使用 SIGKILL 信號關閉容器。容器仍在處理的任何剩餘要求，都會以 HTTP 狀態碼 503 終止。容器關閉後，Cloud Run 自動調度功能會啟動新的容器執行個體。
gRPC 存活度	在 Cloud Run 服務中實作 gRPC 健康狀態檢查通訊協定	如果設定 gRPC 啟動探測，只有在啟動探測成功後，存活探測才會開始。 設定存活探測後，只要啟動探測成功，Cloud Run 就會向服務發出健康狀態檢查要求。 如果存活探測在指定時間 (failureThreshold * periodSeconds) 內未成功，系統會使用 SIGKILL 信號關閉容器。容器關閉後，Cloud Run 自動調度功能會啟動新的容器執行個體。

建立 HTTP 健康狀態檢查端點

如果為 Cloud Run 服務設定 HTTP 啟動探測，您需要在服務程式碼中新增端點，以回應探測。端點可以有任何名稱，例如 /startup 或 /ready，但必須與探查設定中為 path 指定的值相符，如下所示：

startupProbe:
    httpGet:
      path: /ready

如果您使用 /health 等路徑，為 Cloud Run 服務設定 HTTP 存活探測器，請在探測器設定中定義該路徑，如下所示：

livenessProbe:
    httpGet:
      path: /health

HTTP 健康檢查端點可從外部存取，並遵循與其他外部公開 HTTP 服務端點相同的原則。

CPU 分配方式

• 探測器執行時，系統一律會分配 CPU。
• 所有探查都會依據 CPU 和記憶體用量計費，但不會收取要求費用。