source: general/sysutils/logrotate.xml@ 07499ecc

10.0 10.1 11.0 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 07499ecc was 07499ecc, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Archive udisks
Tags for general/progs

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20397 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.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 logrotate-download-http "https://github.com/logrotate/logrotate/releases/download/&logrotate-version;/logrotate-&logrotate-version;.tar.xz">
8 <!ENTITY logrotate-download-ftp " ">
9 <!ENTITY logrotate-md5sum "1c0f6e6e490c4bcac0a1e77ad1310683">
10 <!ENTITY logrotate-size "156 KB">
11 <!ENTITY logrotate-buildsize "4.5 MB">
12 <!ENTITY logrotate-time "0.1 SBU (with tests)">
13]>
14
15<sect1 id="logrotate" xreflabel="logrotate-&logrotate-version;">
16 <?dbhtml filename="logrotate.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Logrotate-&logrotate-version;</title>
24
25 <indexterm zone="logrotate">
26 <primary sortas="a-logrotate">logrotate</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to Logrotate</title>
31
32 <para>
33 The <application>logrotate</application> package allows automatic rotation,
34 compression, removal, and mailing of log files.
35 </para>
36
37 &lfs83_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&logrotate-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&logrotate-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &logrotate-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &logrotate-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &logrotate-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &logrotate-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Logrotate Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="popt"/>
78 </para>
79
80 <bridgehead renderas="sect4">Recommended</bridgehead>
81 <para role="recommended">
82 <xref role="runtime" linkend="fcron"/> (runtime)
83 </para>
84
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 An <xref role="runtime" linkend="server-mail"/> (runtime)
88 </para>
89
90 <para condition="html" role="usernotes">User Notes:
91 <ulink url="&blfs-wiki;/logrotate"/>
92 </para>
93 </sect2>
94
95 <sect2 role="installation">
96 <title>Installation of Logrotate</title>
97
98 <para>
99 Install <application>logrotate</application> by running the following
100 command:
101 </para>
102
103<screen><userinput>./configure --prefix=/usr &amp;&amp;
104make</userinput></screen>
105
106 <para>
107 To test the results, issue: <command>make test</command>. One test
108 fails because the very old <command>compress</command> is not
109 present and two tests fail if an MTA is not installed.
110 </para>
111
112 <para>
113 Now, as the <systemitem class="username">root</systemitem> user:
114 </para>
115
116<screen role="root"><userinput>make install</userinput></screen>
117
118 </sect2>
119
120 <sect2 role="configuration">
121 <title>Configuring Logrotate</title>
122
123 <para><application>Logrotate</application> needs a configuration file,
124 which must be passed as an argument to the command when executed. Create
125 the file as the <systemitem class="username">root</systemitem> user:</para>
126
127<screen role="root"><userinput>cat &gt; /etc/logrotate.conf &lt;&lt; EOF
128# Begin of /etc/logrotate.conf
129
130# Rotate log files weekly
131weekly
132
133# Don't mail logs to anybody
134nomail
135
136# If the log file is empty, it will not be rotated
137notifempty
138
139# Number of backups that will be kept
140# This will keep the 2 newest backups only
141rotate 2
142
143# Create new empty files after rotating old ones
144# This will create empty log files, with owner
145# set to root, group set to sys, and permissions 644
146create 0664 root sys
147
148# Compress the backups with gzip
149compress
150
151# No packages own lastlog or wtmp -- rotate them here
152/var/log/wtmp {
153 monthly
154 create 0664 root utmp
155 rotate 1
156}
157
158/var/log/lastlog {
159 monthly
160 rotate 1
161}
162
163# Some packages drop log rotation info in this directory
164# so we include any file in it.
165include /etc/logrotate.d
166
167# End of /etc/logrotate.conf
168EOF
169
170chmod -v 0644 /etc/logrotate.conf</userinput></screen>
171
172 <para>Now create the <filename class='directory'>/etc/logrotate.d</filename>
173 directory as the <systemitem class="username">root</systemitem> user:</para>
174
175<screen role="root"><userinput> mkdir -p /etc/logrotate.d</userinput></screen>
176
177 <para>At this point additional log rotation commands can be entered, typically
178 in the <filename class='directory'>/etc/logrotate.d</filename> directory.
179 For example:</para>
180
181<screen role="root"><userinput>cat &gt; /etc/logrotate.d/sys.log &lt;&lt; EOF
182/var/log/sys.log {
183 # If the log file is larger than 100kb, rotate it
184 size 100k
185 rotate 5
186 weekly
187 postrotate
188 /bin/killall -HUP syslogd
189 endscript
190}
191EOF
192
193chmod -v 0644 /etc/logrotate.d/sys.log</userinput></screen>
194
195 <para>You can designate multiple files in one entry:</para>
196
197<screen role="root"><userinput>cat &gt; /etc/logrotate.d/example.log &lt;&lt; EOF
198file1
199file2
200file3 {
201 ...
202 postrotate
203 ...
204 endscript
205}
206EOF
207
208chmod -v 0644 /etc/logrotate.d/example.log</userinput></screen>
209
210 <para>You can use in the same line the list of files: file1 file2 file3.
211 See the logrotate man page or
212 <ulink url='http://www.techrepublic.com/article/manage-linux-log-files-with-logrotate/'/>
213 for more examples.</para>
214
215 <para>The command <command>logrotate /etc/logrotate.conf</command> can be
216 run manually, however, the command should be run daily.
217 Other useful commands are <command>logrotate -d /etc/logrotate.conf</command>
218 for debugging purposes and <command>logrotate -f /etc/logrotate.conf</command>
219 forcing the logrotate commands to be run immediately. Combining the previous
220 options <option>-df</option>, you can debug the effect of the force command.
221 When debugging, the command is only simulated, not really run, thus, eventual
222 non-existing errors appear, when some intermediate files are expected,
223 because they are not actually created.</para>
224
225 <para>To set up <xref linkend='fcron'/> to run
226 <command>logrotate ...</command> at 3AM daily, root's crontab should be
227 edited to add:</para>
228
229<screen><literal>0 3 * * * /usr/sbin/logrotate /etc/logrotate.conf</literal></screen>
230
231
232 </sect2>
233
234 <sect2 role="content">
235 <title>Contents</title>
236
237 <segmentedlist>
238 <segtitle>Installed Programs</segtitle>
239 <segtitle>Installed Library</segtitle>
240 <segtitle>Installed Directories</segtitle>
241
242 <seglistitem>
243 <seg> logrotate </seg>
244 <seg> None </seg>
245 <seg> None </seg>
246 </seglistitem>
247 </segmentedlist>
248
249 <variablelist>
250 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
251 <?dbfo list-presentation="list"?>
252 <?dbhtml list-presentation="table"?>
253
254 <varlistentry id="logrotate-prog">
255 <term><command>logrotate</command></term>
256 <listitem>
257 <para>
258 performs the log maintenance functions defined in the
259 configuration files.
260 </para>
261 <indexterm zone="logrotate logrotate-prog">
262 <primary sortas="b-logrotate-prog">logrotate</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 </variablelist>
268
269 </sect2>
270
271</sect1>
Note: See TracBrowser for help on using the repository browser.