inloopx/nsq-transport

nsq-transport镜像说明

镜像概述

nsq-transport是一款NSQ消息队列的消费者工具，旨在将NSQ中的消息转发至多种目标平台，目前已支持Slack和SMTP，后续将添加NSQ目标支持。

核心功能

• 支持NSQ消息消费并转发至Slack、SMTP目标
• 通过Golang模板实现消息过滤（仅处理符合条件的消息）
• 支持模板化配置消息内容（如邮件主题、Slack文本）
• 允许通过环境变量传递所有配置参数

使用场景

• 系统事件通知自动转发至Slack频道
• NSQ消息触发的业务事件发送邮件通知
• 过滤特定类型消息后定向转发至指定目标

配置说明

NSQ消费者全局配置

Slack转发配置

使用slack命令时的参数：

• --channel：Slack目标频道（模板化字符串） | SLACK_CHANNEL
• --webhook：Slack Webhook URL | SLACK_URL
• --text：Slack消息文本（模板化字符串） | SLACK_TEXT
• --username：消息发送者用户名（模板化字符串） | SLACK_USERNAME

SMTP转发配置

使用smtp命令时的参数：

• --url：SMTP服务器连接URL | SMTP_URL
• --sender：默认发送者 | SMTP_SENDER
• --from：邮件发送者（模板化字符串） | SMTP_FROM
• --to：邮件接收者（模板化字符串） | SMTP_TO
• --subject：邮件主题（模板化字符串） | SMTP_SUBJECT
• --body-text：纯文本邮件内容（模板化字符串） | SMTP_BODY_TEXT
• --body-html：HTML邮件内容（模板化字符串） | SMTP_BODY_HTML

模板使用说明

标记为“模板化字符串”的参数支持Golang模板语法，使用[[和]]作为分隔符。若消息体为JSON格式，可通过模板访问其中字段。示例：

• 消息内容：{"hello":"world"}
• 模板："Greetings from template [[.hello]]"
• 结果："Greetings from template world"

Docker部署示例

SMTP转发示例

bash
docker run --rm inloopx/nsq-transport -t some-topic -c my-smtp-transporter --lookup hostname:4161 smtp --sender *** --body-text "Hello, new message was just created" --body-html "test [[.entity]]" --to *** --subject "transport test" --url smtp://user:pass@hostname