Freight通知系统完整清单Slack、Datadog、Sentry与Webhook的6种集成【免费下载链接】freightFreight is a service which aims to make application deployments better.项目地址: https://gitcode.com/gh_mirrors/fr/freightFreight 通知系统内置6 种部署通知集成Slack、Webhook、Datadog、Sentry、GitHub 状态检查和 Dummy空实现。当一次部署被排队、开始或结束时Freight 会自动向这些渠道推送消息让你的团队第一时间知道部署进度——无需自己写轮询脚本。本文是面向新手的完整清单讲清每种集成的触发时机、必配参数和适用场景帮你快速选对渠道。通知什么时候触发3 类部署事件Freight 用 3 个事件驱动所有通知定义在 freight/notifiers/base.py事件常量含义部署排队TASK_QUEUED(0)有人发起部署任务进入队列部署开始TASK_STARTED(1)部署命令真正执行部署结束TASK_FINISHED(2)成功、失败或取消都会触发默认情况下每个通知器会响应全部 3 类事件见Notifier.DEFAULT_EVENTS。部分集成会按需筛选事件下面逐个说明。6 种内置通知集成清单 所有通知器在 freight/notifiers/init.py 中注册到NotifierManager配置时通过type字段引用。1. Slack 通知部署进度直达团队频道类型名slack源码freight/notifiers/slack.py必配项webhook_urlSlack Incoming Webhook 地址触发事件排队 / 开始 / 结束全量触发消息内容一条带链接的标题文本例如[myapp/prod] alice 开始部署 #42 (a1b2c3d)点击即可跳转部署详情页适合把部署动态同步到 Slack 频道是新手最常用的第一个集成。2. Webhook 通知对接任意自研系统类型名webhook源码freight/notifiers/webhook.py必配项url可选项headers自定义请求头可用于鉴权触发事件全量触发推送内容一个信息最全的 JSON 载荷包含app_name、deploy_number、environment、sha、previous_sha、status、duration、date_started、date_finished、link、user等字段需要把部署数据写进自家监控系统或审批流时Webhook 是最通用的选择。3. Datadog 通知部署事件进入 APM 时间线类型名datadog源码freight/notifiers/datadog.py必配项webhook_urlDatadog 事件 API 地址触发事件只发送「开始」和「成功结束」两种事件失败不打扰推送内容事件标题 一组tags如freight_app、freight_sha、freight_deploy_status方便在 Datadog 里按应用、版本精确检索适合把部署事件和错误监控串起来部署后报错一眼定位是不是这次发布引入的。4. Sentry 通知部署即「Release」追踪类型名sentry源码freight/notifiers/sentry.py必配项webhook_url触发事件只发送「开始」和「成功结束」对应event: started / finished推送内容包含app_name、env、ref、sha、duration、dateStarted、dateReleased和部署页linkFreight 深受 Sentry 团队启发这对组合能让你在 Sentry 里按 Release 聚合错误精确到每次部署。5. GitHub 状态检查Commit 上直接看部署结果类型名github源码freight/notifiers/github.py必配项repo形如owner/repo可选项api_root自建 GitHub 服务地址前置条件服务端需配置GITHUB_TOKEN否则会报GITHUB_TOKEN is not set效果在该 Commit 的状态检查区写入一条continuous-integration/freight/deploy状态随事件变化部署状态Commit 状态排队 / 开始pending成功success失败failure取消error配合分支保护规则可以让「部署成功」成为合并/发布的硬性条件。6. Dummy 通知联调与压测的占位符类型名dummy源码freight/notifiers/dummy.py配置项无行为静默丢弃所有通知写配置、跑流程、验证队列时用它占位不会产生任何外部请求。通知器配置怎么写在部署请求或应用配置里notifiers是一个数组每项包含type和config例如{ notifiers: [ { type: slack, config: { webhook_url: YOUR_SLACK_WEBHOOK } }, { type: webhook, config: { url: YOUR_INTERNAL_API, headers: { X-Token: YOUR_TOKEN } } }, { type: datadog, config: { webhook_url: YOUR_DATADOG_URL } }, { type: sentry, config: { webhook_url: YOUR_SENTRY_URL } }, { type: github, config: { repo: your-org/your-repo } } ] }配置会经过 freight/notifiers/utils.py 中的parse_notifiers_config校验类型名写错 →Invalid notifier: xxx缺必填项如 Slack 没填webhook_url→Missing required option webhook_url for notifier: slack校验规则来自每个通知器的get_options()其中标记required: True的字段不可省略。5 秒防抖队列通知如何被发出通知并非全部同步发送。看 freight/notifiers/utils.py 的send_task_notifications逻辑结束事件立即发送结果最重要不容延迟排队 / 开始事件写入 Redis 防抖队列 freight/notifiers/queue.py默认5000ms延迟延迟发送的好处同一任务短时间内的同类事件会被去重避免「排队」和「开始」两条消息几乎同时刷屏。后台任务 freight/jobs/send_pending_notifications.py 负责从队列取出到期通知并真正发出发送失败只记录日志、不会中断部署主流程。快速上手三步启用你的第一个通知 克隆仓库并了解目录结构核心都在freight/notifiers/下git clone https://gitcode.com/gh_mirrors/fr/freight选择渠道团队用 Slack 就配slack要接监控系统优先webhook用 Sentry 查错的直接加sentry。发起一次部署部署详情页会显示对应通知器配置部署开始后到频道/系统里确认收到第一条消息。常见问题 FAQQ1为什么配置了 Datadog 却收不到失败通知这是设计行为DatadogNotifier和SentryNotifier都覆写了should_send_deploy只上报「开始」与「成功结束」。失败/取消请依赖 Slack 或 Webhook 渠道。Q2一个部署能同时用多个通知器吗可以。notifiers是数组Slack Sentry Webhook 任意组合各自独立发送、独立容错。Q3想自定义一个通知渠道比如钉钉、企业微信继承 freight/notifiers/base.py 的Notifier类实现get_options()与send_deploy()再在注册处manager.add(name, 你的类)即可。测试参考 tests/notifiers/ 下的现成用例。Q4GitHub 通知一直报 token 错误服务端环境变量GITHUB_TOKEN未设置配置好并重启服务即可。小结集成必配项触发事件一句话定位Slackwebhook_url全部团队频道播报Webhookurl全部对接自研系统Datadogwebhook_url开始成功APM 事件时间线Sentrywebhook_url开始成功Release 追踪GitHubrepo全部Commit 状态检查Dummy无全部联调占位按需组合这 6 种集成Freight 就能把每一次部署的「排队 → 开始 → 结束」完整地推送到你的团队工作流里。【免费下载链接】freightFreight is a service which aims to make application deployments better.项目地址: https://gitcode.com/gh_mirrors/fr/freight创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考