Linux 通知 inotify

本文最后更新于:2022年7月4日 上午

Linux 中有时需要配置事件触发的任务,在Linux kernel 2.6.13后提供了inotify文件系统监控机制,可以应用它实时完成工作。

简介

  • Inotify 是一个 Linux特性,它监控文件系统操作,比如读取、写入和创建。Inotify 反应灵敏,用法非常简单,并且比 cron 任务的繁忙轮询高效得多。

  • inotify 工具有: inotifysersynclsyncd

  • sersync 是金山的周洋开发的工具,克服了 inotify的缺陷,且提供了几个插件作为可选工具。此处先介绍 inotify的用法以及它的缺, 通过其缺陷引出 sersync,并介绍其用法。

安装 inotify-tools

  • 内核版本需要高于 2.6.13

    可以用 uname -a 查看内核版本

  • 下载链接: https://github.com/downloads/rvoicilas/inotify-tools/inotify-tools-3.14.tar.gz

  • 下载安装:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    # 下载
    wget --no-check-certificate https://github.com/downloads/rvoicilas/inotify-tools/inotify-tools-3.14.tar.gz
    # 需要用C编译代码
    # 如果没有编译器 需要安装
    sudo apt install gcc
    sudo apt install make

    ./configure
    make
    make install
  • 在系统下执行

    1
    2
    3
    man inotify
    man inotifywait
    man inotifywatch

    可得到相应的帮助信息,如果看到信息 则表示安装完成.

  • 执行:

    1
    ls /proc/sys/fs/inotify/

    如果看到显示 max_queued_events max_user_instances max_user_watches 则说明支持inotify

相关配置

  • 为命令创建软链:
1
2
3
4
5
#如果是32位系统 
ln -s /usr/local/lib/libinotifytools.so.0 /usr/lib/libinotifytools.so.0

#如果是64位系统
ln -s /usr/local/lib/libinotifytools.so.0 /usr/lib64/libinotifytools.so.0
  • 安装后,可以在 /usr/local/bin 中看到两个文件,也就是 inotify-tools 工具提供的两个命令:
1
2
/usr/local/bin$ ls
inotifywait inotifywatch

inotifywait: 用于等待文件发生变化,所以可以可以实现监控(watch)的功能,该命令是inotify的核心命令。

inotifywatch: 用于收集文件系统的统计数据,例如发生了多少次inotify事件,某文件被访问了多少次等等,一般用不上。

  • /proc/sys/fs/inotify 文件夹中有三个文件

    1
    2
    /proc/sys/fs/inotify$ ls
    max_queued_events max_user_instances max_user_watches

    其中:

    文件名 含义
    max_queued_events 调用inotify_init时分配到inotify instance中可排队的event数的最大值,超出值时的事件被丢弃,但会触发队列溢出Q_OVERFLOW事件。
    max_user_instances 每一个real user可创建的inotify instances数量的上限
    max_user_watches 每个inotify实例相关联的watches的上限,即每个inotify实例可监控的最大目录、文件数量。如果监控的文件数目巨大,需要根据情况适当增加此值。

    比如:

    1
    echo 30000000 > /proc/sys/fs/inotify/max_user_watches

    此处我们执行:

    1
    2
    echo 104857600 > /proc/sys/fs/inotify/max_user_watches 
    echo 'echo 104857600 > /proc/sys/fs/inotify/max_user_watches' >> /etc/rc.local

支持事件

inotify 可以监视的文件系统事件包括:

事件 含义
IN_ACCESS 即文件被访问
IN_MODIFY 文件被 write
IN_ATTRIB 文件属性被修改, 如 chmod、chown、touch 等
IN_CLOSE_WRITE 可写文件被 close,打开的文件被关闭,是为了写文件而打开文件,之后被关闭的事件
IN_CLOSE_NOWRITE 不可写文件被 close,read only模式下文件被关闭,即只能是为了读取而打开文件,读取结束后关闭文件的事件
IN_OPEN 文件被 open
IN_MOVED_FROM 文件被移走,如 mv
IN_MOVED_TO 文件被移来,如 mv、cp
IN_MOVE 是moved_to和moved_from的结合
IN_MOVE_SELF 被监控的文件或目录发生了移动,移动结束后将不再监控此文件或目录
IN_CREATE 创建新文件
IN_DELETE 文件被删除
IN_DELETE_SELF 自删除
IN_UNMOUNT 挂载在被监控目录上的文件系统被umount,umount后不再监控此目录
IN_ISDIR 监控目录相关操作

使用方法

inotifywait 命令的选项

