github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/programs/rotatelogs.html.en (about)

     1  <?xml version="1.0" encoding="ISO-8859-1"?>
     2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
     3  <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
     4  <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
     5  <!--
     6          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     7                This file is generated from xml source: DO NOT EDIT
     8          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     9        -->
    10  <title>rotatelogs - Piped logging program to rotate Apache logs - Apache HTTP Server Version 2.2</title>
    11  <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
    12  <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
    13  <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
    14  <script src="../style/scripts/prettify.min.js" type="text/javascript">
    15  </script>
    16  
    17  <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/programs/rotatelogs.html" rel="canonical" /></head>
    18  <body id="manual-page"><div id="page-header">
    19  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
    20  <p class="apache">Apache HTTP Server Version 2.2</p>
    21  <img alt="" src="../images/feather.gif" /></div>
    22  <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
    23  <div id="path">
    24  <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div class="retired"><h4>Please note</h4>
    25              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    26          <p>You may follow <a href="http://httpd.apache.org/docs/current/programs/rotatelogs.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>rotatelogs - Piped logging program to rotate Apache logs</h1>
    27  <div class="toplang">
    28  <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English">&nbsp;en&nbsp;</a> |
    29  <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
    30  <a href="../tr/programs/rotatelogs.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
    31  </div>
    32  
    33       <p><code>rotatelogs</code> is a simple program for use in
    34       conjunction with Apache's piped logfile feature.  It supports
    35       rotation based on a time interval or maximum size of the log.</p>
    36  </div>
    37  <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
    38  <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
    39  <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
    40  <li><img alt="" src="../images/down.gif" /> <a href="#portability">Portability</a></li>
    41  </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    42  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    43  <div class="section">
    44  <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
    45  
    46       <p><code><strong>rotatelogs</strong>
    47       [ -<strong>l</strong> ]
    48       [ -<strong>f</strong> ]
    49       <var>logfile</var>
    50       <var>rotationtime</var>|<var>filesize</var>M 
    51       [ <var>offset</var> ]</code></p>
    52  </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    53  <div class="section">
    54  <h2><a name="options" id="options">Options</a></h2>
    55  
    56  <dl>
    57  
    58  <dt><code>-l</code></dt>
    59  <dd>Causes the use of local time rather than GMT as the base for the
    60  interval or for <code>strftime(3)</code> formatting with size-based 
    61  rotation.  Note that using <code>-l</code> in an environment which
    62  changes the GMT offset (such as for BST or DST) can lead to unpredictable
    63  results!</dd>
    64  
    65  <dt><code>-f</code></dt>
    66  <dd>Causes the logfile to be opened immediately, as soon as
    67  <code>rotatelogs</code> starts, instead of waiting for the
    68  first logfile entry to be read (for non-busy sites, there may be
    69  a substantial delay between when the server is started
    70  and when the first request is handled, meaning that the
    71  associated logfile does not "exist" until then, which
    72  causes problems from some automated logging tools).
    73  <em>Available in version 2.2.9 and later.</em></dd>
    74  
    75  <dt><code><var>logfile</var></code></dt>
    76  
    77  <dd><p>The path plus basename of the logfile.  If <var>logfile</var>
    78  includes any '%' characters, it is treated as a format string for
    79  <code>strftime(3)</code>.  Otherwise, the suffix
    80  <var>.nnnnnnnnnn</var> is automatically added and is the time in
    81  seconds.  Both formats compute the start time from the beginning of
    82  the current period.  For example, if a rotation time of 86400 is 
    83  specified, the hour, minute, and second fields created from the
    84  <code>strftime(3)</code> format will all be zero, referring to the
    85  beginning of the current 24-hour period (midnight).</p>
    86  <p>When using <code>strftime(3)</code> filename formatting,
    87  be sure the log file format has enough granularity to produce
    88  a different file name each time the logs are rotated.  Otherwise
    89  rotation will overwrite the same file instead of starting a new
    90  one.  For example, if <var>logfile</var> was 
    91  <code>/var/logs/errorlog.%Y-%m-%d</code> with log rotation at 5
    92  megabytes, but 5 megabytes was reached twice in the same day, the
    93  same log file name would be produced and log rotation would keep
    94  writing to the same file.</p>
    95  </dd>
    96  
    97  <dt><code><var>rotationtime</var></code></dt>
    98  
    99  <dd>The time between log file rotations in seconds.  The rotation
   100  occurs at the beginning of this interval.  For example, if the
   101  rotation time is 3600, the log file will be rotated at the beginning
   102  of every hour; if the rotation time is 86400, the log file will be
   103  rotated every night at midnight.  (If no data is logged during an
   104  interval, no file will be created.)</dd>
   105  
   106  <dt><code><var>filesize</var>M</code></dt>
   107  
   108  <dd>The maximum file size in megabytes followed by the letter
   109  <code>M</code> to specify size rather than time.</dd>
   110  
   111  <dt><code><var>offset</var></code></dt>
   112  
   113  <dd>The number of minutes offset from UTC.  If omitted, zero is
   114  assumed and UTC is used.  For example, to use local time in the zone
   115  UTC -5 hours, specify a value of <code>-300</code> for this argument.
   116  In most cases, <code>-l</code> should be used instead of specifying
   117  an offset.</dd>
   118  
   119  </dl>
   120  </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   121  <div class="section">
   122  <h2><a name="examples" id="examples">Examples</a></h2>
   123  
   124  <div class="example"><p><code>
   125       CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
   126  </code></p></div>
   127  	 
   128       <p>This creates the files /var/logs/logfile.nnnn where nnnn  is
   129       the system time at which the log nominally starts (this time
   130       will always be a multiple of the rotation time, so  you  can
   131       synchronize cron scripts with it).  At the end of each rotation
   132       time (here after 24 hours) a new log is started.</p>
   133  
   134  <div class="example"><p><code>
   135       CustomLog "|bin/rotatelogs -l /var/logs/logfile.%Y.%m.%d 86400" common
   136  </code></p></div>
   137  	 
   138       <p>This creates the files /var/logs/logfile.yyyy.mm.dd where
   139       yyyy is the year, mm is the month, and dd is the day of the month.
   140       Logging will switch to a new file every day at midnight, local time.</p>
   141  
   142  <div class="example"><p><code>
   143       CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
   144  </code></p></div>
   145  
   146       <p>This configuration will rotate the logfile whenever it reaches
   147       a size of 5 megabytes.</p>
   148  
   149  <div class="example"><p><code>
   150       ErrorLog "|bin/rotatelogs /var/logs/errorlog.%Y-%m-%d-%H_%M_%S 5M"
   151  </code></p></div>
   152       <p>This configuration will rotate the error logfile whenever it
   153       reaches a size of 5 megabytes, and the suffix to the logfile name
   154       will be created of the form
   155       <code>errorlog.YYYY-mm-dd-HH_MM_SS</code>.</p>
   156   
   157  </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
   158  <div class="section">
   159  <h2><a name="portability" id="portability">Portability</a></h2>
   160  
   161  <p>The following logfile format string substitutions should be
   162  supported by all <code>strftime(3)</code> implementations, see
   163  the <code>strftime(3)</code> man page for library-specific
   164  extensions.</p>
   165  
   166  <table class="bordered"><tr><td><code>%A</code></td><td>full weekday name (localized)</td></tr>
   167  <tr class="odd"><td><code>%a</code></td><td>3-character weekday name (localized)</td></tr>
   168  <tr><td><code>%B</code></td><td>full month name (localized)</td></tr>
   169  <tr class="odd"><td><code>%b</code></td><td>3-character month name (localized)</td></tr>
   170  <tr><td><code>%c</code></td><td>date and time (localized)</td></tr>
   171  <tr class="odd"><td><code>%d</code></td><td>2-digit day of month</td></tr>
   172  <tr><td><code>%H</code></td><td>2-digit hour (24 hour clock)</td></tr>
   173  <tr class="odd"><td><code>%I</code></td><td>2-digit hour (12 hour clock)</td></tr>
   174  <tr><td><code>%j</code></td><td>3-digit day of year</td></tr>
   175  <tr class="odd"><td><code>%M</code></td><td>2-digit minute</td></tr>
   176  <tr><td><code>%m</code></td><td>2-digit month</td></tr>
   177  <tr class="odd"><td><code>%p</code></td><td>am/pm of 12 hour clock (localized)</td></tr>
   178  <tr><td><code>%S</code></td><td>2-digit second</td></tr>
   179  <tr class="odd"><td><code>%U</code></td><td>2-digit week of year 
   180  (Sunday first day of week)</td></tr>
   181  <tr><td><code>%W</code></td><td>2-digit week of year 
   182  (Monday first day of week)</td></tr>
   183  <tr class="odd"><td><code>%w</code></td><td>1-digit weekday 
   184  (Sunday first day of week)</td></tr>
   185  <tr><td><code>%X</code></td><td>time (localized)</td></tr>
   186  <tr class="odd"><td><code>%x</code></td><td>date (localized)</td></tr>
   187  <tr><td><code>%Y</code></td><td>4-digit year</td></tr>
   188  <tr class="odd"><td><code>%y</code></td><td>2-digit year</td></tr>
   189  <tr><td><code>%Z</code></td><td>time zone name</td></tr>
   190  <tr class="odd"><td><code>%%</code></td><td>literal `%'</td></tr>
   191  </table>
   192  
   193  </div></div>
   194  <div class="bottomlang">
   195  <p><span>Available Languages: </span><a href="../en/programs/rotatelogs.html" title="English">&nbsp;en&nbsp;</a> |
   196  <a href="../ko/programs/rotatelogs.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
   197  <a href="../tr/programs/rotatelogs.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
   198  </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
   199  <script type="text/javascript"><!--//--><![CDATA[//><!--
   200  var comments_shortname = 'httpd';
   201  var comments_identifier = 'http://httpd.apache.org/docs/2.2/programs/rotatelogs.html';
   202  (function(w, d) {
   203      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   204          d.write('<div id="comments_thread"><\/div>');
   205          var s = d.createElement('script');
   206          s.type = 'text/javascript';
   207          s.async = true;
   208          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   209          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   210      }
   211      else { 
   212          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   213      }
   214  })(window, document);
   215  //--><!]]></script></div><div id="footer">
   216  <p class="apache">Copyright 2017 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
   217  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
   218  if (typeof(prettyPrint) !== 'undefined') {
   219      prettyPrint();
   220  }
   221  //--><!]]></script>
   222  </body></html>