Skip to content

Commit

Permalink
Update configuration doc for mod_access
Browse files Browse the repository at this point in the history
  • Loading branch information
@iyangsj
iyangsj committed Nov 12, 2019
1 parent 32ca034 commit 5f994ba
Showing 1 changed file with 71 additions and 0 deletions.
71 changes: 71 additions & 0 deletions docs/zh_cn/configuration/mod_access/mod_access.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

mod_access模块以特定格式记录请求日志和会话日志。


# 配置

- 模块配置文件
Expand Down Expand Up @@ -30,3 +31,73 @@ mod_access模块以特定格式记录请求日志和会话日志。
SessionTemplate = "SESSION_LOG $time clientip: $ses_clientip start_time: $ses_start_time end_time: $ses_end_time overhead: $ses_overhead read_total: $ses_read_total write_total: $ses_write_total keepalive_num: $ses_keepalive_num error: $ses_error"
```

* 注：RequestTemplate/SessionTemplate 中 $开头的代表变量, 支持的变量列表详见"变量"章节说明


# 变量

## 请求日志变量

| 变量名 | 含义 |
| --------------------- | ------------------------------------------- |
| log_id | 请求日志ID |
| error | 请求处理错误 |
| product | 产品线名称 |
| host | 请求Host字段 |
| uri | 请求URL信息 |
| vip | 请求访问VIP |
| is_trust_clientip | 请求是否来自信任IP |
| req_uri | 请求行URI |
| req_header | 请求头部, 例$[User-Agent]req_header |
| req_cookie | 请求Cookie |
| req_nth | 请求序号（连接上第几个请求) |
| body_len_in | 请求内容长度 |
| status_code | 响应状态码 |
| res_proto | 响应HTTP协议版本 |
| res_header | 响应头部, 例$[Server]req_header |
| res_cookie | 响应Set-Cookie |
| redirect | 重定向响应地址 |
| body_len_out | 响应内容长度 |
| remote_addr | 连接对端地址 |
| server_addr | 连接本地地址 |
| backend | 请求转发后端信息(集群、子集群、实例) |
| cluster_name | 请求转发集群名称 |
| subcluster | 请求转发子集群名称 |
| retry_num | 请求转发重试次数 |
| all_time | 请求总处理时间 |
| read_req_duration | 读请求头持续时间 |
| proxy_delay | 从接收到请求头到开始转发请求延迟时间 |
| connect_time | 连接后端时间 |
| write_serve_time | 从请求后端到接收到后端响应头持续时间 |
| response_duration | 从接收到响应头到完成响应转发持续时间 |
| cluster_duration | 从请求后端到接收到响应头部持续时间（含重试）|
| last_backend_duration | 从请求后端到接收到响应头部持续时间 |
| readwrite_serve_time | 从请求后端到完成响应转发持续时间 |
| since_ses_start_time | 接收到请求时当前会话持续时间 |


## 会话日志变量

| 变量名 | 含义 |
| --------------------- | ------------------------------------------- |
| ses_clientip | 会话用户IP |
| ses_error | 会话错误 |
| ses_is_secure | 是否基于TLS协议 |
| ses_start_time | 会话开始时间 |
| ses_end_time | 会话结束时间 |
| ses_overhead | 会话持续时长 |
| ses_read_total | 会话读取字节总数 |
| ses_write_total | 会话写出字节总数 |
| ses_tls_client_random | TLS连接ClientHello Random |
| ses_tls_server_random | TLS连接ServerHello Random |
| ses_use100 | 是否出现Expect: 100-continue请求 |
| ses_keepalive_num | 会话总处理请求数 |


## 通用日志变量

| 变量名 | 含义 |
| --------------------- | ------------------------------------------- |
| time | 日志记录时间 |

0 comments on commit 5f994ba

Please sign in to comment.