`airflow.providers.pagerduty.hooks.pagerduty_events`¶

用於從 PagerDuty 發送或接收資料以及創建 PagerDuty 事件的 Hook。

模組內容¶

類別¶

PagerdutyEventsHook

此類別可用於與 Pagerduty Events API 互動。

class airflow.providers.pagerduty.hooks.pagerduty_events.PagerdutyEventsHook(integration_key=None, pagerduty_events_conn_id=None)[原始碼]¶

繼承自： airflow.hooks.base.BaseHook

此類別可用於與 Pagerduty Events API 互動。

它接受 Events API 令牌和具有 Events API 令牌的 PagerDuty 連線: （即整合金鑰）作為密碼/Pagerduty API 令牌。如果兩者都提供，將使用該令牌。

參數

integration_key (str | None) – PagerDuty Events API 令牌
pagerduty_events_conn_id (str | None) – 在 Pagerduty API 令牌欄位中具有 PagerDuty 整合金鑰的連線

conn_name_attr = 'pagerduty_events_conn_id'[原始碼]¶

default_conn_name = 'pagerduty_events_default'[原始碼]¶

conn_type = 'pagerduty_events'[原始碼]¶

hook_name = 'Pagerduty Events'[原始碼]¶

classmethod get_ui_field_behaviour()[原始碼]¶

返回自訂欄位行為。

send_event(summary, severity, source=airflow', action='trigger', dedup_key=None, custom_details=None, group=None, component=None, class_type=None, images=None, links=None)[原始碼]¶

為服務整合創建事件。

參數

summary (str) – 事件摘要
severity (str) – 事件嚴重性，需要是以下之一：info、warning、error、critical
source (str) – 發生問題的系統的特定人類可讀的唯一識別符，例如主機名稱。
action (str) – 事件動作，需要是以下之一：trigger、acknowledge、resolve。如果未指定，則預設為 trigger。
dedup_key (str | None) – 一個識別為給定事件觸發警報的字串。acknowledge 和 resolve 動作是必需的。
custom_details (Any | None) – 來自事件的自由格式的詳細資訊。可以是字典或字串。如果傳遞字典，它將在 PagerDuty 中顯示為表格。
group (str | None) – 一個來源的叢集或分組。例如，來源 “prod-datapipe-02” 和 “prod-datapipe-03” 可能都屬於 “prod-datapipe” 的一部分
component (str | None) – 受影響系統中損壞的部分或組件。
class_type (str | None) – 事件的類別/類型。
images (list[Any] | None) – 要包含的圖片列表。列表中的每個字典都接受以下鍵：src：附加到事件的圖片的來源 (URL)。此圖片必須通過 HTTPS 提供。href：[選填] 使圖片成為可點擊連結的 URL。alt：[選填] 圖片的替代文字。
links (list[Any] | None) – 要包含的連結列表。列表中的每個字典都接受以下鍵：href：要附加的連結的 URL。text：[選填] 描述連結用途的純文字，並可用作連結的文字。

返回

PagerDuty Events API v2 回應。

返回類型

dict

static prepare_event_data(summary, severity, source, custom_details, component, group, class_type, action, dedup_key, images, links, action_key_name='action')[原始碼]¶

為 send_event / post(‘/v2/enqueue’) 方法準備事件資料。

create_change_event(summary, source='airflow', custom_details=None, timestamp=None, links=None)[原始碼]¶

為服務整合創建變更事件。

參數

summary (str) – 事件摘要
source (str) – 發生問題的系統的特定人類可讀的唯一識別符，例如主機名稱。
custom_details (Any | None) – 來自事件的自由格式的詳細資訊。可以是字典或字串。如果傳遞字典，它將在 PagerDuty 中顯示為表格。
timestamp (datetime.datetime | None) – 發射工具偵測或產生事件的時間。
links (list[Any] | None) – 要包含的連結列表。列表中的每個字典都接受以下鍵：href：要附加的連結的 URL。text：[選填] 描述連結用途的純文字，並可用作連結的文字。

返回

PagerDuty Change Events API v2 回應。

返回類型

dict

test_connection()[原始碼]¶

airflow.providers.pagerduty.hooks.pagerduty_events¶

模組內容¶

類別¶

`airflow.providers.pagerduty.hooks.pagerduty_events`¶