Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/variar/klogg
Really fast log explorer based on glogg project
https://github.com/variar/klogg
cpp cross-platform hacktoberfest linux log-analyzer log-monitor log-viewer logs macos qt tail windows
Last synced: about 1 month ago
JSON representation
Really fast log explorer based on glogg project
- Host: GitHub
- URL: https://github.com/variar/klogg
- Owner: variar
- License: gpl-3.0
- Fork: true (nickbnf/glogg)
- Created: 2016-03-09T18:55:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T21:55:17.000Z (3 months ago)
- Last Synced: 2024-09-25T09:33:04.774Z (about 1 month ago)
- Topics: cpp, cross-platform, hacktoberfest, linux, log-analyzer, log-monitor, log-viewer, logs, macos, qt, tail, windows
- Language: C++
- Homepage: https://klogg.filimonov.dev
- Size: 97 MB
- Stars: 2,291
- Watchers: 37
- Forks: 198
- Open Issues: 223
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: COPYING
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://github.com/variar/klogg/blob/master/COPYING)
[]()
[](https://github.com/variar/klogg/graphs/contributors/)
[](http://makeapullrequest.com)
[](https://www.codacy.com/manual/variar/klogg?utm_source=github.com&utm_medium=referral&utm_content=variar/klogg&utm_campaign=Badge_Grade)
[](https://github.com/variar/klogg/releases/)
[ ](https://github.com/variar/klogg/releases/latest)
[](https://repology.org/project/klogg/versions)
Check [GitHub releases](https://github.com/variar/klogg/releases/latest) for Windows installers and Linux/Mac packages.
Development status
[](https://github.com/variar/klogg/milestone/4)
[](https://github.com/variar/klogg/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+ready+for+testing%22)
[](https://github.com/variar/klogg/issues?q=is%3Aissue+label%3A%22status%3A+need+documentation%22)
[](https://github.com/variar/klogg/commits/)
[](https://github.com/variar/klogg/actions/workflows/ci-build.yml)
[](https://discord.gg/DruNyQftzB) [](https://gitter.im/klogg_log_viewer/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## 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](DOCUMENTATION.md)
page for how to use Klogg.
### Latest testing builds
| Windows | Linux | Mac |
| ------------- |------------- | ------------- |
| [continuous-win](https://github.com/variar/klogg/releases/tag/continuous-win) | [continuous-linux](https://github.com/variar/klogg/releases/tag/continuous-linux) | [continuous-osx](https://github.com/variar/klogg/releases/tag/continuous-osx) |
I try to keep a [changelog](CHANGELOG.md) with monthly changes.
## Table of Contents
1. [About the Project](#about-the-project)
1. [Installation](#installation)
1. [Building](#building)
1. [How to Get Help](#how-to-get-help)
1. [Contributing](#contributing)
1. [License](#license)
1. [Authors](#authors)
## About the Project
Klogg started as a fork of [glogg](https://github.com/nickbnf/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.
### Comparing with glogg
Klogg has all best features of 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
And on top of that klogg:
* Is heavily optimized using multi-threading and SIMD
* Supports files with more than 2147483647 lines
* Includes much faster regular expressions search (2-4 times)
* Allows combining regular expressions with boolean operators (AND, OR, NOT)
* Supports many common text encodings
* Detects file encoding automatically using [uchardet](https://www.freedesktop.org/wiki/Software/uchardet/) library (supports utf8, utf16, cp1251 and more)
* Can limit search operations to some part of huge file
* Allows to configure several highlighters sets and switch between them
* Has a list of configurable predefined regular expression patterns
* Includes a dark mode
* Has configurable shortcuts
* Has a scratchpad window for taking notes and doing basic data transformations
* Provides lots of small features that make life easier (closing tabs, copying file paths, favorite files menu, etc.)
Here is a small demo showing how much faster klogg is (searching in ~1Gb file stored on tmpfs):
https://user-images.githubusercontent.com/1620716/117588567-bea39100-b12c-11eb-990a-90a667bcaeaa.mp4
List of glogg issues that have been fixed/implemented in klogg can be found [here](https://github.com/variar/klogg/discussions/302).
List of all changes can be found [here](https://github.com/variar/klogg/milestone/8?closed=1).
**[Back to top](#table-of-contents)**
## Installation
This project uses [Calendar Versioning](https://calver.org/). For a list of available versions, see the [repository tag list](https://github.com/variar/klogg/tags).
### Current stable release builds
Binaries for all platforms can be downloaded from GitHub releases.
[ ](https://github.com/variar/klogg/releases/latest)
#### Windows
Windows installer is also available from:
* [ ](https://chocolatey.org/packages/klogg)
* [ ](https://scoopsearch.github.io/#/apps?q=klogg)
* [Winget package](https://winget.run/pkg/variar/klogg)
#### Mac OS
Package for Mac can be installed from Homebrew
[ ](https://formulae.brew.sh/cask/klogg)
#### Linux
It is recommended to use klogg package from distribution-specific [repositories](https://repology.org/project/klogg/versions).
Generic packages are available from klogg DEB and RPM repositories hosted at GitHub Pages.
They are built to run on Ubuntu 18.04/20.04/22.04 and Oracle Linux 7/8 (x86-64 only).
For DEB packages first download the gpg key:
```
curl -sS https://klogg.filimonov.dev/klogg.gpg.key | gpg --dearmor | sudo tee /etc/apt/keyrings/klogg.gpg
```
You might need to manually create `/etc/apt/keyrings` directory.
Then download the repository list file for you distribution (replace `` with one of `bionic`, `focal`, `jammy`):
```
curl -sS https://klogg.filimonov.dev/deb/klogg..list | sudo tee /etc/apt/sources.list.d/klogg.list
```
Finally, install using apt
```
sudo apt-get update
sudo apt install klogg
```
If there is already an entry for JFrogg hosted klogg repository in `/etc/apt/sources.list`, then remove this line from it:
```
deb [trusted=yes] https://favpackage.jfrog.io/artifactory/klogg_deb/ utils
```
For RPM download klogg repo file (replace `` with one of `7`, `8`):
```
curl -sS https://klogg.filimonov.dev/rpm/klogg-oracle-.repo | sudo tee /etc/yum.repos.d/klogg-rpm.repo
```
Then install using yum
```
sudo yum update
sudo yum install klogg
```
There is also an AppImage package that can be used without installation. To run klogg from AppImage, download the package and make in executable with either a file manager or terminal command `chmod +x ` and then run the AppImage file.
AppImage uses FUSE2 and Ubuntu 22.04 has moved away from FUSE2 into FUSE3 and therefore you need to install the necessary package to enable compatibility with FUSE2 `sudo apt install libfuse2`.
As indicated by this link from the official appimage documentation: https://docs.appimage.org/user-guide/troubleshooting/fuse.html#setting-up-fuse-2-x-alongside-of-fuse-3-x-on-recent-ubuntu-22-04-debian-and-their-derivatives
### Testing builds
| Windows | Linux | Mac |
| ------------- |------------- | ------------- |
| [continuous-win](https://github.com/variar/klogg/releases/tag/continuous-win) | [continuous-linux](https://github.com/variar/klogg/releases/tag/continuous-linux) | [continuous-osx](https://github.com/variar/klogg/releases/tag/continuous-osx) |
**[Back to top](#table-of-contents)**
## Building
Please review
[BUILD.md](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](DOCUMENTATION.md)
page.
You can open issues using [klogg issues page](https://github.com/variar/klogg/issues)
or post questions to glogg development [mailing list](http://groups.google.co.uk/group/glogg-devel).
## Contributing
We encourage public contributions! Please review [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and development process.
## License
This project is licensed under the GPLv3 or later - see [COPYING](COPYING) file for details.
## Authors
* **[Anton Filimonov](https://github.com/variar)**
* *Initial work* - **[Nicolas Bonnefon](https://github.com/nickbnf)**
See also the list of [contributors](https://klogg.filimonov.dev/docs/getting_involved/#contributors) who participated in this project.
**[Back to top](#table-of-contents)**