# Elkeid-HUB

**Repository Path**: ByteDance/Elkeid-HUB

## Basic Information

- **Project Name**: Elkeid-HUB
- **Description**: Elkeid HUB is a rule/event processing engine maintained by the Elkeid Team that supports streaming/offline (not yet supported by the community edition) data processing. The original intention is to solve complex data/event processing and external system linkage requirements through standardized rules.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-26
- **Last Updated**: 2026-03-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](README.md) | 简体中文
# Elkeid HUB
Elkeid HUB 是一款由 Elkeid Team 维护的规则/事件处理引擎，支持流式/离线(社区版尚未支持)数据处理。 初衷是通过标准化的抽象语法/规则来解决复杂的数据/事件处理与外部系统联动需求。

## Core Components
* `INPUT` 数据输入层，社区版仅支持Kafka
* `RULEENGINE/RULESET` 对数据进行检测/外部数据联动/数据处理的核心组件
* `OUTPUT` 数据输出层，社区版仅支持Kafka/ES
* `SMITH_DSL` 用来描述数据流转关系


## Application Scenarios

* Simple HIDS
<img src="example_hids.png"/>

* IDS Like Scenarios
<img src="example_ids.png"/>

* Multiple input and output scenarios
<img src="example_complex.png"/>


## Advantages
* 高性能
* 依赖极少
* 支持复杂数据处理
* 插件支持
* 支持有状态逻辑
* 支持外部系统/数据联动

## Elkeid Internal Best Practices
* 使用 Elkeid HUB 处理 Elkeid HIDS/RASP/Sandbox/K8s auditing 等原始数据，TPS 1.2亿条+/秒，HUB 调度实例 6000+

## Elkeid-HUB Function List

| Ability List     | Elkeid Community Edition | Elkeid Enterprise Edition |
| ---------------- | ------------------------ | ------------------------- |
| 流式数据处理     | :white_check_mark:       | :white_check_mark:        |
| 数据输入输出能力 | :white_check_mark:       | :white_check_mark:        |
| 完整前端支持     | :white_check_mark:       | :white_check_mark:        |
| 监控能力         | :white_check_mark:       | :white_check_mark:        |
| 插件支持         | :white_check_mark:       | :white_check_mark:        |
| Debug支持        | :white_check_mark:       | :white_check_mark:        |
| 离线数据处理     | :ng_man: | :white_check_mark:        |
| 持久化能力       | :ng_man: | :white_check_mark:        |
| Workspace        | :ng_man: | :white_check_mark:        |
| 集群模式         | :ng_man: | :white_check_mark:        |
| 在线升级策略     | :ng_man: | :white_check_mark:        |



## Front-end Display (Community Edition)

**Overview**
<img src="docs/png/1.png" style="float:left;"/>



**Edit Rule**
<img src="docs/png/2.png" style="float:left;"/>



**Edit HUB Project**
<img src="docs/png/3.png" style="float:left;"/>



**Edit HUB Python Plugin**
<img src="docs/png/4.png" style="float:left;"/>



**Submission Rules**
<img src="docs/png/5.png" style="float:left;"/>


## Getting Started
- [Deploy By Elkeidup](https://github.com/bytedance/Elkeid/blob/main/elkeidup/README-zh_CN.md#elkeid-hub-单独部署)
- [Elkeid HUB Quick Start](docs/quick_start/quick_start_zh-CN.md)


## Elkeid HUB Handbook
[Handbook](docs/handbook/handbook-zh_CN.md)

## Demo Config
[Demo](config/demo)

## Elkeid HIDS Rule and Project (Just Example)
[Elkeid Project](config/elkeid_hids)

(Need to use with [Elkeid](https://github.com/bytedance/Elkeid))

## LICENSE (Not Business Friendly)
[LICENSE](LICENSE)

## Contact us && Cooperation
<img src="./Lark.png" width="40%" style="float:left;"/>