1What is it?
2-------------
3GoAccess is an open source real-time web log analyzer and interactive viewer
4that runs in a terminal in *nix systems or through your browser.
5
6It provides fast and valuable HTTP statistics for system administrators that
7require a visual server report on the fly.
8
9Features
10-------------------------------
11GoAccess parses the specified web log file and
12outputs the data to the X terminal. Features include:
13
14 * Completely Real Time
15 All panels and metrics are timed to be updated every 200 ms on the terminal
16 output and every second on the HTML output.
17
18 * No configuration needed
19 You can just run it against your access log file, pick the log format and
20 let GoAccess parse the access log and show you the stats.
21
22 * Track Application Response Time
23 Track the time taken to serve the request. Extremely useful if you want to
24 track pages that are slowing down your site.
25
26 * Nearly All Web Log Formats
27 GoAccess allows any custom log format string. Predefined options include,
28 Apache, Nginx, Amazon S3, Elastic Load Balancing, CloudFront, etc
29
30 * Incremental Log Processing
31 Need data persistence? GoAccess has the ability to process logs incrementally
32 through the on-disk B+Tree database.
33
34 * Only one dependency
35 GoAccess is written in C. To run it, you only need ncurses as a dependency.
36 That's it. It even has its own Web Socket server - http://gwsocket.io/.
37
38 * Visitors
39 Determine the amount of hits, visitors, bandwidth, and metrics for slowest
40 running requests by the hour, or date.
41
42 * Metrics per Virtual Host
43 Have multiple Virtual Hosts (Server Blocks)? A panel that displays which
44 virtual host is consuming most of the web server resources.
45
46 * Color Scheme Customizable
47 Tailor GoAccess to suit your own color taste/schemes. Either through the
48 terminal, or by simply updating the stylesheet on the HTML output.
49
50 * Support for large datasets
51 GoAccess features the ability to parse large logs due to its optimized
52 in-memory hash tables. It has very good memory usage and pretty good
53 performance. This storage has support for on-disk persistence as well.
54
55 * Docker support
56 GoAccess comes with a default Docker (https://hub.docker.com/r/allinurl/goaccess/)
57 that will listen for HTTP connections on port 7890. Although, you can still
58 fully configure it, by using Volume mapping and editing goaccess.conf.
59
60 * and more... visit https://goaccess.io for more details.
61
62
63Why GoAccess?
64-------------
65GoAccess was designed to be a fast, terminal-based log analyzer. Its core idea
66is to quickly analyze and view web server statistics in real time without
67needing to use your browser (great if you want to do a quick analysis of your
68access log via SSH, or if you simply love working in the terminal).
69
70While the terminal output is the default output, it has the capability to
71generate a complete real-time HTML report, as well as a JSON, and CSV report.
72
73You can see it more of a monitor command tool than anything else.
74
75Keys
76----
77The user can make use of the following keys:
78
79 * ^F1^ or ^h^ Main help,
80 * ^F5^ Redraw [main window],
81 * ^q^ Quit the program, current window or module,
82 * ^o^ or ^ENTER^ Expand selected module,
83 * ^[Shift]0-9^ Set selected module to active,
84 * ^Up^ arrow Scroll up main dashboard,
85 * ^Down^ arrow Scroll down main dashboard,
86 * ^j^ Scroll down within expanded module,
87 * ^k^ Scroll up within expanded module,
88 * ^c^ Set or change scheme color,
89 * ^CTRL^ + ^f^ Scroll forward one screen within,
90 * active module,
91 * ^CTRL^ + ^b^ Scroll backward one screen within,
92 * active module,
93 * ^TAB^ Iterate modules (forward),
94 * ^SHIFT^ + ^TAB^ Iterate modules (backward),
95 * ^s^ Sort options for current module,
96 * ^/^ Search across all modules,
97 * ^n^ Find position of the next occurrence,
98 * ^g^ Move to the first item or top of screen,
99 * ^G^ Move to the last item or bottom of screen,
100
101Examples can be found by running `man goaccess`.
102