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 "2009-02-02" "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 ] [ -\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 -f
  47 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)
  48 .TP
  49 -v
  50 Produce verbose output on STDERR\&. The output contains the result of the configuration parsing, and all file open and close actions\&.
  51 .TP
  52 \fIlogfile\fR
  53 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\&. 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)\&.
  54 .TP
  55 \fIrotationtime\fR
  56 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\&.)
  57 .TP
  58 \fIfilesize\fR(B|K|M|G)
  59 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\&.
  60 .TP
  61 \fIoffset\fR
  62 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\&.
  63
  64 .SH "EXAMPLES"
  65
  66 .nf
  67
  68      CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
  69
  70 .fi
  71
  72 .PP
  73 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\&.
  74
  75 .nf
  76
  77      CustomLog "|bin/rotatelogs -l /var/logs/logfile\&.%Y\&.%m\&.%d 86400" common
  78
  79 .fi
  80
  81 .PP
  82 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\&.
  83
  84 .nf
  85
  86      CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
  87
  88 .fi
  89
  90 .PP
  91 This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
  92
  93 .nf
  94
  95      ErrorLog "|bin/rotatelogs /var/logs/errorlog\&.%Y-%m-%d-%H_%M_%S 5M"
  96
  97 .fi
  98
  99 .PP
 100 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\&.
 101
 102 .SH "PORTABILITY"
 103
 104 .PP
 105 The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
 106
 107 .Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
 108
 109 .Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
 110
 111 .Ip "\(bu \s-1%B\s0 \- full month name (localized)
 112
 113 .Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
 114
 115 .Ip "\(bu \s-1%c\s0 \- date and time (localized)
 116
 117 .Ip "\(bu \s-1%d\s0 \- 2-digit day of month
 118
 119 .Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
 120
 121 .Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
 122
 123 .Ip "\(bu \s-1%j\s0 \- 3-digit day of year
 124
 125 .Ip "\(bu \s-1%M\s0 \- 2-digit minute
 126
 127 .Ip "\(bu \s-1%m\s0 \- 2-digit month
 128
 129 .Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
 130
 131 .Ip "\(bu \s-1%S\s0 \- 2-digit second
 132
 133 .Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
 134
 135 .Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
 136
 137 .Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
 138
 139 .Ip "\(bu \s-1%X\s0 \- time (localized)
 140
 141 .Ip "\(bu \s-1%x\s0 \- date (localized)
 142
 143 .Ip "\(bu \s-1%Y\s0 \- 4-digit year
 144
 145 .Ip "\(bu \s-1%y\s0 \- 2-digit year
 146
 147 .Ip "\(bu \s-1%Z\s0 \- time zone name
 148
 149 .Ip "\(bu \s-1%%\s0 \- literal `%'
 150