eKuiper 安装与使用教程
1. 项目目录结构及介绍
eKuiper 的源码目录结构如下:
.
├── Dockerfile # Docker 镜像构建文件
├── Makefile # Make 构建脚本
├── README.md # 项目说明文件
├── build # 构建相关脚本和配置
│ ├── ...
├── cmd # 包含主程序入口
│ ├── ekuiper # 主程序代码
│ └── ...
├── contrib # 社区贡献的工具和示例
│ ├── ...
├── examples # 示例规则和应用
│ ├── ...
├── internal # 内部核心组件
│ ├── ...
├── proto # gRPC 协议定义
│ └── ...
└── ...
cmd/ekuiper
是 eKuiper 的主要可执行文件源码所在,examples
目录包含了多个示例,帮助用户了解如何创建和运行规则。
2. 项目启动文件介绍
eKuiper 的启动命令通常如下:
./bin/ekuiper start --config /path/to/config.yaml
其中 start
是启动命令,--config
参数指定配置文件路径。在默认情况下,如果没有提供配置文件,eKuiper 将使用内置的默认配置。
3. 项目配置文件介绍
eKuiper 使用 YAML 格式的配置文件,主要配置项包括:
server:
name: myServer
host: 0.0.0.0
port: 9090
sources:
# 源定义,例如 MQTT 源
mqttSource:
type: mqtt
config:
brokers: ["tcp://localhost:1883"]
topics: ["topic1", "topic2"]
rules:
# 规则定义,例如基于 SQL 的规则
sqlRule:
sql: SELECT * FROM mqttSource WHERE value > 20
actions:
- type: log
config:
level: info
logging:
level: info
file:
path: ./logs/ekuiper.log
maxsize: 10485760
maxbackup: 10
maxdays: 10
配置文件中 server
部分设置了服务器的名称、监听地址和端口。sources
定义了数据输入的来源,如 MQTT 源。rules
部分是规则定义,这里展示了基于 SQL 的规则,当满足条件时执行日志记录动作。最后,logging
设置了日志级别、输出位置以及日志文件管理策略。
通过修改这些配置,可以定制 eKuiper 在边缘设备上的行为和功能。