From 4d5dad09b6df6274ff965ec9e4c9c05dfb735dd1 Mon Sep 17 00:00:00 2001 From: Rich Bowen Date: Tue, 1 May 2012 14:59:02 +0000 Subject: [PATCH] Splits the docs for log_server_status and split-logfile into their own separate docs. The "other" file has dwindled over the years, and having "other" just list two things seems a little silly. Also, update log_server_status doc to reflect current reality. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1332679 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/programs/log_server_status.html | 5 ++ .../manual/programs/log_server_status.html.en | 71 +++++++++++++++++++ docs/manual/programs/log_server_status.xml | 59 +++++++++++++++ .../programs/log_server_status.xml.meta | 12 ++++ docs/manual/programs/other.html.en | 50 ++----------- docs/manual/programs/other.xml | 43 ++--------- docs/manual/programs/split-logfile.html | 5 ++ docs/manual/programs/split-logfile.html.en | 70 ++++++++++++++++++ docs/manual/programs/split-logfile.xml | 59 +++++++++++++++ docs/manual/programs/split-logfile.xml.meta | 12 ++++ 10 files changed, 305 insertions(+), 81 deletions(-) create mode 100644 docs/manual/programs/log_server_status.html create mode 100644 docs/manual/programs/log_server_status.html.en create mode 100644 docs/manual/programs/log_server_status.xml create mode 100644 docs/manual/programs/log_server_status.xml.meta create mode 100644 docs/manual/programs/split-logfile.html create mode 100644 docs/manual/programs/split-logfile.html.en create mode 100644 docs/manual/programs/split-logfile.xml create mode 100644 docs/manual/programs/split-logfile.xml.meta diff --git a/docs/manual/programs/log_server_status.html b/docs/manual/programs/log_server_status.html new file mode 100644 index 0000000000..192b6142ae --- /dev/null +++ b/docs/manual/programs/log_server_status.html @@ -0,0 +1,5 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: log_server_status.html.en +Content-Language: en +Content-type: text/html; charset=ISO-8859-1 diff --git a/docs/manual/programs/log_server_status.html.en b/docs/manual/programs/log_server_status.html.en new file mode 100644 index 0000000000..fe20f64337 --- /dev/null +++ b/docs/manual/programs/log_server_status.html.en @@ -0,0 +1,71 @@ + + + +log_server_status - Log periodic status summaries - Apache HTTP Server + + + + + + + +
<-
+
+Apache > HTTP Server > Documentation > Version 2.4 > Programs

log_server_status - Log periodic status summaries

+
+

Available Languages:  en  | + ko  | + tr 

+
+ +

This perl script is designed to be run at a frequent interval by + something like cron. It connects to the server and downloads the status + information. It reformats the information to a single line and logs it to + a file. Adjust the variables at the top of the script to specify the + location of the resulting logfile. mod_status will + need to be loaded and configured in order for this script to do its + job.

+
+
top
+
+

Usage

+ +

The script contains the following section.

+ +
+my $wherelog = "/usr/local/apache2/logs/";  # Logs will be like "/usr/local/apache2/logs/19960312"
+my $server   = "localhost";        # Name of server, could be "www.foo.com"
+my $port     = "80";               # Port on server
+my $request = "/server-status/?auto";    # Request to send
+
+ + +

You'll need to ensure that these variables have the correct values, +and you'll need to have the /server-status handler +configured at the location specified, and the specified log location +needs to be writable by the user which will run the script.

+ +

Run the script periodically via cron to produce a daily log file, +which can then be used for statistical analysis.

+ +
+
+

Available Languages:  en  | + ko  | + tr 

+
+ \ No newline at end of file diff --git a/docs/manual/programs/log_server_status.xml b/docs/manual/programs/log_server_status.xml new file mode 100644 index 0000000000..04f709b4b9 --- /dev/null +++ b/docs/manual/programs/log_server_status.xml @@ -0,0 +1,59 @@ + + + + + + + + +Programs + +log_server_status - Log periodic status summaries + + +

This perl script is designed to be run at a frequent interval by + something like cron. It connects to the server and downloads the status + information. It reformats the information to a single line and logs it to + a file. Adjust the variables at the top of the script to specify the + location of the resulting logfile. mod_status will + need to be loaded and configured in order for this script to do its + job.

+
+ +
Usage + +

The script contains the following section.

+ + +my $wherelog = "/usr/local/apache2/logs/"; # Logs will be like "/usr/local/apache2/logs/19960312" +my $server = "localhost"; # Name of server, could be "www.foo.com" +my $port = "80"; # Port on server +my $request = "/server-status/?auto"; # Request to send + + +

You'll need to ensure that these variables have the correct values, +and you'll need to have the /server-status handler +configured at the location specified, and the specified log location +needs to be writable by the user which will run the script.

+ +

Run the script periodically via cron to produce a daily log file, +which can then be used for statistical analysis.

+ +
+ +
diff --git a/docs/manual/programs/log_server_status.xml.meta b/docs/manual/programs/log_server_status.xml.meta new file mode 100644 index 0000000000..4ad2755872 --- /dev/null +++ b/docs/manual/programs/log_server_status.xml.meta @@ -0,0 +1,12 @@ + + + + + log_server_status + /programs/ + .. + + + en + + diff --git a/docs/manual/programs/other.html.en b/docs/manual/programs/other.html.en index 9c8522a22b..8fefe2117b 100644 --- a/docs/manual/programs/other.html.en +++ b/docs/manual/programs/other.html.en @@ -13,7 +13,7 @@ - -

