granicus.if.org Git - apache/blob - docs/man/rotatelogs.8

   1 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   2 .\" DO NOT EDIT! Generated from XML source.
   3 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   4 .de Sh \" Subsection
   5 .br
   6 .if t .Sp
   7 .ne 5
   8 .PP
   9 \fB\\$1\fR
  10 .PP
  11 ..
  12 .de Sp \" Vertical space (when we can't use .PP)
  13 .if t .sp .5v
  14 .if n .sp
  15 ..
  16 .de Ip \" List item
  17 .br
  18 .ie \\n(.$>=3 .ne \\$3
  19 .el .ne 3
  20 .IP "\\$1" \\$2
  21 ..
  22 .TH "ROTATELOGS" 8 "2010-02-19" "Apache HTTP Server" "rotatelogs"
  23
  24 .SH NAME
  25 rotatelogs \- Piped logging program to rotate Apache logs
  26
  27 .SH "SYNOPSIS"
  28
  29 .PP
  30 \fBrotatelogs\fR [ -\fBl\fR ] [ -\fBL\fR \fIlinkname\fR ] [ -\fBf\fR ] [ -\fBv\fR ] \fIlogfile\fR \fIrotationtime\fR|\fIfilesize\fR(B|K|M|G) [ \fIoffset\fR ]
  31
  32
  33 .SH "SUMMARY"
  34
  35 .PP
  36 rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature\&. It supports rotation based on a time interval or maximum size of the log\&.
  37
  38
  39 .SH "OPTIONS"
  40
  41
  42 .TP
  43 -l
  44 Causes the use of local time rather than GMT as the base for the interval or for strftime(3) formatting with size-based rotation\&. Note that using -l in an environment which changes the GMT offset (such as for BST or DST) can lead to unpredictable results!
  45 .TP
  46 -L \fIlinkname\fR
  47 Causes a hard link to be made from the current logfile to the specified link name\&. This can be used to watch the log continuously across rotations using a command like tail -F linkname\&.
  48 .TP
  49 -f
  50 Causes the logfile to be opened immediately, as soon as rotatelogs starts, instead of waiting for the first logfile entry to be read (for non-busy sites, there may be a substantial delay between when the server is started and when the first request is handled, meaning that the associated logfile does not "exist" until then, which causes problems from some automated logging tools)
  51 .TP
  52 -t
  53 Causes the logfile to be truncated instead of rotated\&. This is useful when a log is processed in real time by a command like tail, and there is no need for archived data\&. No suffix will be added to the filename, however format strings containing '%' characters will be respected\&.
  54 .TP
  55 -v
  56 Produce verbose output on STDERR\&. The output contains the result of the configuration parsing, and all file open and close actions\&.
  57 .TP
  58 \fIlogfile\fR
  59 The path plus basename of the logfile\&. If \fIlogfile\fR includes any '%' characters, it is treated as a format string for strftime(3)\&. Otherwise, the suffix \fI\&.nnnnnnnnnn\fR is automatically added and is the time in seconds (unless the -t option is used)\&. Both formats compute the start time from the beginning of the current period\&. For example, if a rotation time of 86400 is specified, the hour, minute, and second fields created from the strftime(3) format will all be zero, referring to the beginning of the current 24-hour period (midnight)\&.
  60 .TP
  61 \fIrotationtime\fR
  62 The time between log file rotations in seconds\&. The rotation occurs at the beginning of this interval\&. For example, if the rotation time is 3600, the log file will be rotated at the beginning of every hour; if the rotation time is 86400, the log file will be rotated every night at midnight\&. (If no data is logged during an interval, no file will be created\&.)
  63 .TP
  64 \fIfilesize\fR(B|K|M|G)
  65 The maximum file size in followed by exactly one of the letters B (Bytes), K (KBytes), M (MBytes) or G (GBytes)\&. .PP When time and size are specified, the size must be given after the time\&. Rotation will occur whenever either time or size limits are reached\&.
  66 .TP
  67 \fIoffset\fR
  68 The number of minutes offset from UTC\&. If omitted, zero is assumed and UTC is used\&. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument\&. In most cases, -l should be used instead of specifying an offset\&.
  69
  70 .SH "EXAMPLES"
  71
  72 .nf
  73
  74      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
  75
  76 .fi
  77
  78 .PP
  79 This creates the files /var/logs/logfile\&.nnnn where nnnn is the system time at which the log nominally starts (this time will always be a multiple of the rotation time, so you can synchronize cron scripts with it)\&. At the end of each rotation time (here after 24 hours) a new log is started\&.
  80
  81 .nf
  82
  83      CustomLog "|bin/rotatelogs -l /var/logs/logfile\&.%Y\&.%m\&.%d 86400" common
  84
  85 .fi
  86
  87 .PP
  88 This creates the files /var/logs/logfile\&.yyyy\&.mm\&.dd where yyyy is the year, mm is the month, and dd is the day of the month\&. Logging will switch to a new file every day at midnight, local time\&.
  89
  90 .nf
  91
  92      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
  93
  94 .fi
  95
  96 .PP
  97 This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
  98
  99 .nf
 100
 101      ErrorLog "|bin/rotatelogs /var/logs/errorlog\&.%Y-%m-%d-%H_%M_%S 5M"
 102
 103 .fi
 104
 105 .PP
 106 This configuration will rotate the error logfile whenever it reaches a size of 5 megabytes, and the suffix to the logfile name will be created of the form errorlog\&.YYYY-mm-dd-HH_MM_SS\&.
 107
 108 .nf
 109
 110      CustomLog "|bin/rotatelogs -t /var/logs/logfile 86400" common
 111
 112 .fi
 113
 114 .PP
 115 This creates the file /var/logs/logfile, truncating the file at startup and then truncating the file once per day\&. It is expected in this scenario that a separate process (such as tail) would process the file in real time\&.
 116
 117 .SH "PORTABILITY"
 118
 119 .PP
 120 The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
 121
 122 .Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
 123
 124 .Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
 125
 126 .Ip "\(bu \s-1%B\s0 \- full month name (localized)
 127
 128 .Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
 129
 130 .Ip "\(bu \s-1%c\s0 \- date and time (localized)
 131
 132 .Ip "\(bu \s-1%d\s0 \- 2-digit day of month
 133
 134 .Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
 135
 136 .Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
 137
 138 .Ip "\(bu \s-1%j\s0 \- 3-digit day of year
 139
 140 .Ip "\(bu \s-1%M\s0 \- 2-digit minute
 141
 142 .Ip "\(bu \s-1%m\s0 \- 2-digit month
 143
 144 .Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
 145
 146 .Ip "\(bu \s-1%S\s0 \- 2-digit second
 147
 148 .Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
 149
 150 .Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
 151
 152 .Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
 153
 154 .Ip "\(bu \s-1%X\s0 \- time (localized)
 155
 156 .Ip "\(bu \s-1%x\s0 \- date (localized)
 157
 158 .Ip "\(bu \s-1%Y\s0 \- 4-digit year
 159
 160 .Ip "\(bu \s-1%y\s0 \- 2-digit year
 161
 162 .Ip "\(bu \s-1%Z\s0 \- time zone name
 163
 164 .Ip "\(bu \s-1%%\s0 \- literal `%'
 165