summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index 099d0bf..d1750b4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,13 @@
-===================================================
-``ngxtop`` - **real-time** metrics for nginx server
-===================================================
+================================================================
+``ngxtop`` - **real-time** metrics for nginx server (and others)
+================================================================
**ngxtop** parses your nginx access log and outputs useful, ``top``-like, metrics of your nginx server.
So you can tell what is happening with your server in real-time.
+Can be used also with Apache log files (experimental). In this case, if not log format is specified, 'combined' will be
+used. If the script doesn't detect redirections properly you can force it by using the '-s' option.
+
Installation
------------
@@ -24,6 +27,7 @@ Usage
ngxtop [options]
ngxtop [options] (print|top|avg|sum) <var>
ngxtop info
+ tail -f /var/log/apache2/access.log | ngxtop [-s]
Options:
-l <file>, --access-log <file> access log file to parse.
@@ -44,6 +48,12 @@ Usage
-h, --help print this help message.
--version print version information.
+ Advanced / experimental options:
+ -c <file>, --config <file> allow ngxtop to parse nginx config file for log format and location.
+ -i <filter-expression>, --filter <filter-expression> filter in, records satisfied given expression are processed.
+ -p <filter-expression>, --pre-filter <filter-expression> in-filter expression to check in pre-parsing phase.
+ -s, --from-stdin read lines from stdin.
+
Samples
-------