設定電子郵件通知

Vertex AI Pipelines 可在管道執行成功或失敗時通知您。管道結束時， Google Cloud 會將最終狀態通知電子郵件傳送至您指定的電子郵件地址。

本指南說明如何使用 Google Cloud SDK 中的電子郵件通知元件，設定管道的電子郵件通知。

注意：Google 最多會保留您傳送通知的電子郵件地址 14 天，以利進行偵錯，並保留 30 天以利進行分析。

事前準備

在建構傳送通知的管道前，請按照下列操作說明設定 Google Cloud 專案和開發環境。

1. 如要準備好 Google Cloud 專案，以便執行 ML pipeline，請按照設定Google Cloud 專案指南中的操作說明進行。

2. 安裝 Kubeflow Pipelines SDK 第 2 版或更新版本。

   pip install --upgrade "kfp>=2,<3"
   

注意： 如要升級至最新版 Kubeflow Pipelines SDK，請執行下列指令：
pip install kfp --upgrade
如有更新版本，執行這項指令會解除安裝 KFP，並安裝最新版本。\

1. 如要在管道中使用 Vertex AI Python 用戶端，請安裝 Vertex AI 用戶端程式庫 1.7 以上版本。

2. 如要在 pipeline 中使用 Vertex AI 服務，請安裝Google Cloud Pipeline 元件。

從管道傳送通知

以下範例說明如何定義電子郵件通知工作 (notify_email_task)，並將其新增至管道的結束處理常式 (dsl.ExitHandler)，藉此設定電子郵件通知。管道結束時，這項通知工作會叫用電子郵件通知元件中的 VertexNotificationEmailOp 運算子。

from kfp import dsl
from kfp import compiler
from google_cloud_pipeline_components.v1.vertex_notification_email import VertexNotificationEmailOp

@dsl.pipeline(
    name='PIPELINE_NAME',
    pipeline_root=PIPELINE_ROOT_PATH,
)
def TASK_NAME():
    notify_email_task = VertexNotificationEmailOp(recipients=RECIPIENTS_LIST)

    with dsl.ExitHandler(notify_email_task):
        # Add your pipeline tasks here.

compiler.Compiler().compile(pipeline_func=notification_email_pipeline,
        package_path='notification_email_pipeline.yaml')

更改下列內容：

• PIPELINE_NAME：管道的名稱。

• PIPELINE_ROOT_PATH：指定管道服務帳戶可存取的 Cloud Storage URI。管道執行作業的構件會儲存在管道根目錄中。

  管道根目錄可以設為管道函式 @kfp.dsl.pipeline 註解的引數，也可以在呼叫 create_run_from_job_spec 建立管道執行時設定。

• TASK_NAME：您要為其設定電子郵件通知的管道工作名稱。

• RECIPIENTS_LIST：以半形逗號分隔的電子郵件地址清單 (最多三個)，用來接收通知電子郵件。

在 dsl.ExitHandler 結束處理常式函式的主體中新增管道工作。以這種方式將工作包裝在結束處理常式函式中，可指定管道結束時，通知電子郵件元件應回報這些工作的狀態。舉例來說，如果結束處理常式內容中的工作失敗，通知就會將狀態回報為失敗。

通知電子郵件範例

如果您使用「從管道傳送通知」中的程式碼範例，為管道設定電子郵件通知，當管道結束時，Vertex AI 會傳送類似下方的電子郵件通知：

主旨：Vertex Pipelines 工作「PIPELINE_NAME」的任務「TASK_NAME」
寄件者：Google Notifications <[e-mail]>

Vertex AI 客戶您好：

Vertex AI Pipelines 工作「PIPELINE_NAME」的任務「TASK_NAME」已結束，狀態為：{status}。

其他詳細資料：
- 專案：{project}
- 管道名稱：PIPELINE_NAME
- 管道工作 ID：{pipeline_job_id}
- 開始時間：{start_time}

如要在 Cloud 控制台中查看這項管道工作，請使用下列連結：{console_link}

祝一切順利！
Google Cloud AI 團隊

在這個例子中：

• {status} 代表任務的最終狀態，可以是 SUCCEEDED、FAILED 或 CANCELLED。
• {project} 是專案名稱。
• {pipeline_job_id} 是專屬的管道工作 ID。
• {start_time} 代表管道的開始時間。
• {console_link} 是 Google Cloud 控制台中管道工作的超連結。