← Back to branch summary

~ubuntu-branches/ubuntu/utopic/eclipse-linuxtools/utopic

« back to all changes in this revision

Viewing changes to lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/LTTng-Tracer-Control.html

  • Committer: Package Import Robot
  • Author(s): Jakub Adam
  • Date: 2014-05-12 18:11:40 UTC
  • mfrom: (3.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20140512181140-w237r3vsah1tmybz
Tags: 2.2.1-1
* New upstream release.
* Refreshed d/patches.
* Removed eclipse-cdt-valgrind-remote package, all its functionality
  is now provided by eclipse-cdt-profiling-framework-remote.
* Added remove-license-feature.patch.
* Bump Standards-Version to 3.9.5.
* Enable eclipse-changelog package.
* Enable eclipse-rpm-editor package.

Show diffs side-by-side

added added

removed removed

Lines of Context:
lttng/org.eclipse.linuxtools.lttng.help/Linux_Tools_Project/LTTng/User_Guide/LTTng-Tracer-Control.html
1
 
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
 
<html xmlns="http://www.w3.org/1999/xhtml">
3
 
        <head>
4
 
                <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
5
 
                <title>LTTng Plug-in User Guide (legacy) - LTTng Tracer Control</title>
6
 
                <link type="text/css" rel="stylesheet" href="../../../book.css"/>
7
 
        </head>
8
 
        <body>
9
 
                <table class="navigation" style="width: 100%;" border="0" summary="navigation">
10
 
                        <tr>
11
 
                                <th style="width: 100%" align="center" colspan="3">LTTng Tracer Control</th>
12
 
                        </tr>
13
 
                        <tr>
14
 
                                <td style="width: 20%" align="left">
15
 
                                        <a href="LTTng-Perspective.html" title="LTTng Perspective">
16
 
                                                <img alt="Previous" border="0" src="../../../images/prev.gif"/>
17
 
                                        </a>
18
 
                                </td>
19
 
                                <td style="width: 60%" align="center"></td>
20
 
                                <td style="width: 20%" align="right">
21
 
                                        <a href="Limitations.html" title="Limitations">
22
 
                                                <img alt="Next" border="0" src="../../../images/next.gif"/>
23
 
                                        </a>
24
 
                                </td>
25
 
                        </tr>
26
 
                        <tr>
27
 
                                <td style="width: 20%" align="left" valign="top">LTTng Perspective</td>
28
 
                                <td style="width: 60%" align="center"></td>
29
 
                                <td style="width: 20%" align="right" valign="top">Limitations</td>
30
 
                        </tr>
31
 
                </table><hr/>
32
 
                <h1 id="LTTng_Tracer_Control">LTTng Tracer Control</h1>
33
 
                <p>The LTTng Tracer toolchains version v0.x requires and LTTng agent running on the remote host. The functions to control the LTTng tracer (e.g. start, pause, resume), either locally or remotely, are available from the Remote Systems view (See 
34
 
                        <a href="LTTng-Tracer-Control.html#Remote_Systems_View">Remote Systems View</a>, an RSE view).
35
 
                </p>
36
 
                <p>
37
 
                        <img border="0" src="images/LTTngControlRsePerspective.png"/>
38
 
                </p>
39
 
                <h3 id="Remote_Systems_View">Remote Systems View</h3>
40
 
                <p>The LTTng tracer is controlled by the UI through an LTTng agent running on the tracer system.</p>
41
 
                <h4 id="Create_a_Remote_Connection">Create a Remote Connection</h4>
42
 
                <p>A new connection to a remote system can be created using the new connection wizard of the Remote System Explorer. For this, a toolbar button exists on the top left corner of the Remote System view. Alternatively, this wizard can be started using File -&gt; New -&gt; Other ... -&gt; Remote System Explorer -&gt; Connection).</p>
43
 
                <p>
44
 
                        <img border="0" src="images/LTTngNewConnectionWizard1.png"/>
45
 
                </p>
46
 
                <p>For LTTng control, select connection type LTTng and press Next to define the connection.</p>
47
 
                <p>
48
 
                        <img border="0" src="images/LTTngNewConnectionWizard2.png"/>
49
 
                </p>
50
 
                <p>The 
51
 
                        <b>Host name</b> holds the IP address or DNS name of the remote system. 
52
 
                        The 
53
 
                        <b>Connection name</b> is the name to be displayed in the Remote Systems view. 
54
 
                        The 
55
 
                        <b>Description</b> is optional. 
56
 
                        Unless the user wants to use a specific 
