Merge pull request #59 from tkuchiki/add-log-format-example-to-readmd-en

Add log format example to README.en
tkuchiki · Aug 23, 2021 · 687e810 · 687e810
2 parents 7ab409d + 15a4772
commit 687e810
Showing 1 changed file with 95 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -136,6 +136,41 @@ $ cat example/logs/ltsv_access.log | alp ltsv
 +-------+-----+-----+-----+-----+-----+--------+-------------------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+
 ```
 
+### Log format 
+
+#### Apache
+
+```
+LogFormat "time:%t\tforwardedfor:%{X-Forwarded-For}i\thost:%h\treq:%r\tstatus:%>s\tmethod:%m\turi:%U%q\tsize:%B\treferer:%{Referer}i\tua:%{User-Agent}i\treqtime_microsec:%D\tapptime:%D\tcache:%{X-Cache}o\truntime:%{X-Runtime}o\tvhost:%{Host}i" ltsv
+```
+
+#### Nginx
+
+```
+log_format ltsv "time:$time_local"
+                "\thost:$remote_addr"
+                "\tforwardedfor:$http_x_forwarded_for"
+                "\treq:$request"
+                "\tstatus:$status"
+                "\tmethod:$request_method"
+                "\turi:$request_uri"
+                "\tsize:$body_bytes_sent"
+                "\treferer:$http_referer"
+                "\tua:$http_user_agent"
+                "\treqtime:$request_time"
+                "\tcache:$upstream_http_x_cache"
+                "\truntime:$upstream_http_x_runtime"
+                "\tapptime:$upstream_response_time"
+                "\tvhost:$host";
+```
+
+#### H2O
+
+```
+access-log:
+  format: "time:%t\thost:%h\tua:\"%{User-agent}i\"\tstatus:%s\treq:%r\turi:%U\tapptime:%{duration}x\tsize:%b\tmethod:%m"
+```
+
 ## json
 
 - Parse a log with one JSON per line
@@ -184,6 +219,42 @@ $ cat example/logs/json_access.log | alp json
 +-------+-----+-----+-----+-----+-----+--------+-------------------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+
 ```
 
+### Log format 
+
+#### Apache
+
+```
+LogFormat "{\"time\":\"%t\",\"forwardedfor\":\"%{X-Forwarded-For}i\",\"host\":\"%h\",\"req\":\"%r\",\"status\":%>s,\"method\":\"%m\",\"uri\":\"%U%q\",\"body_bytes\":%B,\"referer\":\"%{Referer}i\",\"ua\":\"%{User-Agent}i\",\"reqtime_microsec\":%D,\"response_time\":%D,\"cache\":\"%{X-Cache}o\",\"runtime\":\"%{X-Runtime}o\",\"vhost\":\"%{Host}i\"}" json
+```
+
+#### Nginx
+
+```
+    log_format json escape=json '{"time":"$time_local",'
+                                '"host":"$remote_addr",'
+                                '"forwardedfor":"$http_x_forwarded_for",'
+                                '"req":"$request",'
+                                '"status":"$status",'
+                                '"method":"$request_method",'
+                                '"uri":"$request_uri",'
+                                '"body_bytes":$body_bytes_sent,'
+                                '"referer":"$http_referer",'
+                                '"ua":"$http_user_agent",'
+                                '"request_time":$request_time,'
+                                '"cache":"$upstream_http_x_cache",'
+                                '"runtime":"$upstream_http_x_runtime",'
+                                '"response_time":"$upstream_response_time",'
+                                '"vhost":"$host"}';
+```
+
+#### H2O
+
+```
+access-log:
+  escape: json
+  format: '{"time":"%t","host":"%h","ua":"%{User-agent}i","status":%s,"req":"%r","uri":"%U","response_time":%{duration}x,"body_bytes":%b,"method":"%m"}'
+```
+
 ## regexp
 
 - Parses the log to match the regular expression
@@ -232,6 +303,29 @@ $ cat example/logs/combined_access.log | alp regexp
 +-------+-----+-----+-----+-----+-----+--------+-------------------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+
 ```
 
+### Log format
+
+#### Apache
+
+```
+LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\" %D" combined_plus
+```
+
+#### Nginx
+
+```
+    log_format combined_plus '$remote_addr - $remote_user [$time_local] '
+                             '"$request" $status $body_bytes_sent '
+                             '"$http_referer" "$http_user_agent" $upstream_response_time $request_time';
+```
+
+#### H2O
+
+```
+access-log:
+  format: "%h %l %u %t \"%r\" %s %b \"%{Referer}i\" \"%{User-agent}i\" %{duration}x"
+```
+
 ## pcap
 
 - Parses the pcap file to extract HTTP request/response packets to analyze the stats
@@ -436,4 +530,4 @@ See: [Usage samples](./docs/usage_samples.md)
 ## Donation
 
 Donations are welcome as always!  
-[:heart: Sponsor](https://github.com/sponsors/tkuchiki)
+[:heart: Sponsor](https://github.com/sponsors/tkuchiki)