Merging upstream version 11.76.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
b1c252527e
commit
bca5300afb
GPG key ID:
FBB4F0E80A80222F
65 changed files with 413 additions and 7681 deletions
|
|
@ -1,4 +1,4 @@
|
|||
.TH MOD_QOS 1 "May 2023" "mod_qos Apache Module" "mod_qos"
|
||||
.TH MOD_QOS 1 "January 2025" "mod_qos Apache Module" "mod_qos"
|
||||
.SH NAME
|
||||
mod_qos \- quality of service module for the Apache Web server
|
||||
.SH DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
.TH QSDT 1 "May 2023" "mod_qos utilities 11.74" "qsdt man page"
|
||||
|
||||
.SH NAME
|
||||
qsdt calculates the elapsed time between two related log messages.
|
||||
.SH SYNOPSIS
|
||||
qsdt [\-t <regex>] \-i <regex> \-s <regex> \-e <regex> [\-v] [<path>]
|
||||
.SH DESCRIPTION
|
||||
qsdt is a simple tool to search two different messages in a log file and calculates the elapsed time between these lines. The two log messages need a common identifier such an unique request id (UNIQUE_ID), a thread id, or a transaction code.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-t <regex>
|
||||
Defines a pattern (regular expression) matching the log line's timestamp. The pattern must include two sub\-expressions, one matching hours, minutes and seconds the other matching the milliseconds. Default pattern is ([0\-9]{2}:[0\-9]{2}:[0\-9]{2})[.,]([0\-9]{3})
|
||||
.TP
|
||||
\-i <regex>
|
||||
Pattern (regular expression) matching the identifier which the two messages have in common. The sub\-expression defines the part which needs to be extracted from the matching string. Note: You can also use the start (\-s) and end (\-e) pattern to define the sub\-expression matching this identifier.
|
||||
.TP
|
||||
\-s <regex>
|
||||
Defines the pattern (regular expression or literal string) identifying the first (start) of the two messages.
|
||||
.TP
|
||||
\-e <regex>
|
||||
Defines the pattern (regular expression or literal string) identifying the second (end) of the two messages.
|
||||
.TP
|
||||
\-v
|
||||
Verbose mode.
|
||||
.TP
|
||||
<path>
|
||||
Defines the input file to process. qsdt reads from from standard input if this parameter is omitted.
|
||||
.SH EXAMPLE
|
||||
Sample command line arguments:
|
||||
|
||||
\-i ' ([a\-z0\-9]+) [A\-Z]+ ' \-s 'Received Request' \-e 'Received Response'
|
||||
|
||||
matching those sample log messages:
|
||||
2018\-03\-12 16:34:08.653 threadid23 INFO Received Request
|
||||
2018\-03\-13 16:35:09.891 threadid23 DEBUG MessageHandler Received Response
|
||||
|
||||
.SH NOTE
|
||||
The four patterns (t,i,s,e) are concatenated into two search patterns:
|
||||
first (start): [t (HH:MM:SS)(SSS) ].*[i (id) ].*[s ]
|
||||
second (end): [t (HH:MM:SS)(SSS) ].*[i (id) ].*[e ]
|
||||
|
||||
And the three sub\-expression are used to extract the timestamp and the unique identifier that the start and end message have in common. This means that you could specify the sub\-expression for the unique identifier in the start (\-s) or end (\-e) pattern alternatively, e.g. in case the identifier is at the end of the log line.
|
||||
.SH SEE ALSO
|
||||
qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
.TH QSEXEC 1 "May 2023" "mod_qos utilities 11.74" "qsexec man page
|
||||
|
||||
.SH NAME
|
||||
qsexec \- parses the data received via stdin and executes the defined command on a pattern match.
|
||||
|
||||
.SH SYNOPSIS
|
||||
qsexec \-e <pattern> [\-t <number>:<sec>] [\-c <pattern> [<command string>]] [\-p] [\-u <user>] <command string>
|
||||
.SH DESCRIPTION
|
||||
qsexec reads log lines from stdin and searches for the defined pattern. It executes the defined command string on pattern match.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-e <pattern>
|
||||
Specifies the search pattern causing an event which shall trigger the command.
|
||||
.TP
|
||||
\-t <number>:<sec>
|
||||
Defines the number of pattern match within the the defined number of seconds in order to trigger the command execution. By default, every pattern match causes a command execution.
|
||||
.TP
|
||||
\-c <pattern> [<command string>]
|
||||
Pattern which clears the event counter. Executes optionally a command if an event command has been executed before.
|
||||
.TP
|
||||
\-p
|
||||
Writes data also to stdout (for piped logging).
|
||||
.TP
|
||||
\-u <name>
|
||||
Become another user, e.g. www\-data.
|
||||
.TP
|
||||
<command string>
|
||||
Defines the event command string where $0\-$9 are substituted by the submatches of the regular expression.
|
||||
.SH EXAMPLE
|
||||
Executes the deny.sh script providing the IP address of the client causing a mod_qos(031) messages whenever the log message appears 10 times within at most one minute:
|
||||
ErrorLog "|/usr/bin/qsexec \-e \\'mod_qos\\(031\\).*, c=([0\-9a\-zA\-Z:.]*)\\' \-t 10:60 \\'/usr/local/bin/deny.sh $1\\'"
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
.TH QSFILTER2 1 "May 2023" "mod_qos utilities 11.74" "qsfilter2 man page"
|
||||
|
||||
.SH NAME
|
||||
qsfilter2 \- an utility to generate mod_qos request line rules out from existing access/audit log data.
|
||||
.SH SYNOPSIS
|
||||
qsfilter2 \-i <path> [\-c <path>] [\-d <num>] [\-h] [\-b <num>] [\-p|\-s|\-m|\-o] [\-l <len>] [\-n] [\-e] [\-u 'uni'] [\-k <prefix>] [\-t] [\-f <path>] [\-v 0|1|2]
|
||||
.SH DESCRIPTION
|
||||
mod_qos implements a request filter which validates each request line. The module supports both, negative and positive security model. The QS_Deny* directives are used to specify request line patterns which are not allowed to access the server (negative security model / deny list). These rules are used to restrict access to certain resources which should not be available to users or to protect the server from malicious patterns. The QS_Permit* rules implement a positive security model (allow list). These directives are used to define allowed request line patterns. Request which do not match any of these patterns are not allowed to access the server.
|
||||
|
||||
qsfilter2 is an audit log analyzer used to generate filter rules (perl compatible regular expressions) which may be used by mod_qos to deny access for suspect requests (QS_PermitUri rules). It parses existing audit log files in order to generate request patterns covering all allowed requests.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-i <path>
|
||||
Input file containing request URIs. The URIs for this file have to be extracted from the servers access logs. Each line of the input file contains a request URI consisting of a path and and query.
|
||||
Example:
|
||||
/aaa/index.do
|
||||
/aaa/edit?image=1.jpg
|
||||
/aaa/image/1.jpg
|
||||
/aaa/view?page=1
|
||||
/aaa/edit?document=1
|
||||
|
||||
These access log data must include current request URIs but also request lines from previous rule generation steps. It must also include request lines which cover manually generated rules. You may use the 'qos\-path' and 'qos\-query' variables to create an audit log containing all request data (path and query/body data). Example: 'CustomLog audit_log %{qos\-path}n%{qos\-query}n'. See also http://mod\-qos.sourceforge.net#qsfiltersample about the module settings.
|
||||
.TP
|
||||
\-c <path>
|
||||
mod_qos configuration file defining QS_DenyRequestLine and QS_PermitUri directives. qsfilter2 generates rules from access log data automatically. Manually generated rules (QS_PermitUri) may be provided from this file. Note: each manual rule must be represented by a request URI in the input data (\-i) in order to make sure not to be deleted by the rule optimisation algorithm. QS_Deny* rules from this file are used to filter request lines which should not be used for allow list rule generation.
|
||||
Example:
|
||||
# manually defined allow list rule:
|
||||
QS_PermitUri +view deny "^[/a\-zA\-Z0\-9]+/view\\?(page=[0\-9]+)?$"
|
||||
# filter unwanted request line patterns:
|
||||
QS_DenyRequestLine +printable deny ".*[\\x00\-\\x19].*"
|
||||
|
||||
|
||||
.TP
|
||||
\-d <num>
|
||||
Depth (sub locations) of the path string which is defined as a literal string. Default is 1.
|
||||
.TP
|
||||
\-h
|
||||
Always use a string representing the handler name in the path even the url does not have a query. See also \-d option.
|
||||
.TP
|
||||
\-b <num>
|
||||
Replaces url pattern by the regular expression when detecting a base64/hex encoded string. Detecting sensibility is defined by a numeric value. You should use values higher than 5 (default) or 0 to disable this function.
|
||||
.TP
|
||||
\-p
|
||||
Represents query by pcre only (no literal strings).
|
||||
.TP
|
||||
\-s
|
||||
Uses one single pcre for the whole query string.
|
||||
.TP
|
||||
\-m
|
||||
Uses one pcre for multiple query values (recommended mode).
|
||||
.TP
|
||||
\-o
|
||||
Does not care the order of query parameters.
|
||||
.TP
|
||||
\-l <len>
|
||||
Outsizes the query length by the defined length ({0,size+len}), default is 10.
|
||||
.TP
|
||||
\-n
|
||||
Disables redundant rules elimination.
|
||||
.TP
|
||||
\-e
|
||||
Exit on error.
|
||||
.TP
|
||||
\-u 'uni'
|
||||
Enables additional decoding methods. Use the same settings as you have used for the QS_Decoding directive.
|
||||
.TP
|
||||
\-k <prefix>
|
||||
Prefix used to generate rule identifiers (QSF by default).
|
||||
.TP
|
||||
\-t
|
||||
Calculates the maximal latency per request (worst case) using the generated rules.
|
||||
.TP
|
||||
\-f <path>
|
||||
Filters the input by the provided path (prefix) only processing matching lines.
|
||||
.TP
|
||||
\-v <level>
|
||||
Verbose mode. (0=silent, 1=rule source, 2=detailed). Default is 1. Don't use rules you haven't checked the request data used to generate it! Level 1 is highly recommended (as long as you don't have created the log data using your own web crawler).
|
||||
.SH OUTPUT
|
||||
The output of qsfilter2 is written to stdout. The output contains the generated QS_PermitUri directives but also information about the source which has been used to generate these rules. It is very important to check the validity of each request line which has been used to calculate the QS_PermitUri rules. Each request line which has been used to generate a new rule is shown in the output prefixed by "ADD line <line number>:". These request lines should be stored and reused at any later rule generation (add them to the URI input file). The subsequent line shows the generated rule. At the end of data processing a list of all generated QS_PermitUri rules is shown. These directives may be used withn the configuration file used by mod_qos.
|
||||
.SH EXAMPLE
|
||||
qsfilter2 \-i loc.txt \-c httpd.conf \-m \-e
|
||||
...
|
||||
# ADD line 1: /aaa/index.do
|
||||
# 003 ^(/[a\-zA\-Z0\-9\\\-_]+)+[/]?\\.?[a\-zA\-Z]{0,4}$
|
||||
# ADD line 3: /aaa/view?page=1
|
||||
# \-\-\- ^[/a\-zA\-Z0\-9]+/view\\?(page=[0\-9]+)?$
|
||||
# ADD line 4: /aaa/edit?document=1
|
||||
# 004 ^[/a\-zA\-Z]+/edit\\?((document)(=[0\-9]*)*[&]?)*$
|
||||
# ADD line 5: /aaa/edit?image=1.jpg
|
||||
# 005 ^[/a\-zA\-Z]+/edit\\?((image)(=[0\-9\\.a\-zA\-Z]*)*[&]?)*$
|
||||
...
|
||||
QS_PermitUri +QSF001 deny "^[/a\-zA\-Z]+/edit\\?((document|image)(=[0\-9\\.a\-zA\-Z]*)*[&]?)*$"
|
||||
QS_PermitUri +QSF002 deny "^[/a\-zA\-Z0\-9]+/view\\?(page=[0\-9]+)?$"
|
||||
QS_PermitUri +QSF003 deny "^(/[a\-zA\-Z0\-9\\\-_]+)+[/]?\\.?[a\-zA\-Z]{0,4}$"
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.TH QSGEO 1 "May 2023" "mod_qos utilities 11.74" "qsgeo man page"
|
||||
.TH QSGEO 1 "January 2025" "mod_qos utilities 11.76" "qsgeo man page"
|
||||
|
||||
.SH NAME
|
||||
qsgeo \- an utility to lookup a client's country code.
|
||||
|
|
@ -34,6 +34,6 @@ Resolving a single IP address:
|
|||
qsgeo \-d GeoIPCountryWhois.csv \-ip 192.84.12.23
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
qslog(1), qsre(1), qsrespeed(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
|
|||
|
|
@ -1,28 +0,0 @@
|
|||
.TH QSGREP 1 "May 2023" "mod_qos utilities 11.74" "qsgrep man page"
|
||||
|
||||
.SH NAME
|
||||
qsgrep \- prints matching patterns within a file.
|
||||
.SH SYNOPSIS
|
||||
qsgrep \-e <pattern> \-o <sub string> [<path>]
|
||||
.SH DESCRIPTION
|
||||
qsgrep is a simple tool to search patterns within files. It uses regular expressions to find patterns and prints the submatches within a pre\-defined format string.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-e <pattern>
|
||||
Specifies the search pattern.
|
||||
.TP
|
||||
\-o <string>
|
||||
Defines the output string where $0\-$9 are substituted by the submatches of the regular expression.
|
||||
.TP
|
||||
<path>
|
||||
Defines the input file to process. qsgrep reads from from standard input if this parameter is omitted.
|
||||
|
||||
.SH EXAMPLE
|
||||
Shows the IP addresses of clients causing mod_qos(031) messages):
|
||||
|
||||
qsgrep \-e 'mod_qos\\(031\\).*, c=([a\-zA\-Z0\-9:.]*)' \-o 'ip=$1' error_log
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
.TH QSHEAD 1 "May 2023" "mod_qos utilities 11.74" "qshead man page"
|
||||
|
||||
.SH NAME
|
||||
qshead \- an utility reading from stdin and printing all lines to stdout until reaching the defined pattern.
|
||||
.SH SYNOPSIS
|
||||
qshead \-p <pattern>
|
||||
.SH DESCRIPTION
|
||||
qshead reads lines from stdin and prints them to stdout until a line contains the specified pattern (literal string).
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-p <pattern>
|
||||
Search pattern (literal string).
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1) qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.TH QSLOG 1 "May 2023" "mod_qos utilities 11.74" "qslog man page"
|
||||
.TH QSLOG 1 "January 2025" "mod_qos utilities 11.76" "qslog man page"
|
||||
|
||||
.SH NAME
|
||||
qslog \- collects request statistics from access log data.
|
||||
|
|
@ -104,6 +104,6 @@ Post processing:
|
|||
cat access.log | qslog \-f ..IRSB.T \-o stat.csv \-p
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
qsgeo(1), qsre(1), qsrespeed(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
|
|||
|
|
@ -1,41 +0,0 @@
|
|||
.TH QSLOGGER 1 "May 2023" "mod_qos utilities 11.74" "qslogger man page"
|
||||
|
||||
.SH NAME
|
||||
qslogger \- another shell command interface to the system log module (syslog).
|
||||
.SH SYNOPSIS
|
||||
qslogger [\-t <tag>] [\-f <facility>] [\-l <level>] [\-x <prefix>] [\-r <expression>] [\-d <level>] [\-u <name>] [\-p]
|
||||
.SH DESCRIPTION
|
||||
Use this utility to forward log messages to the systems syslog facility, e.g., to forward the messages to a remote host. It reads data from stdin.
|
||||
.SH OPTIONS
|
||||
|
||||
.TP
|
||||
\-t <tag>
|
||||
Defines the tag name which shall be used to define the origin of the messages, e.g. 'httpd'.
|
||||
.TP
|
||||
\-f <facility>
|
||||
Defines the syslog facility. Default is 'daemon'.
|
||||
.TP
|
||||
\-u <name>
|
||||
Becomes another user, e.g. www\-data.
|
||||
.TP
|
||||
\-l <level>
|
||||
Defines the minimal severity a message must have in order to be forwarded. Default is 'DEBUG' (forwarding everything).
|
||||
.TP
|
||||
\-x <prefix>
|
||||
Allows you to add a prefix (literal string) to every message.
|
||||
.TP
|
||||
\-r <expression>
|
||||
Specifies a regular expression which shall be used to determine the severity (syslog level) for each log line. The default pattern '^\\[[0\-9a\-zA\-Z :]+\\] \\[([a\-z]+)\\] ' can be used for Apache error log messages but you may configure your own pattern matching other log formats. Use brackets to define the pattern enclosing the severity string. Default level (if severity can't be determined) is defined by the option '\-d' (see below).
|
||||
.TP
|
||||
\-d <level>
|
||||
The default severity if the specified pattern (\-r) does not match and the message's severity can't be determined. Default is 'NOTICE'.
|
||||
.TP
|
||||
\-p
|
||||
Writes data also to stdout (for piped logging).
|
||||
.SH EXAMPLE
|
||||
ErrorLog "|/usr/bin/qslogger \-t apache \-f local7"
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
.TH QSPNG 1 "May 2023" "mod_qos utilities 11.74" "qspng man page"
|
||||
|
||||
.SH NAME
|
||||
qspng \- an utility to draw a png graph from qslog(1) output data.
|
||||
.SH SYNOPSIS
|
||||
qspng \-i <stat_log_file> \-p <parameter> \-o <out_file> [\-10]
|
||||
.SH DESCRIPTION
|
||||
qspng is a tool to generate png (portable network graphics) raster images files from semicolon separated data generated by the qslog utility. It reads up to the first 1440 entries (24 hours) and prints a graph using the values defined by the 'parameter' name.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-i <stats_log_file>
|
||||
Input file to read data from.
|
||||
.TP
|
||||
\-p <parameter>
|
||||
Parameter name, e.g. r/s or usr.
|
||||
.TP
|
||||
\-o <out_file>
|
||||
Output file name, e.g. stat.png.
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslogger(1), qslog(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
.TH QSRE 1 "May 2023" "mod_qos utilities 11.74" "qsre man page"
|
||||
.TH QSRE 1 "January 2025" "mod_qos utilities 11.76" "qsre man page"
|
||||
|
||||
.SH NAME
|
||||
qsre matches a regular expression against test strings.
|
||||
|
|
@ -14,6 +14,6 @@ The first argument either defines a single test string of a path to a file conta
|
|||
<pcre>|<path>
|
||||
The second argument either defines a regular expression or a path to a file containing the expression.
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsrespeed(1), qsrotate(1), qssign(1), qstail(1)
|
||||
qsgeo(1), qslog(1), qsrespeed(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.TH QSRESPEED 1 "May 2023" "mod_qos utilities 11.74" "qsrespeed man page"
|
||||
.TH QSRESPEED 1 "January 2025" "mod_qos utilities 11.76" "qsrespeed man page"
|
||||
|
||||
.SH NAME
|
||||
Tool to compare / estimate the processing time for (Perl\-compatible) regular expressions (PCRE).
|
||||
|
|
@ -11,6 +11,6 @@ qsrespeed loads regular expressions from the provided file and matches them agai
|
|||
<path>
|
||||
Defines the input file to process. The file consists a list of (separated by a newline character) regular expressions to test
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrotate(1), qssign(1), qstail(1)
|
||||
qsgeo(1), qslog(1), qsre(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
|
|||
|
|
@ -1,50 +0,0 @@
|
|||
.TH QSROTATE 1 "May 2023" "mod_qos utilities 11.74" "qsrotate man page"
|
||||
|
||||
.SH NAME
|
||||
qsrotate \- a log rotation tool (similar to Apache's rotatelogs).
|
||||
.SH SYNOPSIS
|
||||
qsrotate \-o <file> [\-s <sec> [\-t <hours>]] [\-b <bytes>] [\-f] [\-z] [\-g <num>] [\-u <name>] [\-m <mask>] [\-p] [\-d]
|
||||
.SH DESCRIPTION
|
||||
qsrotate reads from stdin (piped log) and writes the data to the provided file rotating the file after the specified time.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-o <file>
|
||||
Output log file to write the data to (use an absolute path).
|
||||
.TP
|
||||
\-s <sec>
|
||||
Rotation interval in seconds, default are 86400 seconds.
|
||||
.TP
|
||||
\-t <hours>
|
||||
Offset to UTC (enables also DST support), default is 0.
|
||||
.TP
|
||||
\-b <bytes>
|
||||
File size limitation (default/max. are 2147352576 bytes, min. are 1048576 bytes).
|
||||
.TP
|
||||
\-f
|
||||
Forced log rotation at the specified interval even no data is written.
|
||||
.TP
|
||||
\-z
|
||||
Compress (gzip) the rotated file.
|
||||
.TP
|
||||
\-g <num>
|
||||
Generations (number of files to keep).
|
||||
.TP
|
||||
\-u <name>
|
||||
Become another user, e.g. www\-data. \-m <mask>
|
||||
File permission which is either 600, 640, 660 (default) or 664.
|
||||
.TP
|
||||
\-p
|
||||
Writes data also to stdout (for piped logging). \-d
|
||||
Line\-by\-line data reading prefixing every line with a timestamp.
|
||||
.SH EXAMPLE
|
||||
TransferLog "|/usr/bin/qsrotate \-f \-z \-g 3 \-o /var/log/apache/access.log \-s 86400"
|
||||
|
||||
The name of the rotated file will be /dest/filee.YYYYmmddHHMMSS where YYYYmmddHHMMSS is the system time at which the data has been rotated.
|
||||
.SH NOTE
|
||||
\- Each qsrotate instance must use an individual file.
|
||||
\- You may trigger a file rotation manually by sending the signal USR1
|
||||
to the process.
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qsre(1), qsrespeed(1), qspng(1), qssign(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
.TH QSSIGN 1 "May 2023" "mod_qos utilities 11.74" "qssign man page"
|
||||
|
||||
.SH NAME
|
||||
qssign \- an utility to sign and verify the integrity of log data.
|
||||
.SH SYNOPSIS
|
||||
qssign \-s|S <secret> [\-e] [\-v] [\-u <name>] [\-f <regex>] [\-a 'sha1'|'sha256']
|
||||
.SH DESCRIPTION
|
||||
qssign is a log data integrity check tool. It reads log data from stdin (pipe) and writes the data to stdout adding a sequence number and signature to ever log line.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-s <secret>
|
||||
Passphrase used to calculate signature.
|
||||
.TP
|
||||
\-S <program>
|
||||
Specifies a program which writes the passphrase to stdout.
|
||||
.TP
|
||||
\-e
|
||||
Writes start/end marker when starting/stopping data signing.
|
||||
.TP
|
||||
\-v
|
||||
Verification mode checking the integrity of signed data.
|
||||
.TP
|
||||
\-u <name>
|
||||
Becomes another user, e.g. www\-data.
|
||||
.TP
|
||||
\-f <regex>
|
||||
Filter pattern (case sensitive regular expression) for messages which do not need to be signed.
|
||||
.TP
|
||||
\-a 'sha1'|'sha256'
|
||||
Specifies the algorithm to use. Default is sha1.
|
||||
.SH EXAMPLE
|
||||
Sign:
|
||||
|
||||
TransferLog "|/usr/bin/qssign \-s password \-e |/usr/bin/qsrotate \-o /var/log/apache/access.log"
|
||||
|
||||
|
||||
Verify:
|
||||
|
||||
cat access.log | qssign \-s password \-v
|
||||
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qstail(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
.TH QSTAIL 1 "May 2023" "mod_qos utilities 11.74" "qstail man page"
|
||||
|
||||
.SH NAME
|
||||
qstail \- an utility printing the end of a log file starting at the specified pattern.
|
||||
.SH SYNOPSIS
|
||||
qstail \-i <path> \-p <pattern>
|
||||
.SH DESCRIPTION
|
||||
qstail shows the end of a log file beginning with the line containing the specified pattern. This may be used to show all lines which has been written after a certain event (e.g., server restart) or time stamp.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
\-i <path>
|
||||
Input file to read the data from.
|
||||
.TP
|
||||
\-p <pattern>
|
||||
Search pattern (literal string).
|
||||
.SH SEE ALSO
|
||||
qsdt(1), qsexec(1), qsfilter2(1), qsgeo(1), qsgrep(1), qshead(1), qslog(1), qslogger(1), qspng(1), qsre(1), qsrespeed(1), qsrotate(1), qssign(1)
|
||||
.SH AUTHOR
|
||||
Pascal Buchbinder, http://mod-qos.sourceforge.net/
|
||||
Loading…
Add table
Add a link
Reference in a new issue