[GitHub] [apisix] jagerzhang opened a new issue #5868: docs: Can the Docs show a complete example of log_format？

Mon, 20 Dec 2021 17:47:21 -0800 


jagerzhang opened a new issue #5868:
URL: https://github.com/apache/apisix/issues/5868


   ### Improved or typo fixed.
   
   
APISIX有很多日志插件，且支持自定义日志格式，但是文档里面对于自定义日志格式的描述过于简单，加大了自定义日志格式的难度，在搜索引擎搜索相关文档也基本没有log_format的相关说明。
   
   另外，文档里面我看到展示了APISIX可以支持的变量：
   
![image](https://user-images.githubusercontent.com/9711651/146856319-23bffaf5-9332-4372-a4ea-8c973613007e.png)
   感觉应该不止这些，比如 upstream_latency 、apisix_latency 
这些阶段耗时字段没找到，有没有地方可以看到所有APISIX支持的可以用于定义log_format的变量呢？
   
   ### Solution
   
   总结一下：
   1. 
建议Docs里面可以展示下默认的log_format，即不配置自定义log_format时输出的日志的格式模板，我们可以快速基于这个模板来自定义log_format，可以简化上手门槛；
   2. 
除了可以在http://nginx.org/en/docs/varindex.html查看所有Nginx支持的变量，希望也展示下APISIX能支持的所有日志变量；
   3. 如果可以的话，建议再展示一些常用的log_format的最佳实践。


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to