Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace, doc] two scenarios to help users decide which tracing options to use
authorLucas Schnorr <Lucas.Schnorr@imag.fr>
Fri, 23 Sep 2011 11:21:29 +0000 (13:21 +0200)
committerLucas Schnorr <Lucas.Schnorr@imag.fr>
Fri, 23 Sep 2011 11:21:29 +0000 (13:21 +0200)
doc/tracing.doc

index 407a0c4..4a7fe28 100644 (file)
@@ -219,6 +219,40 @@ triva/uncategorized
 --cfg=triva/categorized:graph_uncategorized.plist
 \endverbatim
 
+\subsection tracing_tracing_example_parameters Case studies
+
+Some scenarios that might help you decide which tracing options
+you should use to analyze your simulator.
+
+\li I want to trace the resource utilization of all hosts
+and links of the platform, and my simulator <b>does not</b> use
+the tracing API. For that, you can run a uncategorized trace
+with the following parameters (it will work with <b>any</b> Simgrid
+simulator):
+\verbatim
+./your_simulator \
+          --cfg=tracing:1 \
+          --cfg=tracing/uncategorized:1 \
+          --cfg=tracing/filename:mytracefile.trace \
+          --cfg=triva/uncategorized:uncat.plist
+\endverbatim
+
+\li I want to trace only a subset of my MSG (or SimDAG) tasks.
+For that, you will need to create tracing categories using the
+<b>TRACE_category (...)</b> function (as explained above),
+and then classify your tasks to a previously declared category
+using the <b>TRACE_msg_set_task_category (...)</b>
+(or <b>TRACE_sd_set_task_category (...)</b> for SimDAG tasks). After
+recompiling, run your simulator with the following parameters:
+\verbatim
+./your_simulator \
+          --cfg=tracing:1 \
+          --cfg=tracing/categorized:1 \
+          --cfg=tracing/filename:mytracefile.trace \
+          --cfg=triva/categorized:cat.plist
+\endverbatim
+
+
 \subsection tracing_tracing_example Example of Instrumentation
 
 A simplified example using the tracing mandatory functions.