+++ /dev/null
-<?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">
-<html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
- <title>LTTng Plug-in User Guide - LTTng Trace Control</title>
- <link type="text/css" rel="stylesheet" href="../../../book.css"/>
- </head>
- <body>
- <table class="navigation" style="width: 100%;" border="0" summary="navigation">
- <tr>
- <th style="width: 100%" align="center" colspan="3">LTTng Trace Control</th>
- </tr>
- <tr>
- <td style="width: 20%" align="left">
- <a href="LTTng-Perspective.html" title="LTTng Perspective">
- <img alt="Previous" border="0" src="../../../images/prev.gif"/>
- </a>
- </td>
- <td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right">
- <a href="Limitations.html" title="Limitations">
- <img alt="Next" border="0" src="../../../images/next.gif"/>
- </a>
- </td>
- </tr>
- <tr>
- <td style="width: 20%" align="left" valign="top">LTTng Perspective</td>
- <td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Limitations</td>
- </tr>
- </table><hr/>
- <h1 id="LTTng_Trace_Control">LTTng Trace Control</h1>
- <p>The functions to control the LTTng tracer (e.g. start, pause, resume), either locally or remotely, are available from the Remote Systems view (See
- <a href="LTTng-Trace-Control.html#Remote_Systems_View">Remote Systems View</a>, an RSE view).
- </p>
- <p>
- <img border="0" src="images/LTTngControlRsePerspective.png"/>
- </p>
- <h2 id="Remote_Systems_View">Remote Systems View</h2>
- <p>The LTTng tracer is controlled by the UI through an LTTng agent running on the tracer system.</p>
- <h2 id="Create_a_Remote_Connection">Create a Remote Connection</h2>
- <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 -> New -> Other ... -> Remote System Explorer -> Connection).</p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard1.png"/>
- </p>
- <p>For LTTng control, select connection type LTTng and press Next to define the connection.</p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard2.png"/>
- </p>
- <p>The
- <b>Host name</b> holds the IP address or DNS name of the remote system.
- The
- <b>Connection name</b> is the name to be displayed in the Remote Systems view.
- The
- <b>Description</b> is optional.
- Unless the user wants to use a specific
- <b>Profile</b>, the default profile is sufficient.
- The checkbox
- <b>Verfiy host name</b> enable or disables the verification of the remote system.
- </p>
- <p>By default, when pressing "Finish" the new connection contains the following sub systems: </p>
- <ul>
- <li>
- <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.
- </li>
- </ul>
- <ul>
- <li>
- <b>Processes</b>: This subsystem allows the user to browse and control processes on the remote system.
- </li>
- </ul>
- <ul>
- <li>
- <b>Shells</b>: This subsystem allows the user to open command shells to issue commands on the remote system.
- </li>
- </ul>
- <ul>
- <li>
- <b>Terminals</b>: This subsystem allows the user to open command terminals to issue commands on the remote system.
- </li>
- </ul>
- <ul>
- <li>
- <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.
- </li>
- </ul>
- <p>The user has the possibility to configure or omit the subsystems
- <b>Files</b>,
- <b>Processes</b>,
- <b>Shells</b> and
- <b>Terminals</b> by pressing "Next" and deselecting the relevant subsystem.
- </p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard3.png"/>
- </p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard4.png"/>
- </p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard5.png"/>
- </p>
- <p>
- <img border="0" src="images/LTTngNewConnectionWizard6.png"/>
- </p>
- <p>After finishing the new connection the Remote System view will be updated:</p>
- <p>
- <img border="0" src="images/LTTngRemoteSystemsNewConnection.png"/>
- </p>
- <h3 id="General">General</h3>
- <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>
- <h3 id="Connect_to_Remote_Host">Connect to Remote Host</h3>
- <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>
- <p>
- <img border="0" src="images/LTTngConnectToRemoteSystem.png"/>
- </p>
- <p>A login dialog will be opened, where the user needs to specify the user name and password.</p>
- <p>
- <img border="0" src="images/LTTngLoginDialog.png"/>
- </p>
- <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>
- <p>
- <img border="0" src="images/LTTngRemoteSystemsWithLTTng.png"/>
- </p>
- <h3 id="Configure_Kernel_Markers">Configure Kernel Markers</h3>
- <p>The marker of a given target can be configured by selecting the kernel target "0", clicking the right mouse button and selecting the
- <b>Configure Markers</b> menu item of the context sensitive menu.
- </p>
- <p>
- <img border="0" src="images/LTTngConfigureMarkersAction.png"/>
- </p>
- <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>
- <p>
- <img border="0" src="images/LTTngConfigureMarkersDialog.png"/>
- </p>
- <h3 id="Create_a_New_Kernel_Trace">Create a New Kernel Trace</h3>
- <p>A new trace can be created by selecting the kernel target "0", clicking the right mouse button and selecting the
- <b>New Trace</b> menu item of the context sensitive menu.
- </p>
- <p>
- <img border="0" src="images/LTTngCreateNewTraceAction.png"/>
- </p>
- <p>A new dialog box will show for the configuration of the relevant parameter. </p>
- <p>
- <img border="0" src="images/LTTngCreateNewTraceDialog.png"/>
- </p>
- <ul>
- <li>
- <b>Name</b>: holds the name of the trace.
- </li>
- </ul>
- <ul>
- <li>
- <b>Transport type</b>: it is set by default to "relay" and cannot be changed.
- </li>
- </ul>
- <ul>
- <li>
- <b>Trace Location</b>:
- <ul>
- <li>
- <b>Target</b>: means that the trace is stored on the remote system where the trace is collected.
- </li>
- <li>
- <b>Host</b>: means that the trace is transfered to the local host where the eclipse application is running.
- </li>
- <li>
- <b>Trace path</b>: holds the path where the trace shall be stored. The
- <b>Browse</b> button is only active for
- <b>Local</b> and can be used to open a dialog box to select the trace path directory.
- </li>
- </ul>
- </li>
- </ul>
- <ul>
- <li>
- <b>Tracing project</b>: defines the LTTng Tracing project where a streaming (host) trace will be added at trace start.
- </li>
- <li>
- <b>Number of lttd threads</b>: defines the number of threads to be used by the ltt daemon during tracing.
- </li>
- <li>
- <b>Append</b>: can be used to append the new trace to an existing trace.
- </li>
- <li>
- <b>Trace mode</b>: can be either
- <b>Normal</b> or
- <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.
- </li>
- </ul>
- <p>If all inputs are valid the
- <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.
- </p>
- <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>
- <p>
- <img border="0" src="images/LTTngRemoteSystemConfiguredTrace.png"/>
- </p>
- <h3 id="Configure_a_Trace_and_Trace_Channels">Configure a Trace and Trace Channels</h3>
- <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>
- <p>
- <img border="0" src="images/LTTngConfigureTraceAction.png"/>
- </p>
- <p>A new dialog box with a wizard page will show for the configuration of the relevant parameter. For explanation of the parameters see
- <a href="LTTng-Trace-Control.html#Create_a_New_Kernel_Trace">Create_a_New_Kernel_Trace</a>
- </p>
- <p>
- <img border="0" src="images/LTTngConfigureTraceDialog.png"/>
- </p>
- <p>After entering valid parameters the
- <b>Next</b> and
- <b>Finish</b> buttons will be active. To finalize the configuration of the trace select the
- <b>Finish</b> button. To configure channel parameters select the
- <b>Next</b> button. A new wizard page will show for the configuration of channel parameters. For provider
- <b>kernel</b> the following display will show:
- </p>
- <p>
- <img border="0" src="images/LTTngConfigureChannelsKernelDialog.png"/>
- </p>
- <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>
- <p>
- <img border="0" src="images/LTTngConfigureChannelsActions.png"/>
- </p>
- <p>For provider
- <b>ust</b> only the channel parameter
- <b>Channel Timer</b> can be configured and the following display will show after selecting the
- <b>Next</b> button of the
- <b>Trace configuration</b> page.
- </p>
- <p>
- <img border="0" src="images/LTTngConfigureChannelsUstDialog.png"/>
- </p>
- <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
- <b>Finish</b> button.
- </p>
- <ul>
- <li>
- <b>Name</b> column: holds the name of the channel.
- </li>
- <li>
- <b>Enabled</b> column: a checkbox indicates whether the channel is enabled or not.
- </li>
- <li>
- <b>Buffer Override</b> column: a checkbox indicates whether channel buffer overwrite is enabled or not.
- </li>
- <li>
- <b>Number of Sub Buffers</b> column: holds the number of sub-buffers of the channel.
- </li>
- <li>
- <b>Sub Buffer size</b> column: holds the size of the sub-buffer of the channel (in bytes).
- </li>
- <li>
- <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
- <b>ust</b> only supports a single timer for all channels, traces and targets it is monitoring.
- </li>
- </ul>
- <p>Please note that the
- <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.
- </p>
- <h3 id="Start_a_Trace">Start a Trace</h3>
- <p>A configured or paused trace can be started by selecting the kernel trace, clicking the right mouse button and selecting the
- <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.
- </p>
- <p>
- <img border="0" src="images/LTTngStartTraceAction.png"/>
- </p>
- <h3 id="Pause_a_Trace">Pause a Trace</h3>
- <p>A started trace can be paused by selecting the relevant trace, clicking the right mouse button and selecting the
- <b>Pause</b> menu item of the context sensitive menu. Alternatively, the pause button in the toolbar can be used to pause the trace.
- </p>
- <p>
- <img border="0" src="images/LTTngPauseTraceAction.png"/>
- </p>
- <h3 id="Stop_a_Trace">Stop a Trace</h3>
- <p>A non-started trace can be stopped by selecting the relevant trace, clicking the right mouse button and selecting the
- <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.
- </p>
- <p>
- <img border="0" src="images/LTTngStopTraceAction.png"/>
- </p>
- <h3 id="Import_a_Trace_in_the_LTTng_Perspective">Import a Trace in the LTTng Perspective</h3>
- <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
- <b>Import To Project</b> menu item of the context sensitive menu. A new dialog box will show to select the LTTng Project.
- </p>
- <p>
- <img border="0" src="images/LTTngImportTraceAction.png"/>
- </p>
- <p>For local trace path (streamed to the host):</p>
- <p>
- <img border="0" src="images/LTTngImportLocalTrace.png"/>
- </p>
- <p>For remote trace path (stored on the target):</p>
- <p>
- <img border="0" src="images/LTTngImportRemoteTrace.png"/>
- </p>
- <ul>
- <li>
- <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
- <a href="LTTng-Perspective.html#Project_View">Project_View</a>)
- </li>
- <li>
- <b>Trace name</b>: specifies the name that the imported trace shall have in the LTTng project.
- </li>
- <li>
- <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.
- </li>
- </ul>
- <p>After pressing button
- <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.
- </p>
- <h3 id="Delete_a_Trace">Delete a Trace</h3>
- <p>A stopped trace can be deleted by selecting the relevant trace, clicking the right mouse button and selecting the
- <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.
- </p>
- <p>
- <img border="0" src="images/LTTngDeleteTraceAction.png"/>
- </p>
- <p>
- <img border="0" src="images/LTTngDeleteTraceConfirm.png"/>
- </p>
- <h2 id="Property_View">Property View</h2>
- <p>The Property view displays the properties of the selected resource in the tree. For traces it displays all configuration parameters.</p>
- <p>
- <img border="0" src="images/LTTngTraceProperties.png"/>
- </p><hr/>
- <table class="navigation" style="width: 100%;" border="0" summary="navigation">
- <tr>
- <td style="width: 20%" align="left">
- <a href="LTTng-Perspective.html" title="LTTng Perspective">
- <img alt="Previous" border="0" src="../../../images/prev.gif"/>
- </a>
- </td>
- <td style="width: 60%" align="center">
- <a href="User-Guide.html" title="LTTng Plug-in User Guide">
- <img alt="LTTng Plug-in User Guide" border="0" src="../../../images/home.gif"/>
- </a>
- </td>
- <td style="width: 20%" align="right">
- <a href="Limitations.html" title="Limitations">
- <img alt="Next" border="0" src="../../../images/next.gif"/>
- </a>
- </td>
- </tr>
- <tr>
- <td style="width: 20%" align="left" valign="top">LTTng Perspective</td>
- <td style="width: 60%" align="center"></td>
- <td style="width: 20%" align="right" valign="top">Limitations</td>
- </tr>
- </table>
- </body>
-</html>
\ No newline at end of file
</tr>
</table><hr/>
<h1 id="LTTng_Tracer_Control">LTTng Tracer Control</h1>
- <p>The LTTng Eclipse integration supports LTTng Tracer toolchains version v0.x as well as the version v2.0 (or later). </p>
+ <p>The LTTng Eclipse integration supports LTTng Tracer toolchains version v0.x as well as the version v2.0 (or later).</p>
<h2 id="LTTng_Tracer_Control_.28LTTng_Tracer_Toolchain_v0.x.29">LTTng Tracer Control (LTTng Tracer Toolchain v0.x)</h2>
<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
<a href="LTTng-Tracer-Control.html#Remote_Systems_View">Remote Systems View</a>, an RSE view).
<p>
<img border="0" src="images/LTTngTraceProperties.png"/>
</p>
- <h2 id="LTTng_Tracer_Control_.28LTTng_Tracer_Toolchain_v2.0_and_later.29">LTTng Tracer Control (LTTng Tracer Toolchain v2.0 and later)</h2>
- <p>Note: This feature is not available yet but will be delivered soon.</p>
+ <h2 id="LTTng_Tracer_Control_.28LTTng_Tracer_Toolchain_v2.0.29">LTTng Tracer Control (LTTng Tracer Toolchain v2.0)</h2>
+ <p>
+ <b>Note: This feature is not available yet but will be delivered soon.</b>
+ </p>
<p>The LTTng Tracer Control in Eclipse for the LTTng Tracer toolchain version v2.0 (or later) is done using SSH and requires an SSH server to be running on the remote host. For the SSH connection the SSH implementation of RSE is used. For that a new System Type was defined using the corressponding RSE extension. The functions to control the LTTng tracer (e.g. start and stop), either locally or remotely, are available from a dedicated Control View.</p>
<h3 id="Control_View">Control View</h3>
<p>To open the Control View, select '
</p>
<h4 id="Creating_a_New_Connection_to_a_Remote_Host">Creating a New Connection to a Remote Host</h4>
<p>To connect to a remote host, select the
- <b>New Connection</b> buttion in the Control View.
+ <b>New Connection</b> button in the Control View.
</p>
<p>
<img border="0" src="images/LTTngControlViewConnect.png"/>
<p>
<img border="0" src="images/LTTng2ControlViewDelete.png"/>
</p>
+ <h4 id="Creating_a_Tracing_Session">Creating a Tracing Session</h4>
+ <p>To create a tracing session, select the tree node
+ <b>Sessions</b> and press the right mouse button. Then select the
+ <b>Create Session</b> button of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2CreateSessionAction.png"/>
+ </p>
+ <p>A dialog box will open for entering information about the session to be created. </p>
+ <p>
+ <img border="0" src="images/LTTng2CreateSessionDialog.png"/>
+ </p>
+ <p>Fill in the
+ <b>Session Name</b> and optionally the
+ <b>Session Path</b> and press
+ <b>Ok</b>. Upon successful operation a new session will be created and added under the tree node
+ <b>Sessions</b>.
+ </p>
+ <h4 id="Creating_Channels_-_General">Creating Channels - General</h4>
+ <p>Creating channels can be done using a session tree node when the domain hasn't be created in the session or, alternatively on a domain tree node of a session in case the domain is already available. </p>
+ <h4 id="Creating_Channels_On_Session_Level">Creating Channels On Session Level</h4>
+ <p>To create a channel, select the tree node of the relevant session and press the right mouse button. Then select the
+ <b>Create Channel</b> button of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2CreateChannelAction.png"/>
+ </p>
+ <p>A dialog box will open for entering information about the channel to be created.</p>
+ <p>
+ <img border="0" src="images/LTTng2CreateChannelDialog.png"/>
+ </p>
+ <p>By default the domain
+ <b>Kernel</b> is selected and the corresponding default values are shown. To create a UST channel, select
+ <b>UST</b> under the domain section. To get the default values of UST, then press button
+ <b>Default</b>.
+ </p>
+ <p>If required update the following channel information and then press
+ <b>Ok</b>.
+ </p>
+ <ul>
+ <li>
+ <b>Channel Name</b>: The name of the channel.
+ </li>
+ <li>
+ <b>Number of Sub Buffers</b>: The number of sub-buffers of the channel.
+ </li>
+ <li>
+ <b>Overwrite Mode</b>: The channel overwrite mode (
+ <b>true</b> or
+ <b>false</b>)
+ </li>
+ <li>
+ <b>Read Timer Interval</b>: The read timer interval.
+ </li>
+ <li>
+ <b>Sub Buffer size</b>: The size of the sub-buffers of the channel (in bytes).
+ </li>
+ <li>
+ <b>Switch Timer Interval</b>: The switch timer interval.
+ </li>
+ </ul>
+ <p>Upon successful operation, the requested domain will be created under the session tree node as well as the requested channel will be added under the domain. The channel will be
+ <b>ENABLED</b>.
+ </p>
+ <h4 id="Creating_Channels_On_Domain_Level">Creating Channels On Domain Level</h4>
+ <p>Once a domain is available, channels can be created directly using the domain. To create a channel under an existing domain, select the tree node of the relevant domain and press the right mouse button. Then select the
+ <b>Create Channel</b> button of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2CreateChannelOnDomainAction.png"/>
+ </p>
+ <p>The channel creation dialog box will open for entering information about the channel to be created. Note that the domain is pre-selected and cannot be changed.</p>
+ <p>
+ <img border="0" src="images/LTTng2CreateChannelOnDomainDialog.png"/>
+ </p>
+ <p>Fill the relevant information and press
+ <b>Ok</b>.
+ </p>
+ <h4 id="Enabling_and_Disabling_Channels">Enabling and Disabling Channels</h4>
+ <p>To disable one or more enabled channels, select the tree nodes of the relevant channels and press the right mouse button. Then select the
+ <b>Disable Channel</b> menu item of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2DisableChannelAction.png"/>
+ </p>
+ <p>Upon successsful operation, the selected channels will be
+ <b>DISABLED</b> and the icons for the channels will be updated.
+ </p>
+ <p>To enable one or more disabled channels, select the tree nodes of the relevant channels and press the right mouse button. Then select the
+ <b>Enable Channel</b> menu item of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnableChannelAction.png"/>
+ </p>
+ <p>Upon successsful operation, the selected channels will be
+ <b>ENABLED</b> and the icons for the channels will be updated.
+ </p>
+ <h4 id="Enabling_Events_-_General">Enabling Events - General</h4>
+ <p>Enabling events can be done using different levels in the tree node. It can be done on the session, domain level and channel level. For the case of session or domain, i.e. when no specific channels is assigned then enabling of events is done on the default channel with the name
+ <b>channel0</b> which created, if not already exists, by the LTTng tracer control on the server side.
+ </p>
+ <h4 id="Enabling_Kernel_Events_On_Session_Level">Enabling Kernel Events On Session Level</h4>
+ <p>To enable events, select the tree node of the relevant session and press the right mouse button. Then select the
+ <b>Enable Event (default channel)</b> button of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EventOnSessionAction.png"/>
+ </p>
+ <p>A dialog box will open for entering information about events to be enabled.</p>
+ <p>
+ <img border="0" src="images/LTTng2EventOnSessionDialog.png"/>
+ </p>
+ <p>By default the domain
+ <b>Kernel</b> is selected and the kernel specific data sections are created. From this dialog box kernel
+ <b>Tracepoint</b> events,
+ <b>System calls (Syscall)</b>, a
+ <b>Dynamic Probe</b> or a
+ <b>Dynamic Function entry/return</b> probe can be enabled. Note that events of one of these types at a time can be enabled.
+ </p>
+ <p>To enable
+ <b>Tracepoint</b> events, first select the corresponding
+ <b>Select</b> button, then select either all tracepoins (select
+ <b>All</b>) or select selectively one or more tracepoints in the displayed tree of tracepoints and finally press
+ <b>Ok</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2TracepointEventsDialog.png"/>
+ </p>
+ <p>Upon successful operation, the domain
+ <b>Kernel</b> will be created in the tree (if neccessary), the default channel with name "channel0" will be added under the domain (if necessary) as well as all requested events of type
+ <b>TRACEPOINT</b> under the channel. The channel and events will be
+ <b>ENABLED</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledKernelTracepoints.png"/>
+ </p>
+ <p>To enable all
+ <b>Syscalls</b>, select the corresponding
+ <b>Select</b> button and press
+ <b>Ok</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2SyscallsDialog.png"/>
+ </p>
+ <p>Upon successful operation, the event with the name
+ <b>syscalls</b> and event type
+ <b>SYSCALL</b> will be added under the default channel (channel0). If necessary the domain
+ <b>Kernel</b> and the channel
+ <b>channel0</b> will be created.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledKernelSyscalls.png"/>
+ </p>
+ <p>To enable a
+ <b>Dynamic Probe</b> event, select the corresponding
+ <b>Select</b> button, fill the
+ <b>Event Name</b> and
+ <b>Probe</b> fields and press
+ <b>Ok</b>. Note that the probe can be an address, symbol or a symbol+offset where the address and offset can be octal (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...).
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2ProbeEventDialog.png"/>
+ </p>
+ <p>Upon successful operation, the dynamic probe event with the given name and event type
+ <b>PROBE</b> will be added under the default channel (channel0). If necessary the domain
+ <b>Kernel</b> and the channel
+ <b>channel0</b> will be created.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledKernelProbeEvent.png"/>
+ </p>
+ <p>To enable a
+ <b>Dynamic Function entry/return Probe</b> event, select the corresponding
+ <b>Select</b> button, fill the
+ <b>Event Name</b> and
+ <b>Function</b> fields and press
+ <b>Ok</b>. Note that the funtion probe can be an address, symbol or a symbol+offset where the address and offset can be octal (0NNN...), decimal (NNN...) or hexadecimal (0xNNN...).
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2ProbeEventDialog.png"/>
+ </p>
+ <p>Upon successful operation, the dynamic function probe event with the given name and event type
+ <b>PROBE</b> will be added under the default channel (channel0). If necessary the domain
+ <b>Kernel</b> and the channel
+ <b>channel0</b> will be created.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledFunctionProbeEvent.png"/>
+ </p>
+ <h4 id="Enabling_UST_Events_On_Session_Level">Enabling UST Events On Session Level</h4>
+ <p>For enabling UST events, first open the enable events dialog as described in section
+ <a href="LTTng-Tracer-Control.html#Enabling_Kernel_Events_On_Session_Level">Enabling Kernel Events On Session Level</a> and select domain
+ <b>UST</b>.
+ </p>
+ <p>To enable
+ <b>Tracepoint</b> events, first select the corresponding
+ <b>Select</b> button, then select either all tracepoins (select
+ <b>All</b>) or select selectively one or more tracepoints in the displayed tree of tracepoints and finally press
+ <b>Ok</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2UstTracepointEventsDialog.png"/>
+ </p>
+ <p>Upon successful operation, the domain
+ <b>UST global</b> will be created in the tree (if neccessary), the default channel with name "channel0" will be added under the domain (if necessary) as well as all requested events under the channel. The channel and events will be
+ <b>ENABLED</b>. Note that for the case that
+ <b>All</b> tracepoints were selected the wildcard
+ <b>*</b> is used which will be shown in the Control View as below.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledAllUstTracepoints.png"/>
+ </p>
+ <p>For UST it is possible to enable
+ <b>Tracepoint</b> events using a wildcard. To enable
+ <b>Tracepoint</b> events with a wildcard, select first the corresponding
+ <b>Select</b> button, fill the
+ <b>Wildcard</b> field and press
+ <b>Ok</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2UstWildcardEventsDialog.png"/>
+ </p>
+ <p>Upon successful operation, the event with the given wildcard and event type
+ <b>TRACEPOINT</b> will be added under the default channel (channel0). If necessary the domain
+ <b>UST global</b> and the channel
+ <b>channel0</b> will be created.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledUstWildcardEvents.png"/>
+ </p>
+ <p>For UST it is possible to enable
+ <b>Tracepoint</b> events using log levels. To enable
+ <b>Tracepoint</b> events using log levels, select first the corresponding
+ <b>Select</b> button, select a log level from the drop down menu, fill in the relevant information (see below) and press
+ <b>Ok</b>.
+ </p>
+ <ul>
+ <li>
+ <b>Event Name</b>: Name to display
+ </li>
+ <li>
+ <b>loglevel</b>: To specify if a range of log levels (0 to selected log level) shall be configured
+ </li>
+ <li>
+ <b>loglevel-only</b>: To specify that only the specified log level shall be configured
+ </li>
+ </ul>
+ <p>
+ <img border="0" src="images/LTTng2UstLoglevelEventsDialog.png"/>
+ </p>
+ <p>Upon successful operation, the event with the given event name and event type
+ <b>TRACEPOINT</b> will be added under the default channel (channel0). If necessary the domain
+ <b>UST global</b> and the channel
+ <b>channel0</b> will be created.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnabledUstLoglevelEvents.png"/>
+ </p>
+ <h4 id="Enabling_Events_On_Domain_Level">Enabling Events On Domain Level</h4>
+ <p>Kernel events can also be enabled on the domain level. For that select the relevant domain tree node, click the right mouse button and the select
+ <b>Enable Event (default channel)</b>. A new dialog box will open for providing information about the events to be enabled. Depending on the domain,
+ <b>Kernel</b> or
+ <b>UST global</b>, the domain specifc fields are shown and the domain selector is preselected and read-only.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EventOnDomainAction.png"/>
+ </p>
+ <p>To enable events for domain
+ <b>Kernel</b> follow the instructions in section
+ <a href="LTTng-Tracer-Control.html#Enabling_Kernel_Events_On_Session_Level">Enabling Kernel Events On Session Level</a>, for domain
+ <b>UST global</b>
+ <a href="LTTng-Tracer-Control.html#Enabling_UST_Events_On_Session_Level">Enabling UST Events On Session Level</a>.
+ </p>
+ <p>When enabling events on the domain level, the events will be add to the default channel
+ <b>channel0</b>. This channel will be created by on the server side if neccessary.
+ </p>
+ <h4 id="Enabling_Events_On_Channel_Level">Enabling Events On Channel Level</h4>
+ <p>Kernel events can also be enabled on the channel level. If necessary, create a channel as described in sections
+ <a href="LTTng-Tracer-Control.html#Creating_Channels_On_Session_Level">Creating Channels On Session Level</a> or
+ <a href="LTTng-Tracer-Control.html#Creating_Channels_On_Domain_Level">Creating Channels On Domain Level</a>.
+ </p>
+ <p>Then select the relevant channel tree node, click the right mouse button and the select
+ <b>Enable Event</b>. A new dialog box will open for providing information about the events to be enabled. Depending on the domain,
+ <b>Kernel</b> or
+ <b>UST global</b>, the domain specifc fields are shown and the domain selector is preselected and read-only.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EventOnChannelAction.png"/>
+ </p>
+ <p>To enable events for domain
+ <b>Kernel</b> follow the instructions in section
+ <a href="LTTng-Tracer-Control.html#Enabling_Kernel_Events_On_Session_Level">Enabling Kernel Events On Session Level</a>, for domain
+ <b>UST global</b>
+ <a href="LTTng-Tracer-Control.html#Enabling_UST_Events_On_Session_Level">Enabling UST Events On Session Level</a>.
+ </p>
+ <p>When enabling events on the channel level, the events will be add to the selected channel. </p>
+ <h4 id="Enabling_and_Disabling_Events">Enabling and Disabling Events</h4>
+ <p>To disable one or more enabled events, select the tree nodes of the relevant events and click the right mouse button. Then select
+ <b>Disable Event</b> menu item in the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2DisableEventAction.png"/>
+ </p>
+ <p>Upon successsful operation, the selected events will be
+ <b>DISABLED</b> and the icons for these events will be updated.
+ </p>
+ <p>To enable one or more disabled events, select the tree nodes of the relevant events and press the right mouse button. Then select the
+ <b>Enable Event</b> menu item of the context-sensitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2EnableEventAction.png"/>
+ </p>
+ <p>Upon successsful operation, the selected events will be
+ <b>ENABLED</b> and the icons for these events will be updated.
+ </p>
+ <p>
+ <b>Note</b>: There is currently a limitiation for kernel event of type
+ <b>SYSCALL</b>. This kernel event can not be disabled. An error will appear when trying to disable this type of event. A work-around for that is to have the syscall event in a separate channel and disable the channel instead of the event.
+ </p>
+ <h4 id="Enabling_Tracepoint_Events_From_Provider">Enabling Tracepoint Events From Provider</h4>
+ <p>It is possible to enable events of type
+ <b>Tracepoint</b> directly from the providers and assign the enabled event to a session and channel. Before doing that a session has to be created as described in section
+ <a href="LTTng-Tracer-Control.html#Creating_a_Tracing_Session">Creating a Tracing Session</a>. Also, if other than default channel
+ <b>channel0</b> is required, create a channel as described in sections
+ <a href="LTTng-Tracer-Control.html#Creating_Channels_On_Session_Level">Creating Channels On Session Level</a> or
+ <a href="LTTng-Tracer-Control.html#Creating_Channels_On_Domain_Level">Creating Channels On Domain Level</a>.
+ </p>
+ <p>To assign tracepoint events to a session and channel, select the events to be enabled under the provider (e.g. provider
+ <b>Kernel</b>, click right mouse button and then select
+ <b>Enable Event</b> menu item from the context sesitive menu.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2AssignEventAction.png"/>
+ </p>
+ <p>A new display will open for defining the session and channel. </p>
+ <p>
+ <img border="0" src="images/LTTng2AssignEventDialog.png"/>
+ </p>
+ <p>Select a session from the
+ <b>Session List</b> drop-down menu, a channel from the
+ <b>Channel List</b> drop-down menu and the press
+ <b>Ok</b>. Upon successful operation, the selected events will be added to the selected session and channel of the domain that the selected provider belongs to. In case that there was no channel available, the domain and the default channel
+ <b>channel0</b> will be created for corresponding session. The newly added events will be
+ <b>ENABLED</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2AssignedEvents.png"/>
+ </p>
+ <h4 id="Start_Tracing">Start Tracing</h4>
+ <p>To start tracing, select one or more sessions to start in the Control View and press the
+ <b>Start</b> button. Alternatively, press the right mouse button on the session tree nodes. A context-sensitive menu will show. Then select the
+ <b>Start</b> menu item.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2StartTracingAction.png"/>
+ </p>
+ <p>Upon successful operation, the tracing session will be
+ <b>ACTIVE</b> and the icon of the session will be updated.
+ </p>
+ <h4 id="Stop_Tracing">Stop Tracing</h4>
+ <p>To stop tracing, select one or more sessions to stop in the Control View and press the
+ <b>Stop</b> button. Alternatively, click the right mouse button on the session tree nodes. A context-sensitive menu will show. Then select the
+ <b>Stop</b> menu item.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2StopTracingAction.png"/>
+ </p>
+ <p>Upon successful operation, the tracing session will be
+ <b>INACTIVE</b> and the icon of the session will be updated.
+ </p>
+ <h4 id="Destroying_a_Tracing_Session">Destroying a Tracing Session</h4>
+ <p>To destroy a tracing session, select one or more sessions to destroy in the Control View and press the
+ <b>Destroy</b> button. Alternatively, click the right mouse button on the session tree node. A context-sensitive menu will show. Then select the
+ <b>Destroy</b> menu item. Note that the session has to be
+ <b>INACTIVE</b> for this operation.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2DestroySessionAction.png"/>
+ </p>
+ <p>A confirmation dialog box will open. Click on
+ <b>Ok</b> to destroy the session otherwise click on
+ <b>Cancel</b>.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2DestroyConfirmationDialog.png"/>
+ </p>
+ <p>Upon successful operation, the tracing session will be destroyed and removed from the tree.</p>
+ <h4 id="Refreshing_the_Node_Information">Refreshing the Node Information</h4>
+ <p>To refresh the remote host information, select any node in the tree of the Control View and press the
+ <b>Refresh</b> button. Alternatively, click the right mouse button on any tree node. A context-sensitive menu will show. Then select the
+ <b>Refresh</b> menu item.
+ </p>
+ <p>
+ <img border="0" src="images/LTTng2RefreshAction.png"/>
+ </p>
+ <p>Upon successful operation, the tree in the Control View will be refreshed with the remote host configuration.</p>
<h3 id="Property_View_2">Property View</h3>
<p>The Control View provides property information of selected tree component. Depending on the selected tree component different properties are displayed in the property view. For example, when selecting the node level the property view will be filled as follewed:</p>
<p>
<img border="0" src="images/LTTng2PropertyView.png"/>
</p>
<p>
- <i>List of properties</i>:
+ <b>List of properties</b>:
</p>
<ul>
<li>
</li>
<li>
<b>Event Type</b>: The event type (
- <b>TRACEPOINT</b>).
+ <b>TRACEPOINT</b> only).
</li>
<li>
<b>Log Level</b>: The log level of the event.
</li>
<li>
<b>Event Type</b>: The event type (
- <b>TRACEPOINT</b>).
+ <b>TRACEPOINT</b>,
+ <b>SYSCALL</b> or
+ <b>PROBE</b>)..
</li>
<li>
<b>Log Level</b>: The log level of the event.
projects / deliverable / tracecompass.git / commitdiff
