feat: support alias for log format layout

Cargo.toml

@@ -14,7 +14,7 @@ readme = "./README.md"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-async-trait = "0.1.78"
+async-trait = "0.1.79"
 base64 = "0.22.0"
 bytes = "1.6.0"
 bytesize = "1.3.0"

conf/pingap.toml

@@ -86,7 +86,8 @@ addr = "0.0.0.0:6188"
 # tls_key = ""
 
 # Access log format layout for the server. Default `None`
-access_log = '"{method} {uri} {proto}" {status} {size-human} "{referer}" "{user-agent}" {latency-human}'
+# access_log = '"{method} {uri} {proto}" {status} {size-human} "{referer}" "{user-agent}" {latency-human}'
+access_log = "tiny"
 
 # Location list for the server, item should be the name of location.
 # The locations should be served by the server.

docs/log_zh.md

@@ -2,4 +2,31 @@
 description: Pingap 请求日志格式化
 ---
 
-Pingap格式化相关参数，具体参数说明如下：
+Pingap格式化可以使用以下几种默认形式`combined`，`common`，`short`以及`tiny`。也可自定义完整的日志格式化输出，具体参数说明如下：
+
+- `{host}`: 请求的host属性
+- `{method}`: 请求的method
+- `{path}`: 请求的路径
+- `{proto}`: 协议类型，`HTTP/1.1`或`HTTP/2.0`
+- `{query}`: 请求的querystring
+- `{remote}`: 请求的源ip
+- `{client-ip}`: 客户ip，根据`x-forwarded-for`中获取
+- `{scheme}`:
+- `{uri}`: 请求的完整地址
+- `{referer}`: 请求头中的referer
+- `{user-agent}`: 请求的user-agent
+- `{when}`: 日志的输出时间
+- `{when-utc-iso}`: 日志的输出的utc时间
+- `{when-unix}`: 日志的输出时间，格式为时间戳
+- `{size}`: 响应数据的字节数
+- `{size-human}`: 响应数据的大小，按数据大小格式化字符串
+- `{status}`: 响应状态码
+- `{latency}`: 响应时间的ms
+- `{latency-human}`: 响应时间，按时间格式化
+- `{payload-size}`: 请求数据的字节大小
+- `{payload-size-human}`: 请求数据的大小，按数据大小格式化字符串
+- `{~cookiename}`: 从cookie中获取对应的值
+- `{>requestHeaderName}`: 请求头中获取对应的值
+- `{<responseHeaderName}`: 响应头中获取对应的值
+- `{:contentName}`: 从context中获取对应的值，暂时仅支持以下属性：`reused`, `upstream-address`, `processing`
+- `{$envName}`: 从环境变量中获取对应的值，仅启动时获取

src/cache/http_header.rs

@@ -21,6 +21,7 @@ type Result<T, E = Error> = std::result::Result<T, E>;
 
 pub type HttpHeader = (HeaderName, HeaderValue);
 
+/// Converts string slice to http headers
 pub fn convert_headers(header_values: &[String]) -> Result<Vec<HttpHeader>> {
     let mut arr = vec![];
     for item in header_values {

src/cache/http_response.rs

@@ -7,15 +7,22 @@ use std::time::{SystemTime, UNIX_EPOCH};
 
 #[derive(Default, Debug, Clone)]
 pub struct HttpResponse {
+    // http response status
     pub status: StatusCode,
+    // http response body
     pub body: Bytes,
+    // max age of http response
     pub max_age: Option<u32>,
+    // created time of http response
     pub created_at: Option<u64>,
+    // private for cache control
     pub private: Option<bool>,
+    // headers for http response
     pub headers: Option<Vec<HttpHeader>>,
 }
 
 impl HttpResponse {
+    /// Gets the response header from http response
     pub fn get_response_header(&self) -> pingora::Result<ResponseHeader> {
         let fix_size = 3;
         let size = self
@@ -60,6 +67,7 @@ impl HttpResponse {
         }
         Ok(resp)
     }
+    /// Sends http response to client
     pub async fn send(self, session: &mut Session) -> pingora::Result<usize> {
         let header = self.get_response_header()?;
         let size = self.body.len();

src/proxy/logger.rs

@@ -81,8 +81,21 @@ fn format_extra_tag(key: &str) -> Option<Tag> {
     }
 }
 
+static COMBINED: &str =
+    r###"{remote} "{method} {uri} {proto}" {status} {size-human} "{referer}" "{userAgent}""###;
+static COMMON: &str = r###"{remote} "{method} {uri} {proto}" {status} {size-human}""###;
+static SHORT: &str = r###"{remote} {method} {uri} {proto} {status} {size-human} - {latency}ms"###;
+static TINY: &str = r###"{method} {uri} {status} {size-human} - {latency}ms"###;
+
 impl From<&str> for Parser {
     fn from(value: &str) -> Self {
+        let value = match value {
+            "combined" => COMBINED,
+            "common" => COMMON,
+            "short" => SHORT,
+            "tiny" => TINY,
+            _ => value,
+        };
         let reg = Regex::new(r"(\{[a-zA-Z_<>\-~:$]+*\})").unwrap();
         let mut current = 0;
         let mut end = 0;

src/proxy/server.rs

@@ -320,7 +320,6 @@ impl ProxyHttp for Server {
                 return Ok(true);
             }
         }
-
         Ok(false)
     }
     async fn upstream_peer(