57
 
                        <b>Profile</b>, the default profile is sufficient. 
58
 
                        The checkbox 
59
 
                        <b>Verfiy host name</b> enable or disables the verification of the remote system. 
60
 
                </p>
61
 
                <p>By default, when pressing "Finish" the new connection contains the following sub systems:  </p>
62
 
                <ul>
63
 
                        <li>
64
 
                                <b>Files</b>: This subsystem allows the user to browse the file system on the remote system. Amongst others the user has the possibility to open, create files, download or upload files.
65
 
                        </li>
66
 
                </ul>
67
 
                <ul>
68
 
                        <li>
69
 
                                <b>Processes</b>: This subsystem allows the user to browse and control processes on the remote system.
70
 
                        </li>
71
 
                </ul>
72
 
                <ul>
73
 
                        <li>
74
 
                                <b>Shells</b>: This subsystem allows the user to open command shells to issue commands on the remote system.
75
 
                        </li>
76
 
                </ul>
77
 
                <ul>
78
 
                        <li>
79
 
                                <b>Terminals</b>: This subsystem allows the user to open command terminals to issue commands on the remote system.
80
 
                        </li>
81
 
                </ul>
82
 
                <ul>
83
 
                        <li>
84
 
                                <b>LTTng Tracing</b>: With this subsystem the user can control the LTTng tracer on the remote system. It supports the control of kernel and userspace traces. 
85
 
                        </li>
86
 
                </ul>
87
 
                <p>The user has the possibility to configure or omit the subsystems 
88
 
                        <b>Files</b>, 
89
 
                        <b>Processes</b>, 
90
 
                        <b>Shells</b> and 
91
 
                        <b>Terminals</b> by pressing "Next" and deselecting the relevant subsystem. 
92
 
                </p>
93
 
                <p>
94
 
                        <img border="0" src="images/LTTngNewConnectionWizard3.png"/>
95
 
                </p>
96
 
                <p>
97
 
                        <img border="0" src="images/LTTngNewConnectionWizard4.png"/>
98
 
                </p>
99
 
                <p>
100
 
                        <img border="0" src="images/LTTngNewConnectionWizard5.png"/>
101
 
                </p>
102
 
                <p>
103
 
                        <img border="0" src="images/LTTngNewConnectionWizard6.png"/>
104
 
                </p>
105
 
                <p>After finishing the new connection the Remote System view will be updated:</p>
106
 
                <p>
107
 
                        <img border="0" src="images/LTTngRemoteSystemsNewConnection.png"/>
108
 
                </p>
109
 
                <h4 id="General">General</h4>
110
 
                <p>All actions are on elements in the Remote Systems view are accessible through context sensitive menu. By selecting a tree element and pressing the right mouse button a context sensitive menu is shown. Some of the actions are also available through toolbar buttons and toolbar menu. </p>
111
 
                <h4 id="Connect_to_Remote_Host">Connect to Remote Host</h4>
112
 
                <p>The connection to the remote host can be established by selecting the connection in the tree, click the right mouse button and select Connect.</p>
113
 
                <p>
114
 
                        <img border="0" src="images/LTTngConnectToRemoteSystem.png"/>
115
 
                </p>
116
 
                <p>A login dialog will be opened, where the user needs to specify the user name and password.</p>
117
 
                <p>
118
 
                        <img border="0" src="images/LTTngLoginDialog.png"/>
119
 
                </p>
120
 
                <p>After logging in the LTTng Trace Control will retrieve LTTng Remote System information. First it will read the supported providers. The providers will be one or both of the following: "kernel" for kernel tracing and "ust" for user space tracing. After that the trace controls reads the currently available targets. For kernel tracing, there is only one target with ID "0". For user space tracing each target is the corresponding process ID of a user space application with user space tracing enabled. Without any traces created the Remote System view will look like this (after expanding the tree):</p>
121
 
                <p>
122
 
                        <img border="0" src="images/LTTngRemoteSystemsWithLTTng.png"/>
123
 
                </p>
124
 
                <h4 id="Configure_Kernel_Markers">Configure Kernel Markers</h4>
125
 
                <p>The marker of a given target can be configured by selecting the kernel target "0", clicking the right mouse button and selecting the 
126
 
                        <b>Configure Markers</b> menu item of the context sensitive menu.
127
 
                </p>
128
 
                <p>
129
 
                        <img border="0" src="images/LTTngConfigureMarkersAction.png"/>
130
 
                </p>
