traffic-accounting-nginx-module 技术文档

1. 安装指南

下载预编译的二进制文件

从 Releases 页面下载预编译的二进制文件，将其放置到 nginx 的 ./modules 子目录中。

从源代码构建

1. 从 nginx.org 获取 nginx 源代码，然后进入到 /path/to/nginx-src/ 目录下。

2. 克隆本项目：

   git clone https://github.com/Lax/traffic-accounting-nginx-module.git
   

3. 以静态模块方式构建：

   ./configure --prefix=/opt/nginx --with-stream --add-module=traffic-accounting-nginx-module
   make && make install
   

4. 以动态模块方式构建：

   • 构建 HTTP 和 STREAM 模块：

     ./configure --prefix=/opt/nginx --with-stream --add-dynamic-module=traffic-accounting-nginx-module
     make modules
     

   • 仅构建 HTTP 模块：

     ./configure --prefix=/opt/nginx --add-dynamic-module=traffic-accounting-nginx-module
     make modules
     

   • 仅构建 STREAM 模块：

     ./configure --prefix=/opt/nginx --without-http --add-dynamic-module=traffic-accounting-nginx-module
     make modules
     

动态模块配置

如果是动态模块，需要在 nginx.conf 文件的开头添加以下内容：

load_module modules/ngx_http_accounting_module.so;

如果是仅针对 STREAM 的构建，则需要：

load_module modules/ngx_stream_accounting_module.so;

2. 项目的使用说明

编辑 nginx.conf 文件，启用会计功能并设置日志文件：

http {
  accounting        on;
  accounting_log    logs/http-accounting.log;
  accounting_id     $hostname;

  ...
}

stream {
  accounting        on;
  accounting_log    logs/stream-accounting.log;
  accounting_id     $hostname;

  ...
}

设置 accounting_id 以根据不同的变量、服务器或位置来区分不同的会计单元。

3. 项目API使用文档

本项目不直接提供 API，而是通过配置 nginx 的相关指令来实现功能。具体指令如下：

• accounting：开启或关闭会计功能。
• accounting_log：设置会计日志文件路径和日志级别。
• accounting_id：设置会计单元的标识符。
• accounting_interval：设置统计间隔时间。
• accounting_perturb：开启或关闭统计间隔的随机波动。

4. 项目安装方式

请参考上述“安装指南”部分进行安装。

• 使用预编译二进制文件或从源代码构建。
• 根据需要选择动态模块或静态模块的构建方式。
• 更新 nginx.conf 文件，加载模块并配置相关指令。

以上是关于 traffic-accounting-nginx-module 的技术文档，希望对您有所帮助。