参数 含义
-m 表示始终监控,否则应该是监控到了一次就退出监控了
-r 递归监控,监控目录中的任何文件,包括子目录。递归监控可能会超出max_user_watches的值,需要适当调整该值
@<file> 如果是对目录进行递归监控,则该选项用于排除递归目录中不被监控的文件。file是相对路径还是绝对路径由监控目录是相对还是绝对来决定
-q –quiet的意思,静默监控,这样就不会输出一些无关的信息
-e 指定监控的事件。一般监控的就delete、create、attrib、modify、close_write
--exclude <pattern> 通过模式匹配来指定不被监控的文件,区分大小写
--excludei <pattern> 通过模式匹配来指定不被监控的文件,不区分大小写
--timefmt 监控到事件触发后,输出的时间格式,可指定可不指定该选项,一般设置为[–timefmt ‘%Y/%m/%d %H:%M:%S’]
--format 用户自定义的输出格式,如[–format ‘%w%f %e%T’]
%w 产生事件的监控路径,不一定就是发生事件的具体文件,例如递归监控一个目录,该目录下的某文件产生事件,将输出该目录而非其内具体的文件
%f 如果监控的是一个目录,则输出产生事件的具体文件名。其他所有情况都输出空字符串
%e 产生的事件名称
%T 以"–timefmt"定义的时间格式输出当前时间,要求同时定义"–timefmt"

使用示例

监控 close_write 事件
1
inotifywait -mrd -o /data/logs/file_change.log --timefmt '%F %T' --format '%T %w%f %e' -e close_write -e create /data/htdocs

其中/data/logs/file_change.log是日志路径,/data/htdocs是监控的网站路径

监控文件夹
1
2
3
4
$ mkdir testvvd
$ inotifywait -m testvvd/
Setting up watches.
Watches established.

以前台方式监控目录,由于没指定监控的事件,所以监控所有事件

创建文件
1
2
3
4
5
6
$ touch test.txt

testvvd/ CREATE test.txt
testvvd/ OPEN test.txt
testvvd/ ATTRIB test.txt
testvvd/ CLOSE_WRITE,CLOSE test.txt

触发create、open attrib、close_write和close事件

创建目录
1
2
3
$ mkdir b

testvvd/ CREATE,ISDIR b

ISDIR表示产生该事件的对象是一个目录。

修改文件属性
1
2
$ chown vvd test.txt
testvvd/ ATTRIB test.txt

触发attrib事件

cat查看文件
1
2
3
4
5
# cat test.txt

testvvd/ OPEN test.txt
testvvd/ ACCESS test.txt
testvvd/ CLOSE_NOWRITE,CLOSE test.txt

触发open、access、close_nowrite和close事件

追加或写入或清除数据
1
2
3
4
5
# echo "haha" >> test.txt

testvvd/ OPEN test.txt
testvvd/ MODIFY test.txt
testvvd/ CLOSE_WRITE,CLOSE test.txt

触发open、modify、close_write和close事件

vim打开文件并修改文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# vim test.txt

testvvd/ OPEN,ISDIR
testvvd/ CLOSE_NOWRITE,CLOSE,ISDIR
testvvd/ OPEN,ISDIR
testvvd/ CLOSE_NOWRITE,CLOSE,ISDIR
testvvd/ OPEN test.txt
testvvd/ CREATE .test.txt.swp
testvvd/ OPEN .test.txt.swp
testvvd/ CREATE .test.txt.swx
testvvd/ OPEN .test.txt.swx
testvvd/ CLOSE_WRITE,CLOSE .test.txt.swx
testvvd/ DELETE .test.txt.swx
testvvd/ CLOSE_WRITE,CLOSE .test.txt.swp
testvvd/ DELETE .test.txt.swp
testvvd/ CREATE .test.txt.swp
testvvd/ OPEN .test.txt.swp
testvvd/ MODIFY .test.txt.swp
testvvd/ ATTRIB .test.txt.swp
testvvd/ CLOSE_NOWRITE,CLOSE test.txt
testvvd/ OPEN test.txt
testvvd/ CLOSE_NOWRITE,CLOSE test.txt
testvvd/ MODIFY .test.txt.swp
testvvd/ CREATE 4913
testvvd/ OPEN 4913
testvvd/ ATTRIB 4913
testvvd/ CLOSE_WRITE,CLOSE 4913
testvvd/ DELETE 4913
testvvd/ MOVED_FROM test.txt
testvvd/ MOVED_TO test.txt~
testvvd/ CREATE test.txt
testvvd/ OPEN test.txt
testvvd/ MODIFY test.txt
testvvd/ CLOSE_WRITE,CLOSE test.txt
testvvd/ ATTRIB test.txt
testvvd/ ATTRIB test.txt
testvvd/ MODIFY .test.txt.swp
testvvd/ DELETE test.txt~
testvvd/ CLOSE_WRITE,CLOSE .test.txt.swp
testvvd/ DELETE .test.txt.swp

中间涉及到临时文件,所以有非常多的事件。

向目录中拷入一个文件
1
2
3
4
5
6
7
# cp /bin/find .

testvvd/ CREATE find
testvvd/ OPEN find
testvvd/ MODIFY find
testvvd/ MODIFY find
testvvd/ CLOSE_WRITE,CLOSE find

触发create、open、modify和close_write、close事件。

删除一个文件
1
2
3
# rm -f test.txt

testvvd/ DELETE test.txt

触发delete事件

参考资料


Linux 通知 inotify
https://www.zywvvd.com/notes/system/linux/commands/inotify/inotify/
作者
Yiwei Zhang
发布于
2021年12月25日
许可协议