131
 
                <p>A new dialog box will show for the configuration of the relevant markers. All markers are listed in a table. The first column contains a checkbox to enable or disable a marker. The second column shows the name of the marker and all other columns display marker details.</p>
132
 
                <p>
133
 
                        <img border="0" src="images/LTTngConfigureMarkersDialog.png"/>
134
 
                </p>
135
 
                <h4 id="Create_a_New_Kernel_Trace">Create a New Kernel Trace</h4>
136
 
                <p>A new trace can be created by selecting the kernel target "0", clicking the right mouse button and selecting the 
137
 
                        <b>New Trace</b> menu item of the context sensitive menu.
138
 
                </p>
139
 
                <p>
140
 
                        <img border="0" src="images/LTTngCreateNewTraceAction.png"/>
141
 
                </p>
142
 
                <p>A new dialog box will show for the configuration of the relevant parameter. </p>
143
 
                <p>
144
 
                        <img border="0" src="images/LTTngCreateNewTraceDialog.png"/>
145
 
                </p>
146
 
                <ul>
147
 
                        <li>
148
 
                                <b>Name</b>: holds the name of the trace. 
149
 
                        </li>
150
 
                </ul>
151
 
                <ul>
152
 
                        <li>
153
 
                                <b>Transport type</b>: it is set by default to "relay" and cannot be changed.
154
 
                        </li>
155
 
                </ul>
156
 
                <ul>
157
 
                        <li>
158
 
                                <b>Trace Location</b>:  
159
 
                                <ul>
160
 
                                        <li>
161
 
                                                <b>Target</b>: means that the trace is stored on the remote system where the trace is collected. 
162
 
                                        </li>
163
 
                                        <li>
164
 
                                                <b>Host</b>: means that the trace is transfered to the local host where the eclipse application is running. 
165
 
                                        </li>
166
 
                                        <li>
167
 
                                                <b>Trace path</b>: holds the path where the trace shall be stored. The 
168
 
                                                <b>Browse</b> button is only active for 
169
 
                                                <b>Local</b> and can be used to open a dialog box to select the trace path directory.
170
 
                                        </li>
171
 
                                </ul>
172
 
                        </li>
173
 
                </ul>
174
 
                <ul>
175
 
                        <li>
176
 
                                <b>Tracing project</b>: defines the LTTng Tracing project where a streaming (host) trace will be added at trace start.
177
 
                        </li>
178
 
                        <li>
179
 
                                <b>Number of lttd threads</b>: defines the number of threads to be used by the ltt daemon during tracing.
180
 
                        </li>
181
 
                        <li>
182
 
                                <b>Append</b>: can be used to append the new trace to an existing trace.
183
 
                        </li>
184
 
                        <li>
185
 
                                <b>Trace mode</b>: can be either 
186
 
                                <b>Normal</b> or 
187
 
                                <b>Flight Recorder</b>. In normal mode, the subbuffers are constantly written while the trace is started. In flight recorder mode, only the latest subbuffers are written when the trace is stopped. 
188
 
                        </li>
189
 
                </ul>
190
 
                <p>If all inputs are valid the 
191
 
                        <b>Finish</b> button will be active and can be used to create the trace. The LTTng trace control will setup the trace using the connection to the remote agent.
192
 
                </p>
193
 
                <p>After creating a new trace, the Remote Systems view will be updated. When selecting the newly created trace in the tree, the buttons to start, stop and configure the trace will be enabled.</p>
194
 
                <p>
195
 
                        <img border="0" src="images/LTTngRemoteSystemConfiguredTrace.png"/>
196
 
                </p>
197
 
                <h4 id="Configure_a_Trace_and_Trace_Channels">Configure a Trace and Trace Channels</h4>
198
 
                <p>Some of the trace parameters can be changed if the trace has not been previously started. A trace can be configured by selecting the relevant kernel trace, clicking the right mouse button and selecting the "Configure Trace" menu item of the context sensitive menu. </p>
199
 
                <p>
200
 
                        <img border="0" src="images/LTTngConfigureTraceAction.png"/>
201
 
                </p>
202
 
                <p>A new dialog box with a wizard page will show for the configuration of the relevant parameter. For explanation of the parameters see 
203
 
                        <a href="LTTng-Tracer-Control.html#Create_a_New_Kernel_Trace">Create_a_New_Kernel_Trace</a>
204
 
                </p>
205
 
                <p>
206
 
                        <img border="0" src="images/LTTngConfigureTraceDialog.png"/>
207
 
                </p>
