LoggedFS 项目安装与使用教程

1. 项目目录结构及介绍

LoggedFS 项目的目录结构如下：

loggedfs/
├── src/
│   ├── loggedfs.cpp
│   ├── ...
├── vendor/
│   ├── github.com/
│   │   └── muflihun/
│   │       └── easyloggingpp/
├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── loggedfs.1
├── loggedfs.spec
├── loggedfs.xml
└── test.sh

目录结构介绍

• src/: 包含 LoggedFS 的主要源代码文件，如 loggedfs.cpp。
• vendor/: 包含项目依赖的第三方库，如 easyloggingpp。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证文件。
• Makefile: 项目的编译和安装脚本。
• README.md: 项目的基本介绍和使用说明。
• loggedfs.1: 项目的 man 手册页。
• loggedfs.spec: 项目的 RPM 打包配置文件。
• loggedfs.xml: 项目的配置文件模板。
• test.sh: 项目的测试脚本。

2. 项目启动文件介绍

LoggedFS 的启动文件是 src/loggedfs.cpp。该文件包含了 LoggedFS 的主要逻辑，负责处理 FUSE 的回调函数，并将操作日志记录到指定的日志文件或系统日志中。

启动命令

要启动 LoggedFS，可以使用以下命令：

loggedfs -l ~/log.txt /tmp/TEST

该命令会将 /tmp/TEST 目录下的所有操作记录到 ~/log.txt 文件中。

常用选项

• -l FILE: 指定日志文件路径。
• -f: 不以守护进程方式运行，直接在终端输出日志。
• -p: 允许所有用户查看挂载的文件系统。
• -c FILENAME: 使用配置文件来过滤需要记录的操作。

3. 项目配置文件介绍

LoggedFS 的配置文件是一个 XML 文件，用于指定哪些操作需要被记录，哪些操作需要被忽略。配置文件的默认名称为 loggedfs.xml。

配置文件示例

<loggedFS logEnabled="true" printProcessName="true">
    <includes>
        <include extension="*" uid="*" action="*" retname="*"/>
    </includes>
    <excludes>
        <exclude extension="*\.bak$" uid="*" action="*" retname="SUCCESS"/>
        <exclude extension="*" uid="1000" action="*" retname="FAILURE"/>
        <exclude extension="*" uid="*" action="getattr" retname="*"/>
    </excludes>
</loggedFS>

配置文件说明

• logEnabled: 是否启用日志记录。
• printProcessName: 是否打印进程名称。
• includes: 包含的操作规则。
• excludes: 排除的操作规则。

使用配置文件

要使用配置文件启动 LoggedFS，可以使用以下命令：

loggedfs -c loggedfs.xml -p /var

该命令会根据 loggedfs.xml 文件中的配置来记录 /var 目录下的操作。

总结

LoggedFS 是一个基于 FUSE 的文件系统监控工具，能够记录文件系统中的所有操作。通过本教程，您可以了解 LoggedFS 的目录结构、启动文件和配置文件的使用方法。希望本教程能帮助您更好地使用和配置 LoggedFS。