Goaccess – ahmadrazalab

GoAccess is a real-time web log analyzer and interactive viewer that runs in a terminal. It's designed to provide insights into web log data, including metrics like visitor statistics, referrer data, and more. It is lightweight and works well with various log formats.

Getting Started with GoAccess

1. Installation

On Debian/Ubuntu:

sudo apt-get update
sudo apt-get install goaccess

On CentOS/RHEL:

sudo yum install epel-release
sudo yum install goaccess

Using Homebrew on macOS:

brew install goaccess

From Source:

Download the latest release from GoAccess GitHub releases (opens in a new tab).
Extract the archive:
```
tar -xvf goaccess-x.y.z.tar.gz
```

Navigate to the extracted directory and install:

cd goaccess-x.y.z
./configure
make
sudo make install

2. Basic Usage

Viewing a Log File:

goaccess /path/to/access.log

This command processes the log file and displays the results in the terminal.

Interactive Mode:

goaccess /path/to/access.log -o report.html

The -o option outputs the results to an HTML file, which you can view in a web browser.

3. Configuration

GoAccess uses a configuration file to manage settings. You can create a custom configuration file or modify the default one located at /etc/goaccess/goaccess.conf.

Sample Configuration:

# Log Format
log-format COMBINED
 
# Output Format
html-report /path/to/report.html

Log Formats:

COMBINED: Common log format (default).
COMBINEDAPACHE: Apache combined log format.
COMMON: Common log format.
CUSTOM: Custom log format (you define it).

Example of Custom Log Format:

log-format %h %l %u %t \"%r\" %>s %b

4. Advanced Features

1. Real-Time Monitoring:

To monitor logs in real-time:

tail -f /path/to/access.log | goaccess -

2. Processing Multiple Logs:

To process multiple log files:

goaccess /path/to/access1.log /path/to/access2.log -o report.html

3. Customizing Output:

You can customize the HTML report by editing the goaccess.conf file or using the --config option to specify a different configuration file.

5. Examples

Generating a Detailed HTML Report:

goaccess /var/log/nginx/access.log -o /var/www/html/report.html --log-format=COMBINED

Generating JSON Report for API Integration:

goaccess /var/log/nginx/access.log -o /var/www/html/report.json --log-format=COMBINED --json-pretty

Filtering by Date Range:

goaccess /var/log/nginx/access.log --log-format=COMBINED --date-format=%Y-%m-%d --time-format=%H:%M:%S --from-date=2024-01-01 --to-date=2024-01-31 -o /var/www/html/report.html

6. Troubleshooting

Invalid Log Format:

If you encounter issues with log format, ensure your log format in the GoAccess configuration matches your log file’s format. Refer to GoAccess documentation for formatting options.

Performance:

For large log files, ensure you have sufficient resources. GoAccess can handle large logs but may require more memory and CPU for extensive analysis.

Errors and Logs:

Check for error messages in the terminal or GoAccess log files to diagnose and resolve issues.

Conclusion

GoAccess is a powerful tool for analyzing web logs with a variety of options for customization and real-time monitoring. Whether you're troubleshooting issues, analyzing traffic patterns, or generating detailed reports, GoAccess provides a flexible and efficient solution.

Cockpit Kafka