Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 1d80d4428cb868228441997c4b0379525f10a42d (plain) (blame)
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 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 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 plug-in 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 plug-in's structure for new users and a brief explanation of SystemTap.</p>
		<h2 id="The_SystemTap_Plugin">The SystemTap Plugin</h2>
		<p>The SystemTap Plugin is designed to help you create, edit, and run Systemtap scripts. It also provides the ability to graph the output of your scripts and run Systemtap scripts remotely.</p>
		<p>It provides the 
			<b>SystemTap IDE</b> perspective. When in this perspective you should be able to see the Probe view, the Function view, and the Project Explorer. You should also be able to create Systemtap Scripts.
		</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="Installing">Installing</h2>
		<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
						<ul>
							<li>Linux kernel devel and debuginfo packages</li>
						</ul>
					</li>
					<li>Eclipse v3.8/v4.2 or newer</li>
					<li>SystemTap v0.7 or newer</li>
				</ul>
			</li>
		</ul>
		<p>Once  all dependencies are installed, the easiest way to install the SystemTap plug-in for Eclipse is through the 
			<b>
				<i>Software Updates and Add-ons</i>
			</b> menu. For information on how to use this menu, refer to 
			<a href="http://wiki.eclipse.org/Linux_Tools_Project/PluginInstallHelp#Installing_Updates_From_the_Linux_Tools_Update_Site">this link</a>.
		</p>
		<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-&gt;<u>P</u>references</b>, then going to the SystemTap-&gt;IDE-&gt;'Kernel Source Path' tab. It is possible to explore the kernel source in your local machine or in the same machine used to run SystemTap scripts. Enter your option and inform the kernel source location. If you selected the remote option, it is necessary to set up the remote machine information at SystemTap-&gt;'Remote Server' tab.
			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 plug-in.</p>
		<h3 id="Preferences_.28Optional.29">Preferences (Optional)</h3>
		<p>Finally, you may want to set certain non-essential preferences before using SystemTap plug-in regularly. Use

			<b><u>W</u>indow-&gt;<u>P</u>references</b> to access the Preferences page. 
		</p>
		<p>Of particular note are 
			Logging-&gt;Log To, SystemTap-&gt;Environment Variables, SystemTap-&gt;Graphing-&gt;Refresh Delay, 
			SystemTap-&gt;IDE-&gt;Editor-&gt;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>

Back to the top