You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by br...@apache.org on 2013/10/19 21:10:33 UTC
svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Author: breser
Date: Sat Oct 19 19:10:33 2013
New Revision: 1533810
URL: http://svn.apache.org/r1533810
Log:
Add an option to autocreate directories to rotatelogs.
* support/rotatelogs.c
(rotate_config): Remove const from szLogRoot since we'll be passing it to
apr_filepath_merge. Add create_path member.
(usage, dumpConfig): Update to reflect new -d option.
(doRotate): Add code that knows how to create the directories a log file
is going to go into.
(main): Add the -d option and canonicalize the incoming path with
apr_filepath_merge() so that the code in doRotate can work properly.
* docs/man/rotatelogs.8,
docs/manual/programs/rotatelogs.html.en: Update for -d option.
PR: 46669
Submitted by: Philippe Lantin <plantin cobaltgroup.com>
(which was actually a patch written by myself when I worked there)
Tweaked by: breser (ported to trunk and changed option from -p to -d)
Modified:
httpd/httpd/trunk/docs/man/rotatelogs.8
httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en
httpd/httpd/trunk/support/rotatelogs.c
Modified: httpd/httpd/trunk/docs/man/rotatelogs.8
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/man/rotatelogs.8?rev=1533810&r1=1533809&r2=1533810&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/man/rotatelogs.8 (original)
+++ httpd/httpd/trunk/docs/man/rotatelogs.8 Sat Oct 19 19:10:33 2013
@@ -19,7 +19,7 @@
.el .ne 3
.IP "\\$1" \\$2
..
-.TH "ROTATELOGS" 8 "2013-06-12" "Apache HTTP Server" "rotatelogs"
+.TH "ROTATELOGS" 8 "2013-08-19" "Apache HTTP Server" "rotatelogs"
.SH NAME
rotatelogs \- Piped logging program to rotate Apache logs
@@ -27,7 +27,7 @@ rotatelogs \- Piped logging program to r
.SH "SYNOPSIS"
.PP
-\fBrotatelogs\fR [ -\fBl\fR ] [ -\fBL\fR \fIlinkname\fR ] [ -\fBp\fR \fIprogram\fR ] [ -\fBf\fR ] [ -\fBv\fR ] [ -\fBe\fR ] [ -\fBc\fR ] [ -\fBn\fR \fInumber-of-files\fR ] \fIlogfile\fR \fIrotationtime\fR|\fIfilesize\fR(B|K|M|G) [ \fIoffset\fR ]
+\fBrotatelogs\fR [ -\fBl\fR ] [ -\fBL\fR \fIlinkname\fR ] [ -\fBp\fR \fIprogram\fR ] [ -\fBf\fR ] [ -\fBd\fR ] [ -\fBv\fR ] [ -\fBe\fR ] [ -\fBc\fR ] [ -\fBn\fR \fInumber-of-files\fR ] \fIlogfile\fR \fIrotationtime\fR|\fIfilesize\fR(B|K|M|G) [ \fIoffset\fR ]
.SH "SUMMARY"
@@ -67,6 +67,9 @@ Create log file for each interval, even
-n \fInumber-of-files\fR
Use a circular list of filenames without timestamps\&. With -n 3, the series of log files opened would be "logfile", "logfile\&.1", "logfile\&.2", then overwriting "logfile"\&.
.TP
+-d
+Creates the parent directories that the log file will be placed in if they do not already exist\&. This allows strftime(3) formatting to be used in the path and not just the filename\&.
+.TP
\fIlogfile\fR
.PP 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)\&. .PP When using strftime(3) filename formatting, be sure the log file format has enough granularity to produce a different file name each time the logs are rotated\&. Otherwise rotation will overwrite the same file instead of starting a new one\&. For example, if \fIlogfile\fR was /var/logs/errorlog\&.%Y-%m-%d with log rotation at 5 megabytes, but 5 megabytes was reached twice in the same day, the same log file name would be prod
uced and log rotation would keep writing to the same file\&.
.TP
Modified: httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en?rev=1533810&r1=1533809&r2=1533810&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en (original)
+++ httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en Sat Oct 19 19:10:33 2013
@@ -44,6 +44,7 @@
[ -<strong>L</strong> <var>linkname</var> ]
[ -<strong>p</strong> <var>program</var> ]
[ -<strong>f</strong> ]
+ [ -<strong>d</strong> ]
[ -<strong>v</strong> ]
[ -<strong>e</strong> ]
[ -<strong>c</strong> ]
@@ -89,6 +90,11 @@ and when the first request is handled, m
associated logfile does not "exist" until then, which
causes problems from some automated logging tools)</dd>
+<dt><code>-d</code></dt>
+<dd>Creates the parent directories of the path that the log file will be
+placed in if they do not already exist. This allows <code>strftime(3)</code>
+formatting to be used in the path and not just the filename.</dd>
+
<dt><code>-t</code></dt>
<dd>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,
@@ -277,4 +283,4 @@ if (typeof(prettyPrint) !== 'undefined')
prettyPrint();
}
//--><!]]></script>
-</body></html>
\ No newline at end of file
+</body></html>
Modified: httpd/httpd/trunk/support/rotatelogs.c
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/support/rotatelogs.c?rev=1533810&r1=1533809&r2=1533810&view=diff
==============================================================================
--- httpd/httpd/trunk/support/rotatelogs.c (original)
+++ httpd/httpd/trunk/support/rotatelogs.c Sat Oct 19 19:10:33 2013
@@ -63,7 +63,7 @@ struct rotate_config {
int force_open;
int verbose;
int echo;
- const char *szLogRoot;
+ char *szLogRoot;
int truncate;
const char *linkfile;
const char *postrotate_prog;
@@ -71,6 +71,7 @@ struct rotate_config {
int create_empty;
#endif
int num_files;
+ int create_path;
};
typedef struct rotate_status rotate_status_t;
@@ -103,9 +104,9 @@ static void usage(const char *argv0, con
}
fprintf(stderr,
#if APR_FILES_AS_SOCKETS
- "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-t] [-e] [-c] [-n number] <logfile> "
+ "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-d] [-t] [-e] [-c] [-n number] <logfile> "
#else
- "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-t] [-e] [-n number] <logfile> "
+ "Usage: %s [-v] [-l] [-L linkname] [-p prog] [-f] [-d] [-t] [-e] [-n number] <logfile> "
#endif
"{<rotation time in seconds>|<rotation size>(B|K|M|G)} "
"[offset minutes from UTC]\n\n",
@@ -137,6 +138,7 @@ static void usage(const char *argv0, con
" -L path Create hard link from current log to specified path.\n"
" -p prog Run specified program after opening a new log file. See below.\n"
" -f Force opening of log on program start.\n"
+ " -d Create parent directories of log file.\n"
" -t Truncate logfile instead of rotating, tail friendly.\n"
" -e Echo log to stdout for further processing.\n"
#if APR_FILES_AS_SOCKETS
@@ -200,6 +202,7 @@ static void dumpConfig (rotate_config_t
fprintf(stderr, "Rotation based on localtime: %12s\n", config->use_localtime ? "yes" : "no");
fprintf(stderr, "Rotation file date pattern: %12s\n", config->use_strftime ? "yes" : "no");
fprintf(stderr, "Rotation file forced open: %12s\n", config->force_open ? "yes" : "no");
+ fprintf(stderr, "Create parent directories: %12s\n", config->create_path ? "yes" : "no");
fprintf(stderr, "Rotation verbose: %12s\n", config->verbose ? "yes" : "no");
#if APR_FILES_AS_SOCKETS
fprintf(stderr, "Rotation create empty logs: %12s\n", config->create_empty ? "yes" : "no");
@@ -430,6 +433,23 @@ static void doRotate(rotate_config_t *co
}
}
apr_pool_create(&newlog.pool, status->pool);
+ if (config->create_path) {
+ char *ptr = strrchr(newlog.name, '/');
+ if (ptr && ptr > newlog.name) {
+ char *path = apr_pstrmemdup(newlog.pool, newlog.name, ptr - newlog.name);
+ if (config->verbose) {
+ fprintf(stderr, "Creating directory tree %s\n", path);
+ }
+ rv = apr_dir_make_recursive(path, APR_FPROT_OS_DEFAULT, newlog.pool);
+ if (rv != APR_SUCCESS) {
+ char error[120];
+
+ apr_strerror(rv, error, sizeof error);
+ fprintf(stderr, "Could not create directory '%s' (%s)\n", path, error);
+ exit(2);
+ }
+ }
+ }
if (config->verbose) {
fprintf(stderr, "Opening file %s\n", newlog.name);
}
@@ -560,9 +580,9 @@ int main (int argc, const char * const a
apr_pool_create(&status.pool, NULL);
apr_getopt_init(&opt, status.pool, argc, argv);
#if APR_FILES_AS_SOCKETS
- while ((rv = apr_getopt(opt, "lL:p:ftvecn:", &c, &opt_arg)) == APR_SUCCESS) {
+ while ((rv = apr_getopt(opt, "lL:p:fdtvecn:", &c, &opt_arg)) == APR_SUCCESS) {
#else
- while ((rv = apr_getopt(opt, "lL:p:ftven:", &c, &opt_arg)) == APR_SUCCESS) {
+ while ((rv = apr_getopt(opt, "lL:p:fdtven:", &c, &opt_arg)) == APR_SUCCESS) {
#endif
switch (c) {
case 'l':
@@ -577,6 +597,9 @@ int main (int argc, const char * const a
case 'f':
config.force_open = 1;
break;
+ case 'd':
+ config.create_path = 1;
+ break;
case 't':
config.truncate = 1;
break;
@@ -611,7 +634,11 @@ int main (int argc, const char * const a
usage(argv[0], "Incorrect number of arguments");
}
- config.szLogRoot = argv[opt->ind++];
+ rv = apr_filepath_merge(&config.szLogRoot, "", argv[opt->ind++],
+ APR_FILEPATH_TRUENAME, status.pool);
+ if (rv != APR_SUCCESS && rv != APR_EPATHWILD) {
+ usage(argv[0], "Invalid filename given");
+ }
/* Read in the remaining flags, namely time, size and UTC offset. */
for(; opt->ind < argc; opt->ind++) {
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Ben Reser <be...@reser.org>.
On 10/20/13 11:23 AM, Jeff Trawick wrote:
> trunk and 2.4.x branch:
>
> checking for APR... configure: WARNING: APR version 1.4.0 or later is required,
> found 1.3.13
> configure: WARNING: Found APR in /home/trawick/inst/apr13-64/bin/apr-1-config,
> but we think it is considered unacceptable
> configure: error: the --with-apr parameter is incorrect. It must specify an
> install prefix, a build directory, or an apr-config file.
> configure failed
>
> (I always forget about %pm :( )
Thanks I went look for that a bit and didn't find it. So yes I guess we could
switch to %pm.
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Jeff Trawick <tr...@gmail.com>.
On Sun, Oct 20, 2013 at 1:54 PM, Ben Reser <be...@reser.org> wrote:
> On 10/20/13 5:31 AM, Ruediger Pluem wrote:
> >> apr_pool_create(&newlog.pool, status->pool);
> >> + if (config->create_path) {
> >> + char *ptr = strrchr(newlog.name, '/');
> >> + if (ptr && ptr > newlog.name) {
> >> + char *path = apr_pstrmemdup(newlog.pool, newlog.name, ptr
> - newlog.name);
> >> + if (config->verbose) {
> >> + fprintf(stderr, "Creating directory tree %s\n", path);
> >> + }
> >> + rv = apr_dir_make_recursive(path, APR_FPROT_OS_DEFAULT,
> newlog.pool);
> >> + if (rv != APR_SUCCESS) {
> >> + char error[120];
> >> +
> >> + apr_strerror(rv, error, sizeof error);
> >> + fprintf(stderr, "Could not create directory '%s'
> (%s)\n", path, error);
> >
> > Can't we use apr_psprintf with %pm instead of the constant length
> buffer char [120]?
>
> Only if we require APR 1.3.x or newer since %pm wasn't added till 1.3.0:
>
> https://apr.apache.org/docs/apr/1.4/group__apr__lib.html#gad2cd3594aeaafd45931d1034965f48c1
>
> The implementation I used here is similar to out error handling already in
> the
> file.
>
trunk and 2.4.x branch:
checking for APR... configure: WARNING: APR version 1.4.0 or later is
required, found 1.3.13
configure: WARNING: Found APR in
/home/trawick/inst/apr13-64/bin/apr-1-config, but we think it is considered
unacceptable
configure: error: the --with-apr parameter is incorrect. It must specify an
install prefix, a build directory, or an apr-config file.
configure failed
(I always forget about %pm :( )
--
Born in Roswell... married an alien...
http://emptyhammock.com/
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Ben Reser <be...@reser.org>.
On 10/20/13 5:31 AM, Ruediger Pluem wrote:
>> apr_pool_create(&newlog.pool, status->pool);
>> + if (config->create_path) {
>> + char *ptr = strrchr(newlog.name, '/');
>> + if (ptr && ptr > newlog.name) {
>> + char *path = apr_pstrmemdup(newlog.pool, newlog.name, ptr - newlog.name);
>> + if (config->verbose) {
>> + fprintf(stderr, "Creating directory tree %s\n", path);
>> + }
>> + rv = apr_dir_make_recursive(path, APR_FPROT_OS_DEFAULT, newlog.pool);
>> + if (rv != APR_SUCCESS) {
>> + char error[120];
>> +
>> + apr_strerror(rv, error, sizeof error);
>> + fprintf(stderr, "Could not create directory '%s' (%s)\n", path, error);
>
> Can't we use apr_psprintf with %pm instead of the constant length buffer char [120]?
Only if we require APR 1.3.x or newer since %pm wasn't added till 1.3.0:
https://apr.apache.org/docs/apr/1.4/group__apr__lib.html#gad2cd3594aeaafd45931d1034965f48c1
The implementation I used here is similar to out error handling already in the
file.
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Ben Reser <be...@reser.org>.
On 10/20/13 5:31 AM, Ruediger Pluem wrote:
> Can't we use apr_psprintf with %pm instead of the constant length buffer char [120]?
Done in r1534895, r1534896 and r1534914.
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Ruediger Pluem <rp...@apache.org>.
breser@apache.org wrote:
> Author: breser
> Date: Sat Oct 19 19:10:33 2013
> New Revision: 1533810
>
> URL: http://svn.apache.org/r1533810
> Log:
> Add an option to autocreate directories to rotatelogs.
>
> * support/rotatelogs.c
> (rotate_config): Remove const from szLogRoot since we'll be passing it to
> apr_filepath_merge. Add create_path member.
> (usage, dumpConfig): Update to reflect new -d option.
> (doRotate): Add code that knows how to create the directories a log file
> is going to go into.
> (main): Add the -d option and canonicalize the incoming path with
> apr_filepath_merge() so that the code in doRotate can work properly.
>
> * docs/man/rotatelogs.8,
> docs/manual/programs/rotatelogs.html.en: Update for -d option.
>
> PR: 46669
> Submitted by: Philippe Lantin <plantin cobaltgroup.com>
> (which was actually a patch written by myself when I worked there)
> Tweaked by: breser (ported to trunk and changed option from -p to -d)
>
>
> Modified:
> httpd/httpd/trunk/docs/man/rotatelogs.8
> httpd/httpd/trunk/docs/manual/programs/rotatelogs.html.en
> httpd/httpd/trunk/support/rotatelogs.c
>
> Modified: httpd/httpd/trunk/support/rotatelogs.c
> URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/support/rotatelogs.c?rev=1533810&r1=1533809&r2=1533810&view=diff
> ==============================================================================
> --- httpd/httpd/trunk/support/rotatelogs.c (original)
> +++ httpd/httpd/trunk/support/rotatelogs.c Sat Oct 19 19:10:33 2013
> @@ -430,6 +433,23 @@ static void doRotate(rotate_config_t *co
> }
> }
> apr_pool_create(&newlog.pool, status->pool);
> + if (config->create_path) {
> + char *ptr = strrchr(newlog.name, '/');
> + if (ptr && ptr > newlog.name) {
> + char *path = apr_pstrmemdup(newlog.pool, newlog.name, ptr - newlog.name);
> + if (config->verbose) {
> + fprintf(stderr, "Creating directory tree %s\n", path);
> + }
> + rv = apr_dir_make_recursive(path, APR_FPROT_OS_DEFAULT, newlog.pool);
> + if (rv != APR_SUCCESS) {
> + char error[120];
> +
> + apr_strerror(rv, error, sizeof error);
> + fprintf(stderr, "Could not create directory '%s' (%s)\n", path, error);
Can't we use apr_psprintf with %pm instead of the constant length buffer char [120]?
> + exit(2);
> + }
> + }
> + }
> if (config->verbose) {
> fprintf(stderr, "Opening file %s\n", newlog.name);
> }
Regards
Rüdiger
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8 docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by André Malo <nd...@perlig.de>.
* Ben Reser wrote:
> On 10/20/13 5:37 AM, André Malo wrote:
> > * breser@apache.org wrote:
> >> Author: breser
> >> Date: Sat Oct 19 19:10:33 2013
> >> New Revision: 1533810
> >>
> >> * docs/man/rotatelogs.8,
> >> docs/manual/programs/rotatelogs.html.en: Update for -d option.
> >
> > Huh. These files are both generated (or should be). Please update
> > rotatelogs.xml instead.
>
> Oops thanks fixed in r1533935.
>
> Why are the generated files committed though?
For one thing, oversight. The docs are shipped in generated form, and
failures can be seen early (the docs build process happens to fail from
time to time, because of weird java reasons (typically stack sizes and
character encodings - depending on OS and java installation)).
The other thing is, that the docs are simply checked out for the online
manual.
nd
--
"Das Verhalten von Gates hatte mir bewiesen, dass ich auf ihn und seine
beiden Gefährten nicht zu zählen brauchte" -- Karl May, "Winnetou III"
Im Westen was neues: <http://pub.perlig.de/books.html#apache2>
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8 docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by André Malo <nd...@perlig.de>.
* Ben Reser wrote:
> On 10/20/13 5:37 AM, André Malo wrote:
> > * breser@apache.org wrote:
> >> Author: breser
> >> Date: Sat Oct 19 19:10:33 2013
> >> New Revision: 1533810
> >>
> >> * docs/man/rotatelogs.8,
> >> docs/manual/programs/rotatelogs.html.en: Update for -d option.
> >
> > Huh. These files are both generated (or should be). Please update
> > rotatelogs.xml instead.
>
> Oops thanks fixed in r1533935.
>
> Why are the generated files committed though?
For one thing, oversight. The docs are shipped in generated form, and
failures can be seen early (the docs build process happens to fail from
time to time, because of weird java reasons (typically stack sizes and
character encodings - depending on OS and java installation)).
The other thing is, that the docs are simply checked out for the online
manual.
nd
--
"Das Verhalten von Gates hatte mir bewiesen, dass ich auf ihn und seine
beiden Gefährten nicht zu zählen brauchte" -- Karl May, "Winnetou III"
Im Westen was neues: <http://pub.perlig.de/books.html#apache2>
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8
docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by Ben Reser <be...@reser.org>.
On 10/20/13 5:37 AM, André Malo wrote:
> * breser@apache.org wrote:
>
>> Author: breser
>> Date: Sat Oct 19 19:10:33 2013
>> New Revision: 1533810
>
>> * docs/man/rotatelogs.8,
>> docs/manual/programs/rotatelogs.html.en: Update for -d option.
>
> Huh. These files are both generated (or should be). Please update
> rotatelogs.xml instead.
Oops thanks fixed in r1533935.
Why are the generated files committed though?
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8 docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by André Malo <nd...@perlig.de>.
* breser@apache.org wrote:
> Author: breser
> Date: Sat Oct 19 19:10:33 2013
> New Revision: 1533810
> * docs/man/rotatelogs.8,
> docs/manual/programs/rotatelogs.html.en: Update for -d option.
Huh. These files are both generated (or should be). Please update
rotatelogs.xml instead.
nd
--
"Die Untergeschosse der Sempergalerie bleiben währenddessen aus
statistischen Gründen geflutet." -- Spiegel Online
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org
Re: svn commit: r1533810 - in /httpd/httpd/trunk: docs/man/rotatelogs.8 docs/manual/programs/rotatelogs.html.en support/rotatelogs.c
Posted by André Malo <nd...@perlig.de>.
* breser@apache.org wrote:
> Author: breser
> Date: Sat Oct 19 19:10:33 2013
> New Revision: 1533810
> * docs/man/rotatelogs.8,
> docs/manual/programs/rotatelogs.html.en: Update for -d option.
Huh. These files are both generated (or should be). Please update
rotatelogs.xml instead.
nd
--
"Die Untergeschosse der Sempergalerie bleiben währenddessen aus
statistischen Gründen geflutet." -- Spiegel Online