WatchAD2.0 开源项目使用教程

1. 项目的目录结构及介绍

WatchAD2.0 项目的目录结构如下：

WatchAD2.0/
├── agent/
│   ├── config/
│   ├── logs/
│   ├── scripts/
│   └── main.py
├── engine/
│   ├── config/
│   ├── rules/
│   ├── logs/
│   └── main.py
├── web/
│   ├── config/
│   ├── static/
│   ├── templates/
│   └── main.py
├── database/
│   ├── config/
│   ├── data/
│   └── main.py
├── config/
│   ├── global.conf
│   └── logging.conf
├── README.md
└── setup.py

目录介绍

• agent/: 包含日志收集Agent的相关文件。

  • config/: 配置文件目录。
  • logs/: 日志文件目录。
  • scripts/: 脚本文件目录。
  • main.py: Agent的启动文件。

• engine/: 包含规则检测及分析引擎的相关文件。

  • config/: 配置文件目录。
  • rules/: 规则文件目录。
  • logs/: 日志文件目录。
  • main.py: 引擎的启动文件。

• web/: 包含Web控制端的相关文件。

  • config/: 配置文件目录。
  • static/: 静态文件目录。
  • templates/: 模板文件目录。
  • main.py: Web控制端的启动文件。

• database/: 包含缓存数据库的相关文件。

  • config/: 配置文件目录。
  • data/: 数据文件目录。
  • main.py: 数据库的启动文件。

• config/: 包含全局配置文件。

  • global.conf: 全局配置文件。
  • logging.conf: 日志配置文件。

• README.md: 项目说明文档。

• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

Agent 启动文件

agent/main.py 是Agent的启动文件，负责收集域控产生的事件日志和Kerberos流量，并将其发送到分析引擎。

引擎启动文件

engine/main.py 是规则检测及分析引擎的启动文件，负责接收Agent发送的数据，进行实时分析，并生成告警。

Web 控制端启动文件

web/main.py 是Web控制端的启动文件，负责提供用户界面，展示分析结果和告警信息。

数据库启动文件

database/main.py 是缓存数据库的启动文件，负责存储和管理分析引擎生成的数据。

3. 项目的配置文件介绍

全局配置文件

config/global.conf 是全局配置文件，包含项目的通用配置，如日志级别、数据库连接信息等。

日志配置文件

config/logging.conf 是日志配置文件，定义了日志的输出格式和存储位置。

Agent 配置文件

agent/config/agent.conf 是Agent的配置文件，包含Agent的运行参数，如日志收集路径、发送目标地址等。

引擎配置文件

engine/config/engine.conf 是引擎的配置文件，包含引擎的运行参数，如规则路径、告警输出方式等。

Web 控制端配置文件

web/config/web.conf 是Web控制端的配置文件，包含Web服务的运行参数，如端口号、模板路径等。

数据库配置文件

database/config/database.conf 是数据库的配置文件，包含数据库的连接参数，如数据库类型、连接字符串等。

以上是WatchAD2.0开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的详细介绍。希望对您有所帮助。