1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<?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>SystemTap GUI User Guide</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">SystemTap GUI User Guide</th>
</tr>
<tr>
<td style="width: 20%" align="left"></td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
<a href="SystemTap-IDE.html" title="SystemTap IDE">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
</tr>
<tr>
<td style="width: 20%" align="left" valign="top"></td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">SystemTap IDE</td>
</tr>
</table><hr/>
<h1 id="Overview">Overview</h1>
<p>Welcome to the SystemTap GUI Help pages. This section is intended to provide users with information and links about the SystemTap scripting language itself, in addition to a brief introduction to SystemTap GUI's structure for new users and a brief explanation of SystemTap.</p>
<h2 id="SystemTap_GUI.27s_Plugin_Design">SystemTap GUI's Plugin Design</h2>
<p>SystemTap GUI was built with a modular goal in mind, namely, to provide the application as a series of plugins so that users may obtain just the ones they need without having to use a heavy-weight application should if they didn't need to. The most common example of this is to ship the Dashboard plugin independently, allowing non-SystemTap savvy users the ability to execute modules without having to write any scripts. The application in its complete state includes three perspective, each with a specific goal:</p>
<ul>
<li>
<b>IDE Perspective</b> - Contains script editor and Function, Kernel Source, and Probe Alias browsers to assist in the creation and editting of SystemTap scripts.
</li>
<li>
<b>Graphics Perspective</b> - Graphs data from SystemTap scripts in the desired graph form according to a regular expression passed to interpret the data.
</li>
<li>
<b>Dashboard Perspective</b> - Allows the execution of modules, which are scripts with associated metadata that open one or more graphs in a dashboard environment that update in real time.This perspective is still under development
</li>
</ul>
<p>Each perspective has full documentation associated with it and is packaged in the respective plugin.</p>
<h2 id="Systemtap">Systemtap</h2>
<p>SystemTap provides free software (GPL) infrastructure to simplify the gathering of information about the running Linux kernel. This assists diagnosis of a performance or functional problem. SystemTap eliminates the need for the developer to go through the tedious and disruptive instrument, recompile, install, and reboot sequence that may be otherwise required to collect data.</p>
<p>SystemTap provides a simple command line interface and scripting language for writing instrumentation for a live running kernel. The internal tapset library as well as the published samples can be used to aid reuse and abstraction.</p>
<p>Current project members include Red Hat, IBM, Intel, and Hitachi.</p>
<h2 id="Configuration_Tutorial">Configuration Tutorial</h2>
<p>This tutorial is written to guide a new SystemTap user through some basic post-installation setup in
order to get the most out of the application.</p>
<h3 id="Requirements">Requirements</h3>
<p>
<b>Hardware Requirements:</b>
</p>
<ul>
<li>x86, x86_64, ppc64, s390</li>
</ul>
<p>
<b>Sotware Requirements:</b>
</p>
<ul>
<li>
<ul>
<li>Linux kernel v2.6.14 or newer</li>
<li>Eclipse v3.4.1</li>
<li>SystemTap v0.7 or newer</li>
</ul>
</li>
</ul>
<h3 id="Kernel_Source_Location">Kernel Source Location</h3>
<p>In order to use the kernel source browser you'll need to point it to the kernel source initially. Do this by either selecting the Kernel Source Browser in the browser pane or by going to
<b><u>W</u>indow-><u>P</u>references</b>, then going to the SystemTap->IDE->'Kernel Source Path' tab and setting the location there. This configuration detail is relevent to the IDE Perspective only.
</p>
<h3 id="Tutorials">Tutorials</h3>
<p>If you haven't already, you will want to take the IDE and Graphing tutorials. You can find them in the Getting Started section of each perspective's help pages. These tutorial provides fundamental knowledge on graphing in SystemTap GUI.</p>
<h3 id="Preferences_.28Optional.29">Preferences (Optional)</h3>
<p>Finally, you may want to set certain non-essential preferences before using SystemTap GUI regularly. Use
<b><u>W</u>indow-><u>P</u>references</b> to access the Preferences page.
</p>
<p>Of particular note are
Logging->Log To, SystemTap->Environment Variables, SystemTap->Graphing->Refresh Delay,
SystemTap->IDE->Editor->Syntax Coloring.</p>
<h2 id="Links_to_SystemTap_Resources">Links to SystemTap Resources</h2>
<p>The following links contain information specific to the SystemTap scripting language.</p>
<ul>
<li>
<b>SystemTap website</b> -
<a href="http://sourceware.org/systemtap/">http://sourceware.org/systemtap/</a>
</li>
<li>
<b>SystemTap wiki</b> -
<a href="http://sourceware.org/systemtap/wiki">http://sourceware.org/systemtap/wiki</a>
</li>
<li>
<b>SystemTap tutorial</b> -
<a href="http://sourceware.org/systemtap/tutorial/">http://sourceware.org/systemtap/tutorial/</a>
</li>
<li>
<b>Full list of documentation</b> -
<a href="http://sourceware.org/systemtap/documentation.html">http://sourceware.org/systemtap/documentation.html</a>
</li>
</ul>
<p>The following links are related to the SystemTap GUI project:</p>
<ul>
<li>
<b>SystemTap GUI Sourceforge</b> -
<a href="https://sourceforge.net/projects/stapgui/">https://sourceforge.net/projects/stapgui/</a>
</li>
<li>
<b>SystemTap GUI Homepage</b> -
<a href="http://stapgui.sourceforge.net/">http://stapgui.sourceforge.net/</a>
</li>
</ul><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<td style="width: 20%" align="left"></td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
<a href="SystemTap-IDE.html" title="SystemTap IDE">
<img alt="Next" border="0" src="../../../images/next.gif"/>
</a>
</td>
</tr>
<tr>
<td style="width: 20%" align="left" valign="top"></td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">SystemTap IDE</td>
</tr>
</table>
</body>
</html>
|
