templum/rabbitmq-connector

OpenFaaS RabbitMQ Connector 中文技术文档

镜像概述和主要用途

OpenFaaS RabbitMQ Connector 是一个非官方的 OpenFaaS 触发器，基于 RabbitMQ 消息触发 OpenFaaS 函数。它通过 RabbitMQ 的 Routing keys 调用监听特定 topic 的 OpenFaaS 函数，实现从 RabbitMQ 消息到 OpenFaaS 函数的事件驱动触发。

核心功能和特性

• 基于 RabbitMQ 消息触发：通过 RabbitMQ 的 Routing keys 匹配函数监听的 topic，触发 OpenFaaS 函数执行
• 多主题支持：函数可通过注解指定多个监听主题（逗号分隔），如 log,monitoring,billing
• 错误处理机制：函数调用失败时，消息会尝试返回队列，需确保函数支持重复调用（幂等性）
• 即发即弃流程：仅支持“fire & forget”模式，函数返回结果会被忽略
• TLS 支持：可配置 TLS 连接 RabbitMQ，保障通信安全
• 灵活配置：支持主题映射刷新时间、请求超时、最大连接数等参数自定义

使用场景和适用范围

适用于需要通过 RabbitMQ 消息异步触发 OpenFaaS 函数的场景，例如：

• 日志处理：监听日志主题，触发函数进行日志分析或存储
• 监控告警：接收监控指标消息，触发函数生成告警通知
• 账单处理：消费账单事件消息，触发函数计算或生成账单
• 微服务事件驱动：作为微服务间事件通信的桥梁，通过 RabbitMQ 消息触发下游函数

使用方法

部署 OpenFaaS 函数

需通过 OpenFaaS CLI 或 REST API 部署函数，并添加 topic 注解，指定函数监听的主题（逗号分隔）。

示例：使用 OpenFaaS CLI 部署函数

1. 编写函数配置文件 stack.yml，添加 annotations 字段：

   yaml
   version: 1.0
   provider:
     name: openfaas
     gateway: http://gateway:8080
   functions:
     log-processor:
       image: your-registry/log-processor:latest
       annotations:
         topic: "log,monitoring"  # 监听 log 和 monitoring 主题
   

2. 部署函数：

   bash
   faas-cli deploy -f stack.yml
   

注意事项

• 幂等性要求：消息失败时会返回队列，函数需支持重复调用（避免重复处理同一消息）。
• 消息可靠性：建议参考 RabbitMQ 生产环境检查清单 和 监控指南，避免消息丢失。
• 结果忽略：函数返回结果不会被处理，仅关注调用是否成功。

配置说明

通用连接器配置

TLS 配置（RabbitMQ 连接）

注意：启用 TLS 时，RMQ_HOST 需与证书中的通用名称（Common Name）一致，否则连接会失败。

RabbitMQ 相关配置

拓扑配置（Exchange 定义）

需通过 YAML 文件定义 RabbitMQ 交换器（Exchange）配置，路径由 PATH_TO_TOPOLOGY 指定。配置格式如下：

yaml
# 交换器配置列表
- name: Exchange_Name  # 交换器名称（必填）
  topics: [Foo, Bar]   # 交换器关联的主题列表（必填）
  declare: true        # 是否声明交换器（若已存在，会验证配置是否匹配），默认：false
  type: "direct"       # 交换器类型（必填，仅支持 direct 或 topic）
  durable: false       # 交换器是否持久化（RabbitMQ 重启后保留），默认：false
  auto-deleted: false  # 所有消费者断开后是否自动删除交换器，默认：false

队列自动配置规则

• 队列名称：自动生成，格式为 OpenFaaS_{Exchange_Name}_{Topic}（如交换器 logs 的主题 error，队列名为 OpenFaaS_logs_error）。
• 持久化与自动删除：队列的 durable 和 auto-deleted 属性与所属交换器保持一致。

Docker 部署示例

docker run 命令

bash
docker run -d \
  --name rabbitmq-connector \
  -e RMQ_HOST=rabbitmq \
  -e RMQ_PORT=5672 \
  -e RMQ_USER=guest \
  -e RMQ_PASS=guest \
  -e OPEN_FAAS_GW_URL=http://gateway:8080 \
  -e PATH_TO_TOPOLOGY=/topology/topology.yaml \
  -e TOPIC_MAP_REFRESH_TIME=30s \
  -e REQ_TIMEOUT=15s \
  -v /path/to/your/topology.yaml:/topology/topology.yaml \
  -v /path/to/basic-auth-secret:/secret/basic-auth \  # 若启用 basic_auth
  templum/rabbitmq-connector:latest

拓扑配置文件示例（topology.yaml）

yaml
- name: logs-exchange
  topics: [error, info, warn]
  declare: true
  type: "topic"
  durable: true
  auto-deleted: false
- name: billing-exchange
  topics: [invoice, payment]
  declare: false
  type: "direct"
  durable: false

问题反馈与功能请求

如有 Bug 报告或功能需求，请通过 https://github.com/Templum/rabbitmq-connector/issues 提交。