Sink (目标) 扩展

eKuiper 可以将数据接收到外部系统。 eKuiper具有对 MQTT 消息服务器日志目标的内置接收器支持。然而, 仍然需要将数据发布到各种外部系统,包括消息传递系统和数据库等。Sink (目标)扩展正是为了满足这一要求。

开发

开发 Sink (目标)

为 eKuiper 开发 Sink (目标),是实现 api.Sink 接口并将其导出为 golang 插件。

在开始开发之前,您必须为 golang 插件设置环境

要开发 Sink (目标),必须实现 Configure 方法。 接收器初始化后,将调用此方法。 在此方法中,将传入包含 规则操作定义中的配置映射,通常,将包含诸如外部系统的主机、端口、用户和密码之类的信息。您可以使用此映射来初始化此 Sink (目标)。

  1. //Called during initialization. Configure the sink with the properties from action definition
  2. Configure(props map[string]interface{}) error

下一个任务是实现 open 方法。 该实现应和创建到外部系统的连接同步。 提供了上下文参数以检索上下文信息、日志和规则元信息。

  1. //Should be sync function for normal case. The container will run it in go func
  2. Open(ctx StreamContext) error

Sink (目标)的主要任务是实现 collect 方法。 当 eKuiper 将任何数据输入 Sink (目标)时,将调用该函数。 作为无限流,此函数将被连续调用。 此功能的任务是将数据发布到外部系统。 第一个参数是上下文,第二个参数是从 eKuiper 接收的数据。

  1. //Called when each row of data has transferred to this sink
  2. Collect(ctx StreamContext, data interface{}) error

最后要实现的方法是 Close ,它实际上关闭了连接。 当流即将终止时调用它。 您也可以在此函数中执行任何清理工作。

  1. Close(ctx StreamContext) error

由于 Sink (目标)本身是一个插件,因此它必须位于主程序包中。 给定 Sink (目标)结构名称为 mySink。 在文件的最后,必须将 Sink (目标)导出为以下符号。 共有 2种类型的导出符号。 对于 Sink (目标)扩展,通常需要状态,因此建议导出构造函数。

  1. func MySink() api.Sink {
  2. return &mySink{}
  3. }

Memory Sink 是一个很好的示例。

将 Sink (目标)打包

将实现的 Sink (目标)构建为 go 插件,并确保输出的 so 文件位于 plugins/sinks 文件夹中。

  1. go build -trimpath -modfile extensions.mod --buildmode=plugin -o plugins/sinks/MySink.so extensions/sinks/my_sink.go

使用

自定义 Sink (目标)在 动作定义规定。 它的名称用作操作的键, 配置就是值。

如果您开发了 Sink (目标)实现 MySink,则应该具有:

  1. 在插件文件中,将导出符号 MySink。
  2. 编译的 MySink.so 文件位于 plugins/sinks 内部

要使用它,请在规则定义内定义动作 mySink:

  1. {
  2. "id": "rule1",
  3. "sql": "SELECT demo.temperature, demo1.temp FROM demo left join demo1 on demo.timestamp = demo1.timestamp where demo.temperature > demo1.temp GROUP BY demo.temperature, HOPPINGWINDOW(ss, 20, 10)",
  4. "actions": [
  5. {
  6. "mySink": {
  7. "server": "tcp://47.52.67.87:1883",
  8. "topic": "demoSink"
  9. }
  10. }
  11. ]
  12. }

mySink 是动作的键。 mySink 的值是该 Sink (目标)的属性。