airflow.providers.opsgenie.operators.opsgenie

OpsgenieCreateAlertOperator

该操作符允许您向 Opsgenie 发布警报。

OpsgenieCloseAlertOperator

该操作符允许您关闭 Opsgenie 中的警报。

OpsgenieDeleteAlertOperator

该操作符允许您删除 Opsgenie 中的警报。

模块内容

class airflow.providers.opsgenie.operators.opsgenie.OpsgenieCreateAlertOperator(*, message, opsgenie_conn_id='opsgenie_default', alias=None, description=None, responders=None, visible_to=None, actions=None, tags=None, details=None, entity=None, source=None, priority=None, user=None, note=None, **kwargs)[源代码]

基类: airflow.models.BaseOperator

该操作符允许您向 Opsgenie 发布警报。

接受一个连接,该连接的密码作为 Opsgenie API 密钥。该操作符将域名设置为 conn_id.host,如果未设置,则默认为 https://api.opsgenie.com

每个 Opsgenie API 密钥都可以预先配置到团队集成中。您可以在此操作符中覆盖这些默认值。

另请参阅

有关如何使用此操作符的更多信息,请参阅指南: OpsgenieCreateAlertOperator

参数:
  • opsgenie_conn_id (str) – 要使用的 Opsgenie 连接名称

  • message (str) – Opsgenie 警报的消息(模板化)

  • alias (str | None) – 警报的客户端定义标识符(模板化)

  • description (str | None) – 警报的描述字段(模板化)

  • responders (list[dict] | None) – 警报将被路由到发送通知的团队、用户、升级策略和日程表。

  • visible_to (list[dict] | None) – 警报对哪些团队和用户可见而无需发送任何通知。

  • actions (list[str] | None) – 警报可用的自定义操作。

  • tags (list[str] | None) – 警报的标签。

  • details (dict | None) – 用作警报自定义属性的键值对映射。

  • entity (str | None) – 警报的实体字段,通常用于指定警报与哪个域相关。(模板化)

  • source (str | None) – 警报的来源字段。默认值为传入请求的 IP 地址。

  • priority (str | None) – 警报的优先级。默认值为 P3。(模板化)

  • user (str | None) – 请求所有者的显示名称。

  • note (str | None) – 创建警报时将添加的附加备注。(模板化)

template_fields: collections.abc.Sequence[str] = ('message', 'alias', 'description', 'entity', 'priority', 'note')[源代码]
message[源代码]
opsgenie_conn_id = 'opsgenie_default'[源代码]
alias = None[源代码]
description = None[源代码]
responders = None[源代码]
visible_to = None[源代码]
actions = None[源代码]
tags = None[源代码]
details = None[源代码]
entity = None[源代码]
source = None[源代码]
priority = None[源代码]
user = None[源代码]
note = None[源代码]
hook: airflow.providers.opsgenie.hooks.opsgenie.OpsgenieAlertHook | None = None[源代码]
execute(context)[源代码]

调用 OpsgenieAlertHook 发布消息。

class airflow.providers.opsgenie.operators.opsgenie.OpsgenieCloseAlertOperator(*, identifier, opsgenie_conn_id='opsgenie_default', identifier_type=None, user=None, note=None, source=None, close_alert_kwargs=None, **kwargs)[源代码]

基类: airflow.models.BaseOperator

该操作符允许您关闭 Opsgenie 中的警报。

接受一个连接,该连接的密码作为 Opsgenie API 密钥。该操作符将域名设置为 conn_id.host,如果未设置,则默认为 https://api.opsgenie.com

每个 Opsgenie API 密钥都可以预先配置到团队集成中。您可以在此操作符中覆盖这些默认值。

另请参阅

有关如何使用此操作符的更多信息,请参阅指南: OpsgenieCloseAlertOperator

参数:
  • opsgenie_conn_id (str) – 要使用的 Opsgenie 连接名称

  • identifier (str) – 警报的标识符,可以是警报 ID、tiny ID 或警报别名

  • identifier_type (str | None) – 作为内联参数提供的标识符类型。可能的值有 ‘id’、‘alias’ 或 ‘tiny’

  • user (str | None) – 请求所有者的显示名称

  • note (str | None) – 创建警报时将添加的附加备注

  • source (str | None) – 警报的来源字段。默认值为传入请求的 IP 地址

  • close_alert_kwargs (dict | None) – 要传递的其他参数

opsgenie_conn_id = 'opsgenie_default'[源代码]
identifier[源代码]
identifier_type = None[源代码]
user = None[源代码]
note = None[源代码]
source = None[源代码]
close_alert_kwargs = None[源代码]
hook: airflow.providers.opsgenie.hooks.opsgenie.OpsgenieAlertHook | None = None[源代码]
execute(context)[源代码]

调用 OpsgenieAlertHook 关闭警报。

class airflow.providers.opsgenie.operators.opsgenie.OpsgenieDeleteAlertOperator(*, identifier, opsgenie_conn_id='opsgenie_default', identifier_type=None, user=None, source=None, **kwargs)[源代码]

基类: airflow.models.BaseOperator

该操作符允许您删除 Opsgenie 中的警报。

接受一个连接,该连接的密码作为 Opsgenie API 密钥。该操作符将域名设置为 conn_id.host,如果未设置,则默认为 https://api.opsgenie.com

每个 Opsgenie API 密钥都可以预先配置到团队集成中。您可以在此操作符中覆盖这些默认值。

另请参阅

有关如何使用此操作符的更多信息,请参阅指南: OpsgenieDeleteAlertOperator

参数:
  • opsgenie_conn_id (str) – 要使用的 Opsgenie 连接名称

  • identifier (str) – 警报的标识符,可以是警报 ID、tiny ID 或警报别名

  • identifier_type (str | None) – 作为内联参数提供的标识符类型。可能的值有 ‘id’、‘alias’ 或 ‘tiny’

  • user (str | None) – 请求所有者的显示名称

  • source (str | None) – 请求来源的显示名称

template_fields: collections.abc.Sequence[str] = ('identifier',)[源代码]
opsgenie_conn_id = 'opsgenie_default'[源代码]
identifier[源代码]
identifier_type = None[源代码]
user = None[源代码]
source = None[源代码]
execute(context)[源代码]

调用 OpsgenieAlertHook 删除警报。

本条目是否有帮助?