[RFC] Update documentation for LTTng ust tracing

Message ID 1381770230-11757-1-git-send-email-mohamad.gebai@polymtl.ca
State New
Headers show

Commit Message

Mohamad Gebai Oct. 14, 2013, 5:03 p.m.
Signed-off-by: Mohamad Gebai <mohamad.gebai@polymtl.ca>
 docs/tracing.txt |   31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)


diff --git a/docs/tracing.txt b/docs/tracing.txt
index bfc261b..cbb3aaf 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -214,6 +214,37 @@  The "ust" backend uses the LTTng Userspace Tracer library.  There are no
 monitor commands built into QEMU, instead UST utilities should be used to list,
 enable/disable, and dump traces.
+Package lttng-tools is required for userspace tracing. After running Qemu, LTTng
+should be able to list all available events:
+    lttng list -u
+Create tracing session:
+    lttng create mysession
+Enable events:
+    lttng enable-event EVENTS -u
+Where "EVENTS" is either a comma-separated list of events, or "-a" to enable
+all tracepoint events. Start and stop tracing as needed:
+    lttng start
+		lttng stop
+View the trace:
+    lttng view
+Destroy tracing session:
+    lttng destroy
+Babeltrace can be used at any later time to view the trace:
+    babeltrace $HOME/lttng-traces/mysession-<date>-<time>
 === SystemTap ===
 The "dtrace" backend uses DTrace sdt probes but has only been tested with