The following programs are simple support programs included with the - Apache HTTP Server which do not have their own manual pages. They are not - installed automatically. You can find them after the configuration process - in the support/ directory.

- -
-
top
-
-

log_server_status

-

This perl script is designed to be run at a frequent interval by - something like cron. It connects to the server and downloads the status - information. It reformats the information to a single line and logs it to - a file. Adjust the variables at the top of the script to specify the - location of the resulting logfile.

-
top
-
-

split-logfile

-

This perl script will take a combined Web server access log file and - break its contents into separate files. It assumes that the first field of - each line is the virtual host identity, put there using the "%v" - variable in LogFormat. -

- -

- LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" - combined_plus_vhost
- CustomLog logs/access_log combined_plus_vhost -

- -

Log files will be created, in the directory where are running the - script, for each virtual host name that appears in the combined log file. - These logfiles will named after the hostname, with a - .log file extension.

- -

The combined log file is read from stdin. Records read will be appended - to any existing log files.

+

This page used to contain documentation for programs which now + have their own docs pages. Please update any links.

-

split-logfile < access_log

- - -
+

log_server_status

+

split-lofile

+ +

Available Languages:  en  |  ko  | diff --git a/docs/manual/programs/other.xml b/docs/manual/programs/other.xml index 334dfd3a32..8ce768c7f8 100644 --- a/docs/manual/programs/other.xml +++ b/docs/manual/programs/other.xml @@ -26,44 +26,11 @@ Other Programs

-

The following programs are simple support programs included with the - Apache HTTP Server which do not have their own manual pages. They are not - installed automatically. You can find them after the configuration process - in the support/ directory.

-
- -
log_server_status -

This perl script is designed to be run at a frequent interval by - something like cron. It connects to the server and downloads the status - information. It reformats the information to a single line and logs it to - a file. Adjust the variables at the top of the script to specify the - location of the resulting logfile.

-
- -
split-logfile -

This perl script will take a combined Web server access log file and - break its contents into separate files. It assumes that the first field of - each line is the virtual host identity, put there using the "%v" - variable in LogFormat. -

- - - LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" - combined_plus_vhost
- CustomLog logs/access_log combined_plus_vhost -
- -

Log files will be created, in the directory where are running the - script, for each virtual host name that appears in the combined log file. - These logfiles will named after the hostname, with a - .log file extension.

+

This page used to contain documentation for programs which now + have their own docs pages. Please update any links.

-

The combined log file is read from stdin. Records read will be appended - to any existing log files.

- - split-logfile < access_log - - -
+

log_server_status

+

split-lofile

+ diff --git a/docs/manual/programs/split-logfile.html b/docs/manual/programs/split-logfile.html new file mode 100644 index 0000000000..80b48605c0 --- /dev/null +++ b/docs/manual/programs/split-logfile.html @@ -0,0 +1,5 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: split-logfile.html.en +Content-Language: en +Content-type: text/html; charset=ISO-8859-1 diff --git a/docs/manual/programs/split-logfile.html.en b/docs/manual/programs/split-logfile.html.en new file mode 100644 index 0000000000..5ac8e4fb49 --- /dev/null +++ b/docs/manual/programs/split-logfile.html.en @@ -0,0 +1,70 @@ + + + +split-logfile - Split up multi-vhost logfiles - Apache HTTP Server + + + + + + + +
<-
+

split-logfile - Split up multi-vhost logfiles

+
+

Available Languages:  en  | + ko  | + tr 

+
+ +

This perl script will take a combined Web server access log file and + break its contents into separate files. It assumes that the first field of + each line is the virtual host identity, put there using the "%v" + variable in LogFormat. +

+
+
top
+
+

Usage

+ +

Create a log file with virtual host information in it:

+ +

+ LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" + combined_plus_vhost
+ CustomLog logs/access_log combined_plus_vhost +

+ +

Log files will be created, in the directory where you run the + script, for each virtual host name that appears in the combined log file. + These logfiles will named after the hostname, with a + .log file extension.

+ +

The combined log file is read from stdin. Records read will be appended + to any existing log files.

+ +

split-logfile < access_log

+ + +
+
+

Available Languages:  en  | + ko  | + tr 

+
+ \ No newline at end of file diff --git a/docs/manual/programs/split-logfile.xml b/docs/manual/programs/split-logfile.xml new file mode 100644 index 0000000000..20e7abab81 --- /dev/null +++ b/docs/manual/programs/split-logfile.xml @@ -0,0 +1,59 @@ + + + + + + + + +Programs + +split-logfile - Split up multi-vhost logfiles + + +

This perl script will take a combined Web server access log file and + break its contents into separate files. It assumes that the first field of + each line is the virtual host identity, put there using the "%v" + variable in LogFormat. +

+
+ +
Usage + +

Create a log file with virtual host information in it:

+ + + LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" + combined_plus_vhost
+ CustomLog logs/access_log combined_plus_vhost +
+ +

Log files will be created, in the directory where you run the + script, for each virtual host name that appears in the combined log file. + These logfiles will named after the hostname, with a + .log file extension.

+ +

The combined log file is read from stdin. Records read will be appended + to any existing log files.

+ + split-logfile < access_log + + +
+ +
diff --git a/docs/manual/programs/split-logfile.xml.meta b/docs/manual/programs/split-logfile.xml.meta new file mode 100644 index 0000000000..21514060e7 --- /dev/null +++ b/docs/manual/programs/split-logfile.xml.meta @@ -0,0 +1,12 @@ + + + + + split-logfile + /programs/ + .. + + + en + + -- 2.40.0