[ltt-dev] [PATCH] Add the documentation for the analysis of a streaming trace
Oussama El Mfadli
oussama.el-mfadli at polymtl.ca
Fri Oct 1 21:28:33 EDT 2010
---
doc/user/user_guide/docbook/user_guide.docbook | 26 ++++
doc/user/user_guide/html/index.html | 7 +-
doc/user/user_guide/html/x125.html | 21 +++-
doc/user/user_guide/html/x136.html | 167
++++++++++++++++++++++++
4 files changed, 215 insertions(+), 6 deletions(-)
create mode 100644 doc/user/user_guide/html/x136.html
diff --git a/doc/user/user_guide/docbook/user_guide.docbook
b/doc/user/user_guide/docbook/user_guide.docbook
index ed9c960..274d646 100644
--- a/doc/user/user_guide/docbook/user_guide.docbook
+++ b/doc/user/user_guide/docbook/user_guide.docbook
@@ -564,6 +564,32 @@ order of registration of the options by the modules,
therefore the invocation
order of the modules.
</para>
</sect1>
+ <sect1>
+ <title>The analysis of a streaming trace</title>
+ <para>The LTTV text modules have the ability to start the analysis while
the tracing session is
+ still recoding the information on the system. To be able to perform
this kind of analysis, some
+ step must be followed to insure that the informations is
consistent.</para>
+ <para>First of all, you need to activate the recoding of the trace in
way that permit to the LTTV
+ modules to be notify regularly of the arrival of new informations. To
do so, you need to
+ activate the periodical flush on the instance recoding the trace. If
the trace is recorded over
+ the network, you need to specify to lttng-agent that all the channels
must be flush (refer to
+ the HOWTO file of lttng-agent and seek for the setChannelTimer
command). If the trace is taking
+ locally, activate the option on the lttctl instance. The time that you
specify to the recording
+ instance will determine the precision of your analysis. As often the
periodical flush is called,
+ as fast you will see the new events on your analysis.</para>
+ <para>Once the recoding session is activated with the right option, you
must activate the option
+ -S of the BatchAnalisys module to specify that the trace that will be
analyze is not completed
+ and that new events must be parsed.
+ <screen>
+<prompt>$</prompt> <userinput>lttv -L path/to/lib/plugins -m batchAnalysis
-S\
+-m textDump -t trace</userinput>
+</screen>The
+ internal mechanism to detect the arrival of new informations is
different depending of the
+ kernel version you are using. If your kernel version support the
inotify tool (kernel version
+ 2.6.14), the seeking of new informations will be made only on the trace
file that are modified
+ during the tracing session. If the kernel does not support this tool, a
mechanism is in place,
+ but it is not as efficient.</para>
+ </sect1>
</chapter>
diff --git a/doc/user/user_guide/html/index.html
b/doc/user/user_guide/html/index.html
index 1661e62..14b4959 100644
--- a/doc/user/user_guide/html/index.html
+++ b/doc/user/user_guide/html/index.html
@@ -135,6 +135,11 @@ HREF="c115.html#batchAnalysis"
HREF="x125.html"
>The text dump module</A
></DT
+><DT
+>4.3. <A
+HREF="x136.html"
+>The analysis of a streaming trace</A
+></DT
></DL
></DD
></DL
@@ -192,4 +197,4 @@ VALIGN="top"
></DIV
></BODY
></HTML
->
\ No newline at end of file
+>
diff --git a/doc/user/user_guide/html/x125.html
b/doc/user/user_guide/html/x125.html
index 864f17d..898e712 100644
--- a/doc/user/user_guide/html/x125.html
+++ b/doc/user/user_guide/html/x125.html
@@ -14,7 +14,10 @@ TITLE="Using LTTV text modules"
HREF="c115.html"><LINK
REL="PREVIOUS"
TITLE="Using LTTV text modules"
-HREF="c115.html"></HEAD
+HREF="c115.html"><LINK
+REL="NEXT"
+TITLE="The analysis of a streaming trace"
+HREF="x136.html"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
@@ -55,7 +58,11 @@ VALIGN="bottom"
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
-> </TD
+><A
+HREF="x136.html"
+ACCESSKEY="N"
+>Next</A
+></TD
></TR
></TABLE
><HR
@@ -155,7 +162,11 @@ ACCESSKEY="H"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
-> </TD
+><A
+HREF="x136.html"
+ACCESSKEY="N"
+>Next</A
+></TD
></TR
><TR
><TD
@@ -176,10 +187,10 @@ ACCESSKEY="U"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
-> </TD
+>The analysis of a streaming trace</TD
></TR
></TABLE
></DIV
></BODY
></HTML
->
\ No newline at end of file
+>
diff --git a/doc/user/user_guide/html/x136.html
b/doc/user/user_guide/html/x136.html
new file mode 100644
index 0000000..750bb4e
--- /dev/null
+++ b/doc/user/user_guide/html/x136.html
@@ -0,0 +1,167 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""
http://www.w3.org/TR/html4/loose.dtd">
+<HTML
+><HEAD
+><TITLE
+>The analysis of a streaming trace</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
+REL="HOME"
+TITLE="Linux Trace Toolkit Viewer User Guide"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="Using LTTV text modules"
+HREF="c115.html"><LINK
+REL="PREVIOUS"
+TITLE="The text dump module"
+HREF="x125.html"></HEAD
+><BODY
+CLASS="sect1"
+BGCOLOR="#FFFFFF"
+TEXT="#000000"
+LINK="#0000FF"
+VLINK="#840084"
+ALINK="#0000FF"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+SUMMARY="Header navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>Linux Trace Toolkit Viewer User Guide</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="x125.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+>Chapter 4. Using LTTV text modules</TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+> </TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><DIV
+CLASS="sect1"
+><H1
+CLASS="sect1"
+><A
+NAME="AEN136"
+>4.3. The analysis of a streaming trace</A
+></H1
+><P
+>The LTTV text modules have the ability to start the analysis while the
tracing session is
+ still recoding the information on the system. To be able to perform
this kind of analysis, some
+ step must be followed to insure that the informations is consistent.</P
+><P
+>First of all, you need to activate the recoding of the trace in way that
permit to the LTTV
+ modules to be notify regularly of the arrival of new informations. To
do so, you need to
+ activate the periodical flush on the instance recoding the trace. If
the trace is recorded over
+ the network, you need to specify to lttng-agent that all the channels
must be flush (refer to
+ the HOWTO file of lttng-agent and seek for the setChannelTimer
command). If the trace is taking
+ locally, activate the option on the lttctl instance. The time that you
specify to the recording
+ instance will determine the precision of your analysis. As often the
periodical flush is called,
+ as fast you will see the new events on your analysis.</P
+><P
+>Once the recoding session is activated with the right option, you must
activate the option
+ -S of the BatchAnalisys module to specify that the trace that will be
analyze is not completed
+ and that new events must be parsed.
+ <PRE
+CLASS="screen"
+>
<SAMP
+CLASS="prompt"
+>$</SAMP
+> <KBD
+CLASS="userinput"
+>lttv -L path/to/lib/plugins -m batchAnalysis -S\
+-m textDump -t trace</KBD
+>
+</PRE
+>The
+ internal mechanism to detect the arrival of new informations is
different depending of the
+ kernel version you are using. If your kernel version support the
inotify tool (kernel version
+ 2.6.14), the seeking of new informations will be made only on the trace
file that are modified
+ during the tracing session. If the kernel does not support this tool, a
mechanism is in place,
+ but it is not as efficient.</P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+SUMMARY="Footer navigation table"
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="x125.html"
+ACCESSKEY="P"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+ACCESSKEY="H"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+> </TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>The text dump module</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="c115.html"
+ACCESSKEY="U"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+> </TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
--
1.7.0.4
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.casi.polymtl.ca/pipermail/lttng-dev/attachments/20101001/92cc7291/attachment-0002.htm>
More information about the lttng-dev
mailing list