diff xml/en/docs/debugging_log.xml @ 1449:c79501e16e26

Documented cyclic memory buffer support for error_log.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 08 Apr 2015 13:56:52 +0300
parents d3390895fe6e
children 64ed0ce8ac5e
line wrap: on
line diff
--- a/xml/en/docs/debugging_log.xml	Wed Apr 08 13:49:40 2015 +0300
+++ b/xml/en/docs/debugging_log.xml	Wed Apr 08 13:56:52 2015 +0300
@@ -8,7 +8,7 @@
 <article name="A debugging log"
          link="/en/docs/debugging_log.html"
          lang="en"
-         rev="2">
+         rev="3">
 
 
 <section>
@@ -82,4 +82,30 @@
 
 </section>
 
+
+<section id="memory" name="Logging to a cyclic memory buffer">
+
+<para>
+The debugging log can be written to a cyclic memory buffer:
+<programlisting>
+error_log memory:32m debug;
+</programlisting>
+Logging to the memory buffer on the <literal>debug</literal> level
+does not have significant impact on performance even under high load.
+In this case, the log can be extracted using
+a <command>gdb</command> script like the following one:
+<example>
+set $log = ngx_cycle->new_log
+
+while $log.writer != ngx_log_memory_writer
+    set $log = $log.next
+end
+
+set $buf = (ngx_buf_t *) $log.wdata
+dump binary memory log.txt $buf->start $buf->end
+</example>
+</para>
+
+</section>
+
 </article>