lilventi / klogg

A fast, advanced log explorer based on glogg project

Klogg

Overview

Klogg is a multi-platform GUI application that helps browse and search through long and complex log files. It is designed with programmers and system administrators in mind and can be seen as a graphical, interactive combination of grep, less, and tail.

Please refer to the documentation page for how to use Klogg.

Current stable release

Latest testing builds

Windows	Linux	Mac
continuous-win	continuous-linux	continuous-osx

Table of Contents

1. About the Project
2. Installation
3. Building
4. How to Get Help
5. Contributing
6. License
7. Authors

About the Project

Klogg started as a fork of glogg - the fast, smart log explorer in 2016.

Since then it has evolved from fixing small annoying bugs to rewriting core components to make it faster and smarter that predecessor.

Development of klogg is driven by features my colleagues and I need to stay productive as well as feature requests from users on Github and in glogg mailing list.

Latest news about klogg development can be found at https://klogg.filimonov.dev.

Common features of klogg and glogg

• Runs on Unix-like systems, Windows and Mac thanks to Qt5
• Is fast and reads the file directly from disk, without loading it into memory
• Can operate on huge text files (10+ Gb is not a problem)
• Search results are displayed separately from original file
• Supports Perl-compatible regular expressions
• Colorizes the log and search results
• Displays a context view of where in the log the lines of interest are
• Watches for file changes on disk and reloads it (kind of like tail)
• Is open source, released under the GPL

Features of klogg

• Multithreading support for file indexing and regular expression matching
• Log encoding detection using uchardet library (support utf8, utf16, cp1251 and more)
• Limiting search to a part of open file
• In-memory cache of search results per search pattern
• Support for many common text encodings
• And lots of small features that make life easier (closing tabs, copying file paths, favorite files menu, etc.)

Back to top

Installation

This project uses Calendar Versioning. For a list of available versions, see the repository tag list.

Current stable release builds

Current release is 20.12. Binaries for all platforms can be downloaded from GitHub releases or Bintray.

Windows installer is also available from Chocolatey:

Package for Mac can be installed from Homebrew

Linux packages are also available from DEB and RPM repositories.

For DEB add Bintray GPG key and repository, then install from apt:

wget -qO - https://bintray.com/user/downloadSubjectPublicKey?username=bintray | sudo apt-key add -
echo deb https://dl.bintray.com/variar/deb stable utils | sudo tee -a /etc/apt/sources.list
sudo apt-get update
sudo apt-get install klogg

For RPM:

curl https://bintray.com/variar/rpm/rpm | sudo tee /etc/yum.repos.d/bintray-variar-rpm.repo
sudo yum update
sudo yum install klogg

Tesing builds

Windows	Linux	Mac
continuous-win	continuous-linux	continuous-osx

Back to top

Building

Please review BUILD.md for how to setup Klogg on your local machine for development and testing purposes.

How to Get Help

First, please refer to the documentation page.

You can open issues using klogg issues page or post questions to glogg development mailing list.

Contributing

We encourage public contributions! Please review CONTRIBUTING.md for details on our code of conduct and development process.

License

This project is licensed under the GPLv3 or later - see COPYING file for details.

Authors

• Anton Filimonov
• Initial work - Nicolas Bonnefon

See also the list of contributors who participated in this project.

Back to top