ftw.slacker 1.1.0

设置 Slack 网络钩子

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

阅读有关传入 Webhook的 Slack 文档，并按照传入的 webhook 集成开始设置您自己的 webhock 。

将消息发布到 Slack

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

from ftw.slacker import notify_slack

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

完毕！

配置请求模块

以下属性被传递给请求模块：

• webhook_url

• 暂停

• 核实

这意味着，您可以使用此参数调用 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")

松弛有效载荷

只需向 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")

黑名单

现在，您在要停用通知的同一台服务器上安装测试部署。

为此，您可以在此特定部署的buiodut.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

对于所有列入白名单的部署，请使用以下构建配置：

[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 处理来自多个外部模块的通知特别有用。

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