ftw.slacker 1.1.0

设置Slack webhook

首先，您需要设置一个Slack webhook。

阅读Slack关于入站webhooks的文档，并按照入站webhook集成的说明开始设置您自己的webhook。

向Slack发送消息

只需导入notify_slack API函数并调用它。

from ftw.slacker import notify_slack

notify_slack('https://hooks.slack.com/services/xxx',
             text="my first post")

完成！

配置requests模块

以下属性被传递给requests模块

• webhook_url

• timeout

• verify

这意味着，您可以使用这些参数调用API函数来配置请求

from ftw.slacker import notify_slack

notify_slack(webhook_url='https://hooks.slack.com/services/xxx',
             timemout=10,
             verify=False,
             text="my first post")

Slack有效载荷

只需向API函数添加额外的关键字参数。所有参数都将作为有效载荷传递到Slack webhook。

from ftw.slacker import notify_slack

notify_slack('https://hooks.slack.com/services/xxx',
             text="my first post",
             attachments=[
                 {
                     "title": "Slack API Documentation",
                     "title_link": "https://api.slack.com/",
                     "text": "Optional text that appears within the attachment"
                 }
             ])

覆盖环境变量

如果您设置了 STANDARD_SLACK_WEBHOOK 环境变量，您仍然可以使用不同的 Slack webhook。

export STANDARD_SLACK_WEBHOOK='https://hooks.slack.com/services/default-channel-id'

from ftw.slacker import notify_slack

# Post message to service default-channel-id
notify_slack(text="my first post")

# Post message to service specific-channel-id
notify_slack('https://hooks.slack.com/services/specific-channel-id',
             text="my first post")

黑名单

现在，您在同一服务器上安装了一个测试部署，您想在其中禁用通知。

为此，您可以在该特定部署的 builodut.cfg 中设置另一个环境变量到值： deactivate。（请参阅静态变量 NOTIFICATION_DEACTIVATION_VALUE）

[instance]
environment-vars +=
    DEACTIVATE_SLACK_NOTIFICATION deactivate

此部署执行的所有通知都将被跳过。

白名单

您甚至可以对您的部署进行白名单。

export STANDARD_SLACK_WEBHOOK='https://hooks.slack.com/services/xxx'
export DEACTIVATE_SLACK_NOTIFICATION deactivate

并且对于所有白名单部署，使用以下 buildout 配置

[instance]
environment-vars +=
    DEACTIVATE_SLACK_NOTIFICATION

这将重置 DEACTIVATE_SLACK_NOTIFICATION 变量到 ''

通过webhook_url禁用

您也可以仅禁用特定的通知。

假设，您已设置了 STANDARD_SLACK_WEBHOOK。我们了解到，您可以在没有 webhook_url 的情况下调用 notify_slack 以将通知推送到标准 webhook url，或者您可以调用它并带有更具体的 webhook url notify_slack(webhook_url="xxx") 以覆盖标准 Slack webhook。

使用 NOTIFICATION_DEACTIVATION_VALUE 作为 webhook_url 仅会禁用当前通知，而不会冒泡到标准 Slack webhook。

此功能对于处理来自多个外部模块的 slacker-integration 通知非常有用。

有关高级使用的更多信息，请参阅下一章。