208
 
                <p>After entering valid parameters the 
209
 
                        <b>Next</b> and 
210
 
                        <b>Finish</b> buttons will be active. To finalize the configuration of the trace select the 
211
 
                        <b>Finish</b> button. To configure channel parameters select the 
212
 
                        <b>Next</b> button. A new wizard page will show for the configuration of channel parameters. For provider 
213
 
                        <b>kernel</b> the following display will show:  
214
 
                </p>
215
 
                <p>
216
 
                        <img border="0" src="images/LTTngConfigureChannelsKernelDialog.png"/>
217
 
                </p>
218
 
                <p>All channels can be configured at once by clicking the right mouse button in the table and selecting one of the menu items of the context sensitive menu.</p>
219
 
                <p>
220
 
                        <img border="0" src="images/LTTngConfigureChannelsActions.png"/>
221
 
                </p>
222
 
                <p>For provider 
223
 
                        <b>ust</b> only the channel parameter 
224
 
                        <b>Channel Timer</b> can be configured and the following display will show after selecting the 
225
 
                        <b>Next</b> button of the 
226
 
                        <b>Trace configuration</b> page.
227
 
                </p>
228
 
                <p>
229
 
                        <img border="0" src="images/LTTngConfigureChannelsUstDialog.png"/>
230
 
                </p>
231
 
                <p>Please note that channel parameters cannot be retrieved from the LTTng agent. Therefore they cannot be displayed in the table unless they have been previously configured through Eclipse. However, this information will be lost after closing Eclipse. A question mark will indicate that the relevant value is not known and it will be ignored after selecting the 
232
 
                        <b>Finish</b> button.
233
 
                </p>
234
 
                <ul>
235
 
                        <li>
236
 
                                <b>Name</b> column: holds the name of the channel. 
237
 
                        </li>
238
 
                        <li>
239
 
                                <b>Enabled</b> column: a checkbox indicates whether the channel is enabled or not.
240
 
                        </li>
241
 
                        <li>
242
 
                                <b>Buffer Override</b> column: a checkbox indicates whether channel buffer overwrite is enabled or not. 
243
 
                        </li>
244
 
                        <li>
245
 
                                <b>Number of Sub Buffers</b> column: holds the number of sub-buffers of the channel. 
246
 
                        </li>
247
 
                        <li>
248
 
                                <b>Sub Buffer size</b> column: holds the size of the sub-buffer of the channel (in bytes). 
249
 
                        </li>
250
 
                        <li>
251
 
                                <b>Channel Timer</b> column: holds the channel timer value (in milliseconds) for periodically flushing all collected data for the channel, whether the sub-buffers are full or not. The provider 
252
 
                                <b>ust</b> only supports a single timer for all channels, traces and targets it is monitoring.
253
 
                        </li>
254
 
                </ul>
255
 
                <p>Please note that the 
256
 
                        <b>Configure Trace</b> item of the context sensitive menu of a trace can be used to display the trace and channel parameters at any time. However, they can only be changed if the trace has not been previously started.
257
 
                </p>
258
 
                <h4 id="Start_a_Trace">Start a Trace</h4>
259
 
                <p>A configured or paused trace can be started by selecting the kernel trace, clicking the right mouse button and selecting the 
260
 
                        <b>Start</b> menu item of the context sensitive menu. Alternatively, the start button in the toolbar can be used to start the trace. If the trace location is host (streaming trace), it will be automatically added to the tracing project that was selected at trace creation.
261
 
                </p>
262
 
                <p>
263
 
                        <img border="0" src="images/LTTngStartTraceAction.png"/>
264
 
                </p>
265
 
                <h4 id="Pause_a_Trace">Pause a Trace</h4>
266
 
                <p>A started trace can be paused by selecting the relevant trace, clicking the right mouse button and selecting the 
267
 
                        <b>Pause</b> menu item of the context sensitive menu. Alternatively, the pause button in the toolbar can be used to pause the trace.
268
 
                </p>
269
 
                <p>
270
 
                        <img border="0" src="images/LTTngPauseTraceAction.png"/>
271
 
                </p>
272
 
                <h4 id="Stop_a_Trace">Stop a Trace</h4>
273
 
                <p>A non-started trace can be stopped by selecting the relevant trace, clicking the right mouse button and selecting the 
274
 
                        <b>Stop</b> menu item of the context sensitive menu. Alternatively, the stop button in the toolbar can be used to stop the trace. This will destroy the trace on the remote system, all allocated memory will be deallocated and all relevant trace files will be finalized. This step is need to be able to import a trace into the LTTng Perspective.
