source: general/sysutils/sysstat.xml@ ea3a605d

trunk
Last change on this file since ea3a605d was ea3a605d, checked in by Douglas R. Reno <renodr@…>, 6 weeks ago

Update to sysstat-12.5.4

  • Property mode set to 100644
File size: 11.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY sysstat-download-http "http://sebastien.godard.pagesperso-orange.fr/sysstat-&sysstat-version;.tar.xz">
8 <!ENTITY sysstat-download-ftp " ">
9 <!ENTITY sysstat-md5sum "697890a0fe72be4afe1dcdfff802bde1">
10 <!ENTITY sysstat-size "836 KB">
11 <!ENTITY sysstat-buildsize "29 MB">
12 <!ENTITY sysstat-time "0.1 SBU">
13]>
14
15<sect1 id="sysstat" xreflabel="Sysstat-&sysstat-version;">
16 <?dbhtml filename="sysstat.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Sysstat-&sysstat-version;</title>
23
24 <indexterm zone="sysstat">
25 <primary sortas="a-Sysstat">Sysstat</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Sysstat</title>
30
31 <para>
32 The <application>Sysstat</application> package contains utilities
33 to monitor system performance and usage activity.
34 <application>Sysstat</application> contains the <command>sar</command>
35 utility, common to many commercial Unixes, and tools you can schedule via
36 cron to collect and historize performance and activity data.
37 </para>
38
39 &lfs101_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&sysstat-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&sysstat-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &sysstat-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &sysstat-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &sysstat-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &sysstat-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Sysstat Dependencies</bridgehead>
76
77 <para role="recommended">
78 There are no build-time requirements for this package; however,
79 it is designed to be controlled by a cron daemon such as
80 <xref linkend="fcron" role="runtime"/>.
81 </para>
82
83 <para condition="html" role="usernotes">User Notes:
84 <ulink url="&blfs-wiki;/sysstat"/></para>
85
86 </sect2>
87
88 <sect2 role="installation">
89 <title>Installation of Sysstat</title>
90
91 <para>
92 Install <application>Sysstat</application> by running the
93 following commands:
94 </para>
95
96<screen><userinput>sa_lib_dir=/usr/lib/sa \
97sa_dir=/var/log/sa \
98conf_dir=/etc/sysconfig \
99./configure --prefix=/usr \
100 --disable-file-attr &amp;&amp;
101make</userinput></screen>
102
103 <para>
104 This package does not come with a test suite.
105 </para>
106
107 <para>
108 Now, as the <systemitem class="username">root</systemitem> user:
109 </para>
110
111<screen role="root"><userinput>make install</userinput></screen>
112
113 <para revision="systemd">
114 Install the systemd unit by running the following command as the
115 <systemitem class="username">root</systemitem> user:
116 </para>
117
118<screen role="root" revision="systemd"><userinput>install -v -m644 sysstat.service /usr/lib/systemd/system/sysstat.service</userinput></screen>
119
120 <para revision="systemd">
121 Fix the systemd unit by running the following command as the
122 <systemitem class="username">root</systemitem> user:
123 </para>
124
125<screen role="root" revision="systemd"><userinput>sed -i "/^Also=/d" /usr/lib/systemd/system/sysstat.service</userinput></screen>
126
127 </sect2>
128
129 <sect2 role="commands">
130 <title>Command Explanations</title>
131
132 <para>
133 <envar>sa_lib_dir</envar>: This environment variable specifies the
134 location of the package-specific library directory.
135 </para>
136
137 <para>
138 <envar>sa_dir</envar>: This environment variable specifies the
139 location of the directory containing the data files.
140 </para>
141
142 <para>
143 <envar>conf_dir</envar>: This environment variable specifies the
144 location of the system configuration directory.
145 </para>
146
147 <para>
148 <parameter>--disable-file-attr</parameter>: Do not set attributes on
149 files being installed. This parameter causes the installation to ignore
150 the man group variable resulting in the man files having
151 <systemitem class="username">root</systemitem>:
152 <systemitem class="groupname">root</systemitem> ownership.
153 </para>
154
155 <note>
156 <para>
157 Run <command>./configure --help</command> to see other influential
158 environment variables you can pass to <command>configure</command>.
159 You may want to use the <envar>history</envar> and
160 <envar>compressafter</envar> variables to customize the amount of data
161 files kept on the system.
162 </para>
163 </note>
164
165 </sect2>
166
167 <sect2 role="configuration">
168 <title>Configuring Sysstat</title>
169
170 <sect3 id="sysstat-config">
171 <title>Config Files</title>
172
173 <para>
174 <filename>/etc/sysconfig/sysstat</filename> and
175 <filename>/etc/sysconfig/sysstat.ioconf</filename>
176 </para>
177
178 <indexterm zone="sysstat sysstat-config">
179 <primary sortas="e-etc-sysconfig-sysstat">/etc/sysconfig/sysstat</primary>
180 </indexterm>
181 <indexterm zone="sysstat sysstat-config">
182 <primary sortas="e-etc-sysconfig-sysstat.ioconf">/etc/sysconfig/sysstat.ioconf</primary>
183 </indexterm>
184
185 </sect3>
186
187 <sect3>
188 <title>Cron Information</title>
189
190 <para>
191 To begin gathering <application>Sysstat</application> history
192 information, you must add to, or create a privileged user's crontab.
193 The history data location is
194 <filename class="directory">/var/log/sa</filename>. The user running
195 <application>Sysstat</application> utilities via cron must have write
196 access to this location.
197 </para>
198
199 <para>
200 Below is an example of what to install in the crontab. Adjust the
201 parameters to suit your needs. Use <command>man sa1</command> and
202 <command>man sa2</command> for information about the commands.
203 </para>
204
205<screen><literal># 8am-7pm activity reports every 10 minutes during weekdays
2060 8-18 * * 1-5 /usr/lib/sa/sa1 600 6 &amp;
207
208# 7pm-8am activity reports every hour during weekdays
2090 19-7 * * 1-5 /usr/lib/sa/sa1 &amp;
210
211# Activity reports every hour on Saturday and Sunday
2120 * * * 0,6 /usr/lib/sa/sa1 &amp;
213
214# Daily summary prepared at 19:05
2155 19 * * * /usr/lib/sa/sa2 -A &amp;</literal></screen>
216
217 <para>
218 Ensure you submit the revised crontab to the cron daemon.
219 </para>
220
221 </sect3>
222
223 <sect3 id="sysstat-init">
224 <title>System Startup Information</title>
225
226 <indexterm zone="sysstat sysstat-init">
227 <primary sortas="f-sysstat">sysstat</primary>
228 </indexterm>
229
230 <para revision="sysv">
231 At system startup, a LINUX RESTART message must be
232 inserted in the daily data file to reinitialize the kernel counters.
233 This can be automated by installing the
234 <filename>/etc/rc.d/init.d/sysstat</filename> init script included in
235 the <xref linkend="bootscripts"/> package using the following command
236 as the <systemitem class="username">root</systemitem> user:
237 </para>
238
239<screen role="root" revision="sysv"><userinput>make install-sysstat</userinput></screen>
240
241 <para revision="systemd">
242 At system startup, a LINUX RESTART message must
243 be inserted in the daily data file to reinitialize the kernel counters.
244 This can be automated by enabling the previously installed systemd unit
245 by running the following command as the
246 <systemitem class="username">root</systemitem> user:
247 </para>
248
249<screen role="root" revision="systemd"><userinput>systemctl enable sysstat</userinput></screen>
250
251 </sect3>
252
253 </sect2>
254
255 <sect2 role="content">
256 <title>Contents</title>
257
258 <segmentedlist>
259 <segtitle>Installed Programs</segtitle>
260 <segtitle>Installed Libraries</segtitle>
261 <segtitle>Installed Directories</segtitle>
262
263 <seglistitem>
264 <seg>cifsiostat, iostat, mpstat, pidstat, sadf, sar, and tapestat</seg>
265 <seg>None</seg>
266 <seg>/usr/lib/sa,
267 /usr/share/doc/sysstat-&sysstat-version; and
268 /var/log/sa
269 </seg>
270 </seglistitem>
271 </segmentedlist>
272
273 <variablelist>
274 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
275 <?dbfo list-presentation="list"?>
276 <?dbhtml list-presentation="table"?>
277
278 <varlistentry id="cifsiostat">
279 <term><command>cifsiostat</command></term>
280 <listitem>
281 <para>
282 displays statistics about read and write operations on CIFS
283 filesystems
284 </para>
285 <indexterm zone="sysstat cifsiostat">
286 <primary sortas="b-cifsiostat">cifsiostat</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="iostat">
292 <term><command>iostat</command></term>
293 <listitem>
294 <para>
295 reports CPU statistics and input/output
296 statistics for devices and partitions
297 </para>
298 <indexterm zone="sysstat iostat">
299 <primary sortas="b-iostat">iostat</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="mpstat">
305 <term><command>mpstat</command></term>
306 <listitem>
307 <para>
308 writes activities for each available processor
309 </para>
310 <indexterm zone="sysstat mpstat">
311 <primary sortas="b-mpstat">mpstat</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="pidstat">
317 <term><command>pidstat</command></term>
318 <listitem>
319 <para>
320 is used for monitoring individual tasks currently being managed
321 by the Linux kernel
322 </para>
323 <indexterm zone="sysstat pidstat">
324 <primary sortas="b-pidstat">pidstat</primary>
325 </indexterm>
326 </listitem>
327 </varlistentry>
328
329 <varlistentry id="sadf">
330 <term><command>sadf</command></term>
331 <listitem>
332 <para>
333 is used for displaying the contents of data files created by
334 the <command>sar</command> command. But unlike
335 <command>sar</command>, <command>sadf</command> can write its data
336 in many different formats
337 </para>
338 <indexterm zone="sysstat sadf">
339 <primary sortas="b-sadf">sadf</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="sar">
345 <term><command>sar</command></term>
346 <listitem>
347 <para>
348 is used for displaying the contents of elected cumulative activity
349 counters in the operating system
350 </para>
351 <indexterm zone="sysstat sar">
352 <primary sortas="b-sar">sar</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="tapestat">
358 <term><command>tapestat</command></term>
359 <listitem>
360 <para>
361 is used for monitoring the activity of tape drives connected to
362 a system
363 </para>
364 <indexterm zone="sysstat tapestat">
365 <primary sortas="b-tapestat">tapestat</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 </variablelist>
371
372 </sect2>
373
374</sect1>
Note: See TracBrowser for help on using the repository browser.