GoAccess

What is it?

GoAccess is an open source real-time 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. More info at: http://goaccess.prosoftcorp.com.

Features

GoAccess parses the specified web log file and outputs the data to the X terminal. Features include:

• General Statistics, bandwidth, etc.
• Time taken to serve the request (useful to track pages that are slowing down your site)
• Top Visitors
• Requested files
• Requested static files, images, swf, js, etc.
• 404 or Not Found
• Hosts, Reverse DNS, IP Location
• Operating Systems
• Browsers and Spiders
• Referring Sites
• Referrers URLs
• Keyphrases
• Geo Location - Continents/Countries
• HTTP Status Codes
• Ability to output JSON and CSV
• Different Color Schemes
• Support for IPv6
• Output statistics to HTML. See report.

Nearly all web log formats...

GoAccess allows any custom log format string. Predefined options include, but not limited to:

• Common Log Format (CLF) Apache
• Combined Log Format (XLF/ELF) Apache | Nginx
• W3C format (IIS).
• Amazon CloudFront (Download Distribution).
• Apache virtual hosts

Why GoAccess?

The main idea behind GoAccess is being able to quickly analyze and view web server statistics in real time without having to generate an HTML report. Although it is possible to generate an HTML, JSON, CSV report, by default it outputs to a terminal.

You can see it more as a monitor command tool than anything else.

Installation

GoAccess can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD.

Download, extract and compile GoAccess with:

$ wget http://downloads.sourceforge.net/project/goaccess/0.7.1/goaccess-0.7.1.tar.gz
$ tar -xzvf goaccess-0.7.1.tar.gz
$ cd goaccess-0.7.1/
$ ./configure --enable-geoip --enable-utf8
$ make
# make install

Build from GitHub (Development)

$ git clone https://github.com/allinurl/goaccess.git
$ cd goaccess
$ autoreconf -fi
$ ./configure --enable-geoip --enable-utf8
$ make
# make install

Distributions

It is easiest to install GoAccess on Linux using the preferred package manager of your Linux distribution.

Please note that not all distributions will have the lastest version of GoAccess available

Debian/Ubuntu

# apt-get install goaccess

NOTE: this might not always give you the latest stable version. To make sure that you're running the latest stable version of GoAccess see alternative option below.

GoAccess' Debian & Ubuntu repository

$ echo "deb http://deb.goaccess.prosoftcorp.com $(lsb_release -cs) main" | sudo tee -a /etc/apt/sources.list
$ wget -O - http://deb.goaccess.prosoftcorp.com/gnugpg.key | sudo apt-key add -
$ sudo apt-get update
$ sudo apt-get install goaccess

This will get you the latest stable version of GoAccess. Architectures: i386 amd64 armel

Fedora

# yum install goaccess

Arch Linux

# pacman -S goaccess

Gentoo

# emerge net-analyzer/goaccess

OS X / Homebrew

# brew install goaccess

FreeBSD

# cd /usr/ports/sysutils/goaccess/ && make install clean
$ pkg_add -r goaccess

Usage

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

To generate an HTML report:

# goaccess -f access.log -a > report.html

To generate a JSON file:

# goaccess -f access.log -a -d -o json > report.json

To generate a CSV file:

# goaccess -f access.log -o csv > report.csv

The -a flag indicates that we want to process an agent-list for every host parsed.

The -d flag indicates that we want to enable the IP resolver on the HTML | JSON output. (It will take longer time to output since it has to resolve all queries.)

The -c flag will prompt the date and log format configuration window. Only when curses is initialized.

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 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 web 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 -a

To exclude a list of virtual hosts you can do the following:

# grep -v "`cat exclude_vhost_list_file`" vhost_access.log | goaccess

For more examples, please check GoAccess' man page: http://goaccess.prosoftcorp.com/man

Contributing

Any help on GoAccess is welcome. Feel free to use the Github issue tracker and pull requests to discuss and submit code changes.

Enjoy!