https://github.com/kevincobain2000/gol
No you don't need a 64GB RAM and ElasticSearch. An all in One - Dependency free (docker, local, remote) Log Viewer in Browser. Written in GO with God Speed.
https://github.com/kevincobain2000/gol
browser-logging docker-logs golang-log golang-logging log-management log-viewer log-visualization log-visualizer logs remote-log
Last synced: about 2 months ago
JSON representation
No you don't need a 64GB RAM and ElasticSearch. An all in One - Dependency free (docker, local, remote) Log Viewer in Browser. Written in GO with God Speed.
- Host: GitHub
- URL: https://github.com/kevincobain2000/gol
- Owner: kevincobain2000
- License: mit
- Created: 2024-06-07T04:59:15.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-02-15T10:23:09.000Z (4 months ago)
- Last Synced: 2025-03-31T18:18:28.321Z (2 months ago)
- Topics: browser-logging, docker-logs, golang-log, golang-logging, log-management, log-viewer, log-visualization, log-visualizer, logs, remote-log
- Language: Astro
- Homepage: https://medium.com/web-developer/logs-viewer-view-real-time-logs-in-your-browser-easily-d532f1000a2b
- Size: 323 KB
- Stars: 86
- Watchers: 5
- Forks: 10
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Logs Viewer
View realtime logs in your fav browser
Advanced regex search
Low Mem Footprint
Single binary
Supports
Docker Container logs from path
Docker Container logs
SSH remote logs
STDIN logs
Local logs
Tar logs
- **Quick Setup:** One command to install and run.
- **Hassle Free:** Doesn't require elastic search or other shebang.
- **Platform:** Supports (arm64, arch64, Mac, Mac M1, Ubuntu and Windows).
- **Flexible:** View docker logs, remote logs over ssh, files on disk and piped inputs in browser.
- **Intelligent** Smartly judges log level, and dates.
- **Search** Fast search with regex.
- **Realtime** Tail logs in real time in browser.
- **Log Rotation** Supports log rotation and watch for new log files.
- **Embed in GO** Easily embed in your existing Go app.
View in Browser
Intuitive UI to view logs in browser
### Install using curl
Use this method if go is not installed on your server
```bash
curl -sL https://raw.githubusercontent.com/kevincobain2000/gol/master/install.sh | sh
```
## Examples
### CLI - Basic Example
```sh
# run in current directory for pattern
gol "*log" "access/*log.tar.gz"
```
### CLI - Advanced Examples
All patterns work in combination with each other.
```sh
# search using pipe and file patterns
demsg | gol -f="/var/log/*.log"
# over ssh
# port optional (default 22), password optional (default ''), private_key optional (default $HOME/.ssh/id_rsa)
gol -s="user@host[:port] [password=/path/to/password] [private_key=/path/to/key] /app/*logs"
# Docker all container logs
gol -d=""
# Docker specific container logs
gol -d="container-id"
# Docker specific path on a container
gol -d="container-id /app/logs.log"
# All patterns combined
gol -d="container-id" \
-d="container-id /app/logs.log" \
-s="user@host[:port] [password=/path/to/password] [private_key=/path/to/key] /app/*logs" \
-f="/var/log/*.log"
```
### Embed in GO
If you don't want to use CLI to have seperate port and want to integrate within your existing Go app.
```go
import (
"fmt"
"net/http"
"github.com/kevincobain2000/gol"
)
func main() {
// init with options of file path you want to watch
g := gol.NewGol(func(o *gol.GolOptions) error {
o.FilePaths = []string{"*.log"}
return nil
})
// register following two routes
http.HandleFunc("/gol/api", g.Adapter(g.NewAPIHandler().Get))
http.HandleFunc("/gol", g.Adapter(g.NewAssetsHandler().Get))
// start server as usual
http.ListenAndServe("localhost:8080", nil)
}
```
## CHANGE LOG
- **v1.0.0** - Initial release.
- **v1.0.3** - Multiple file patterns, and pipe input support.
- **v1.0.4** - Support os.Args for quick view.
- **v1.0.5** - Support ssh logs.
- **v1.0.6** - UI shows grouped output.
- **v1.0.7** - Support docker logs.
- **v1.0.14** - Sleak UI changes and support dates.
- **v1.0.17** - Support both ignore and include patterns.
- **v1.0.21** - Better logging.
- **v1.0.22** - Support UA.
- **v1.0.24** - Dropdown on files.
- **v1.0.25** - Searchable files.
- **v1.1.0** - Embed in GO, buggy.
- **v1.1.1** - Embed in GO, stable.
- **v1.1.2** - Go VUP
- **v1.1.3** - Node VUP and debounce for better performance.
## Limitations
- **Docker Logs:** Only supports logs from containers running on the same machine.
- **fmt, stdout:** For embedded use, fmt and stdout logs are not intercepted.
**Tip:** If you want to capture, then run your app by piping output as `./app >> logs.log`.
## Development Notes
```sh
# Get some fake logs
mkdir -p testdata
while true; do date >> testdata/test.log; sleep 1; done
# Start the API
cd frontend
go run main.go --cors=4321 --open=false -f="../testdata/*log"
# API development on http://localhost:3003/api
# Start the frontend
npm install
npm run dev
# Frontend development on http://localhost:4321/
```