浏览代码

HUE-8187 [doc] Add Instrumentation flag and log format documentation to upstream documentation

Roohi 7 年之前
父节点
当前提交
e4834eb1ae
共有 1 个文件被更改,包括 20 次插入0 次删除
  1. 20 0
      docs/admin-manual/manual.md

+ 20 - 0
docs/admin-manual/manual.md

@@ -1201,6 +1201,26 @@ web server keeps a small buffer of log messages at all levels in memory. You can
 view these logs by visiting `http://myserver:8888/hue/logs`. The `DEBUG` level
 messages shown can sometimes be helpful in troubleshooting issues.
 
+## Troubleshooting
+
+To troubleshoot why Hue is slow or consuming high memory, admin can enable instrumentation by setting the `instrumentation` flag to True.
+ <pre>
+[desktop]
+instrumentation=true
+</pre>
+ If `django_debug_mode` is enabled, instrumentation is automatically enabled. This flag appends the response time and the total peak memory used since Hue started for every logged request.
+
+##### Instrumentation enabled:
+
+<pre>
+[17/Apr/2018 15:18:43 -0700] access       INFO     127.0.0.1 admin - "POST /jobbrowser/jobs/ HTTP/1.1" `returned in 97ms (mem: 135mb)`
+</pre>
+
+##### Instrumentation not enabled:
+
+<pre>
+[23/Apr/2018 10:59:01 -0700] INFO     127.0.0.1 admin - "POST /jobbrowser/jobs/ HTTP/1.1" returned in 88ms
+</pre>
 
 ## Database