Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@tkuchiki
tkuchiki committed Sep 8, 2016
1 parent f21aaee commit cb871b5
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 8 deletions.
60 changes: 52 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,7 @@ alp is Access Log Profiler for Labeled Tab-separated Values(LTSV).

# Installation

```
curl -sLO https://github.com/tkuchiki/alp/releases/download/VERSION/alp_linux_amd64.zip
unzip alp_linux_amd64.zip
mv alp_linux_amd64 /usr/local/bin/alp
```
Download from https://github.com/tkuchiki/alp/releases

# Usage

Expand Down Expand Up @@ -46,14 +42,20 @@ Flags:
-q, --query-string include query string
--tsv tsv format (default: table)
--apptime-label="apptime" apptime label
--reqtime-label="reqtime" reqtime label
--status-label="status" status label
--size-label="size" size label
--method-label="method" method label
--uri-label="uri" uri label
--time-label="time" time label
--location=LOCATION location name
--limit=5000 set an upper limit of the target uri
--location=LOCATION location name
--includes=PATTERN,... don't exclude uri matching PATTERN (comma separated)
--excludes=PATTERN,... exclude uri matching PATTERN (comma separated)
--include-statuses=PATTERN,...
don't exclude status code matching PATTERN (comma separated)
--exclude-statuses=PATTERN,...
exclude uri status code PATTERN (comma separated)
--noheaders print no header line at all (only --tsv)
--aggregates=PATTERN,... aggregate uri matching PATTERN (comma separated)
--start-time=TIME since the start time
Expand Down Expand Up @@ -214,7 +216,7 @@ $ ./alp -f access.log --tsv --noheaders
3 0.057 0.234 0.391 0.130 12 34 80 26.667 POST /foo/bar
```

### Include
### Include URI

```
$ ./alp -f access.log
Expand All @@ -239,7 +241,7 @@ $ ./alp -f access.log --includes "foo,\d+"
+-------+-------+-------+-------+-------+-----------+-----------+-----------+-----------+--------+-------------------+
```

### Exclude
### Exclude URI

```
$ ./alp -f access.log
Expand All @@ -261,6 +263,48 @@ $ ./alp -f access.log --excludes "foo,\d+"
+-------+-------+-------+-------+-------+-----------+-----------+-----------+-----------+--------+------------+
```

## Include Status Code

```
$ cat access3.log | ./alp
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| COUNT | MIN | MAX | SUM | AVG | P1 | P50 | P99 | STDDEV | MIN(BODY) | MAX(BODY) | SUM(BODY) | AVG(BODY) | METHOD | URI |
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| 1 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.000 | 12.000 | 12.000 | 12.000 | 12.000 | POST | /foo/bar?token=xxx&uuid=1234 |
| 1 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.000 | 56.000 | 56.000 | 56.000 | 56.000 | GET | /foo/bar?token=zzz |
| 2 | 0.100 | 60.000 | 60.100 | 30.050 | 0.100 | 0.100 | 0.100 | 29.950 | 34.000 | 34.000 | 68.000 | 34.000 | POST | /foo/bar?token=yyy |
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
$ cat access3.log | ./alp --include-statuses 200
+-------+-------+-------+-------+-------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| COUNT | MIN | MAX | SUM | AVG | P1 | P50 | P99 | STDDEV | MIN(BODY) | MAX(BODY) | SUM(BODY) | AVG(BODY) | METHOD | URI |
+-------+-------+-------+-------+-------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| 1 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.000 | 12.000 | 12.000 | 12.000 | 12.000 | POST | /foo/bar?token=xxx&uuid=1234 |
| 1 | 0.100 | 0.100 | 0.100 | 0.100 | 0.100 | 0.100 | 0.100 | 0.000 | 34.000 | 34.000 | 34.000 | 34.000 | POST | /foo/bar?token=yyy |
| 1 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.000 | 56.000 | 56.000 | 56.000 | 56.000 | GET | /foo/bar?token=zzz |
+-------+-------+-------+-------+-------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
```

### Exclude Status

```
$ cat access3.log | ./alp
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| COUNT | MIN | MAX | SUM | AVG | P1 | P50 | P99 | STDDEV | MIN(BODY) | MAX(BODY) | SUM(BODY) | AVG(BODY) | METHOD | URI |
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
| 1 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.057 | 0.000 | 12.000 | 12.000 | 12.000 | 12.000 | POST | /foo/bar?token=xxx&uuid=1234 |
| 1 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.123 | 0.000 | 56.000 | 56.000 | 56.000 | 56.000 | GET | /foo/bar?token=zzz |
| 2 | 0.100 | 60.000 | 60.100 | 30.050 | 0.100 | 0.100 | 0.100 | 29.950 | 34.000 | 34.000 | 68.000 | 34.000 | POST | /foo/bar?token=yyy |
+-------+-------+--------+--------+--------+-------+-------+-------+--------+-----------+-----------+-----------+-----------+--------+------------------------------+
$ cat access3.log | ./alp --exclude-statuses 20[0-9]
+-------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+--------+--------------------+
| COUNT | MIN | MAX | SUM | AVG | P1 | P50 | P99 | STDDEV | MIN(BODY) | MAX(BODY) | SUM(BODY) | AVG(BODY) | METHOD | URI |
+-------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+--------+--------------------+
| 1 | 60.000 | 60.000 | 60.000 | 60.000 | 60.000 | 60.000 | 60.000 | 0.000 | 34.000 | 34.000 | 34.000 | 34.000 | POST | /foo/bar?token=yyy |
+-------+--------+--------+--------+--------+--------+--------+--------+--------+-----------+-----------+-----------+-----------+--------+--------------------+
```

### Aggregate

```
Expand Down
4 changes: 4 additions & 0 deletions access3.log
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
host:192.168.12.34 user:- time:2015-09-06T05:58:05+09:00 method:POST uri:/foo/bar?token=xxx&uuid=1234 protocol:HTTP/1.1 status:200 size:12 api_status:- request_time:0.247 apptime:0.057 upstream_addr:127.0.0.1:12345 referer:- user_agent:curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.15.3 zlib/1.2.3 libidn/1.18 libssh2/1.4.2 uuid:-user_id:-
host:192.168.12.34 user:- time:2015-09-06T05:58:41+09:00 method:POST uri:/foo/bar?token=yyy protocol:HTTP/1.1 status:200 size:34 api_status:- request_time:0.012 apptime:0.100 upstream_addr:127.0.0.1:12345 referer:- user_agent:curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.15.3 zlib/1.2.3 libidn/1.18 libssh2/1.4.2 uuid:- user_id:-
host:192.168.12.34 user:- time:2015-09-06T06:00:42+09:00 method:GET uri:/foo/bar?token=zzz protocol:HTTP/1.1 status:200 size:56 api_status:- request_time:0.034 apptime:0.123 upstream_addr:127.0.0.1:12345 referer:- user_agent:curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.15.3 zlib/1.2.3 libidn/1.18 libssh2/1.4.2 uuid:- user_id:-
host:192.168.12.34 user:- time:2015-09-06T05:58:44+09:00 method:POST uri:/foo/bar?token=yyy protocol:HTTP/1.1 status:504 size:34 api_status:- request_time:0.123 apptime:60 upstream_addr:127.0.0.1:12345 referer:- user_agent:curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.15.3 zlib/1.2.3 libidn/1.18 libssh2/1.4.2 uuid:- user_id:-

0 comments on commit cb871b5

Please sign in to comment.