275
 
                </p>
276
 
                <p>
277
 
                        <img border="0" src="images/LTTngStopTraceAction.png"/>
278
 
                </p>
279
 
                <h4 id="Import_a_Trace_in_the_LTTng_Perspective">Import a Trace in the LTTng Perspective</h4>
280
 
                <p>A streaming or stopped trace can be imported to the LTTng Perspective for viewing by selecting the relevant trace, clicking the right mouse button and selecting the 
281
 
                        <b>Import To Project</b> menu item of the context sensitive menu. A new dialog box will show to select the LTTng Project. 
282
 
                </p>
283
 
                <p>
284
 
                        <img border="0" src="images/LTTngImportTraceAction.png"/>
285
 
                </p>
286
 
                <p>For local trace path (streamed to the host):</p>
287
 
                <p>
288
 
                        <img border="0" src="images/LTTngImportLocalTrace.png"/>
289
 
                </p>
290
 
                <p>For remote trace path (stored on the target):</p>
291
 
                <p>
292
 
                        <img border="0" src="images/LTTngImportRemoteTrace.png"/>
293
 
                </p>
294
 
                <ul>
295
 
                        <li>
296
 
                                <b>Import to project</b>: All existing LTTng tracing projects in the workspace are displayed in a table and the user has to select the destination. If no projects are available the user has to create a new project first (see 
297
 
                                <a href="LTTng-Perspective.html#Project_View">Project_View</a>)
298
 
                        </li>
299
 
                        <li>
300
 
                                <b>Trace name</b>: specifies the name that the imported trace shall have in the LTTng project. 
301
 
                        </li>
302
 
                        <li>
303
 
                                <b>Link only</b>: For a trace streamed to the host the user has the option to create a symbolic link to the trace path or, if the trace is stopped, to copy the trace into the LTTng project. 
304
 
                        </li>
305
 
                </ul>
306
 
                <p>After pressing button 
307
 
                        <b>Import</b> the trace will be stored in the selected project. For a trace stored on the target, it will be downloaded from the remote system.
308
 
                </p>
309
 
                <h4 id="Delete_a_Trace">Delete a Trace</h4>
310
 
                <p>A stopped trace can be deleted by selecting the relevant trace, clicking the right mouse button and selecting the 
311
 
                        <b>Delete</b> menu item of the context sensitive menu. A new dialog box will show for the user to confirm that the selected trace should be deleted. 
312
 
                </p>
313
 
                <p>
314
 
                        <img border="0" src="images/LTTngDeleteTraceAction.png"/>
315
 
                </p>
316
 
                <p>
317
 
                        <img border="0" src="images/LTTngDeleteTraceConfirm.png"/>
318
 
                </p>
319
 
                <h3 id="Property_View">Property View</h3>
320
 
                <p>The Property view displays the properties of the selected resource in the tree. For traces it displays all configuration parameters.</p>
321
 
                <p>
322
 
                        <img border="0" src="images/LTTngTraceProperties.png"/>
323
 
                </p><hr/>
324
 
                <table class="navigation" style="width: 100%;" border="0" summary="navigation">
325
 
                        <tr>
326
 
                                <td style="width: 20%" align="left">
327
 
                                        <a href="LTTng-Perspective.html" title="LTTng Perspective">
328
 
                                                <img alt="Previous" border="0" src="../../../images/prev.gif"/>
329
 
                                        </a>
330
 
                                </td>
331
 
                                <td style="width: 60%" align="center">
332
 
                                        <a href="User-Guide.html" title="LTTng Plug-in User Guide (legacy)">
333
 
                                                <img alt="LTTng Plug-in User Guide (legacy)" border="0" src="../../../images/home.gif"/>
334
 
                                        </a>
335
 
                                </td>
336
 
                                <td style="width: 20%" align="right">
337
 
                                        <a href="Limitations.html" title="Limitations">
338
 
                                                <img alt="Next" border="0" src="../../../images/next.gif"/>
339
 
                                        </a>
340
 
                                </td>
341
 
                        </tr>
342
 
                        <tr>
343
 
                                <td style="width: 20%" align="left" valign="top">LTTng Perspective</td>
344
 
                                <td style="width: 60%" align="center"></td>
345
 
                                <td style="width: 20%" align="right" valign="top">Limitations</td>
346
 
                        </tr>
347
 
                </table>
348
 
        </body>
349
 
</html>
 
 
b'\\ No newline at end of file'