forked from allinurl/goaccess
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgoaccess.1
206 lines (182 loc) · 6.35 KB
/
goaccess.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
.TH goaccess 1 "DECEMBER 2010" Linux "User Manuals"
.SH NAME
goaccess \- fast log analyzer and interactive viewer for the Apache web server
.SH SYNOPSIS
.B goaccess [-f
.I input-file
.B ]
.I [-b] [-s] [-e] [-a]
.SH DESCRIPTION
.B goaccess
is a free (GPL) real-time Apache web log analyzer and interactive
viewer that runs in a terminal in *nix systems.
It provides fast and valuable HTTP statistics for system
administrators that require a visual server report on the fly.
First it will parse the access log file, then it will collect data
from the parsed file and it will display it
to the console or the X terminal. The collected information will be
displayed to the user in a visual/interactive window.
The collected information includes:
.IP "General Statistics:"
Total number of valid requests,
Total number of invalid requests,
Total time to analyze the data,
Total unique visitors,
Total unique requested files,
Total unique static files
.IR (css, ico, jpg, js, swf, gif, png)
Total unique HTTP referrers (URLs),
Total unique 404s
.I (not found),
Size of the parsed log file,
Total bandwidth consumption.
.IP "Unique visitors:"
HTTP requests having the same IP,
same date and same agent will be
considered a unique visit.
.I (including crawlers).
.B {Detail view} is available for this module
.IP "Requested files"
The totals are based on unique requested files.
This is based on the premise that
HTTP requests having the same IP,
same date and same agent will be
considered a unique visit.
.B {Detail view} is available for this module
.IP "Requested static files"
The totals are based on unique requested files.
Includes files such as:
.I jpg, css, swf, js, gif, png etc.
Unique requests are based on the premise that
HTTP requests having the same IP,
same date and same agent will be
considered a unique visit.
.B {Detail view} is available for this module
.IP "Referrers URLs"
The URL where the request came from.
Totals are not based on the above premise,
but instead, based on the total number of
requests.
.B {Detail view} is available for this module
.IP "404 or Not Found"
The total number is based on total requests.
.B {Detail view} is available for this module
.IP "Operating Systems"
The total number is based on unique visitors.
.B {Detail view} is available for this module
.IP "Browsers"
The total number is based on unique visitors.
.B {Detail view} is available for this module
.IP "Hosts"
The total number is based on total requests.
.B {Detail view} is available for this module.
{Detail view} for each IP can display extra
information for the particular host, including
reverse dns, and geolocation of the IP.
.IP "HTTP Status Codes"
Totals are based on total requests.
.B {Detail view} is available for this module
.IP "Referring Sites"
This module will display only the host
but not the whole URL.
The total number is based on total requests.
.B {Detail view} is available for this module
.IP "Keyphrases"
This module will report keyphrases used on
Google search, Google cache, and Google
translate.
The total number is based on total requests.
.B {Detail view} is available for this module
.SH OPTIONS
.IP -b
Enable total bandwidth consumption. To achieve faster parsing, do not enable this flag.
This has been disabled by default.
.IP "-f input-file"
Path to input log file.
.IP -s
Enable HTTP response status codes report. To avoid overhead while parsing,
this feature has been disabled by default.
.IP -e
Exclude an IP from being counted under the HOST module.
.IP -a
Enable a list of User-Agents for the selected host.
.SH INTERACTIVE MENU
.IP "F1"
Main help.
.IP "F5"
Redraw main window.
.IP "q"
Quit the program or the current {detail view} (window).
.IP "o"
Open a {detail view} for the current active module.
.IP "c"
set or change scheme color.
.IP "TAB"
Forward iteration of modules. Starts from current active module.
.IP "SHIFT + TAB"
Backward iteration of modules. Starts from current active module.
.IP "RIGHT ARROW"
Open a {detail view} for the current active module.
.IP "0-9"
Activate module so the user can open a {detail view} with either ^o^ or ^RIGHT ARROW^.
.IP "SHIFT + 0-9"
Activate module above 10.
.IP "s"
Sort unique visitors by date. This will only work on the
.B Unique visitors module(1).
.IP "S"
Sort unique visitors by hits. This will only work on the
.B Unique visitors module(1).
.IP "/"
Search forward on any {detail view} window for the occurrence of typed pattern.
.IP "n"
Find the position of the next occurrence on any {detail view} window.
.IP "t"
Move to the first item on any {detail view} window.
.IP "b"
Move to the last item on any {detail view} window.
.SH EXAMPLES
The simplest and fastest usage would be:
# goaccess -f access.log
That will generate an interactive text-only output.
To generate full statistics we can run GoAccess as:
# goaccess -f access.log -a -s -b
The
.I -a
flag indicates that we want to process an agent-list for every host parsed.
The
.I -s
flag tells GoAccess go get every HTTP status code.
The
.I -b
flag will process the total bandwidth consumption for files, hosts, and dates.
Now if we want to add more flexibility to GoAccess, we can do a series of pipes.
For instance:
If we would like to process all
.I access.log.*.gz
we can do:
# zcat access.log.*.gz | goaccess
OR
# zcat -f access.log* | goaccess
Another useful pipe would be filtering dates out of the Apache's access log
The following will get all HTTP requests starting on 05/Dec/2010 until
the end of the file.
# sed -n '/05\\/Dec\\/2010/,$ p' access.log | goaccess -s -b
If we want to parse only a certain time-frame from DATE a to DATE b, we can do:
sed -n '/5\\/Nov\\/2010/,/5\\/Dec\\/2010/ p' access.log | goaccess -s -b
.I Note that this could take longer time to parse depending on the speed of sed.
.B Also,
it is worth pointing out that if we want to run GoAccess at lower priority, we
can run it as:
# nice -n 19 goaccess -f access.log -s -a -b
.SH NOTES
On each {detail view} window, the total number of items is 300.
Piping a log to GoAccess will disable the real-time functionality. This is due to the
portability issue on determining the actual size of STDIN. However, a future release *might*
include this feature.
.SH BUGS
If you think you have found a bug, please send me an email to
.SH AUTHOR
Gerardo Orellana <[email protected]>
For more details about it, or new releases, please visit http://goaccess.prosoftcorp.com