Skip to content

Commit

Permalink
Tweaks on the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aurc committed Jul 31, 2022
1 parent ad00fd9 commit 926362b
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 22 deletions.
47 changes: 26 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,32 @@ Latest Release [pre-build binaries here](https://github.com/aurc/loggo/releases/
Loggo can be used to stream parsed logs from a persisted file and from a
piped input and also provides a tool for creating log templates.

### Some Features
- Local Log filtering/search
- Main log stream remains unaffected regardless of the source (gcp, pipe, file, etc...)
- Display only log entries that match search/filter criteria
- Convenient key finder and operators for filter expression crafting
![](img/loggo_filter.png)
- Drill down onto each log entry
![](img/log_entry.png)
- Copy Log-Entry to Clipboard
- Note: Linux requires X11 dev package. For instance, install `libx11-dev` or `xorg-dev` or `libX11-devel` to access X window system.
![](img/copy_clipboard.png)
- Navigate Left-Right-Up-Down on Large Grids
- Select a Line
- Use the arrow keys (`↓ ↑ ← →`)
![](img/mov/nav_right_left.gif)
- Select on screen text
- Horizontally based selection (`Alt` + Mouse `Click/Drag`)
- Block/Vertical based selection (`Cmd`+`Opt`+ Mouse `Click/Drag` - macOS)
- Copy the selected text to clipboard (`Cmd`+`C` - macOS/`Ctrl`+`C` - other systems)
![](img/mov/selection.gif)
- Configure Rendering Templates:
![](img/render_template.png)
- Fine Tune how columns are displayed (Template):
- Note that single Value Matches are REGEX expressions.
![](img/how_to_display.png)

### `help` Command

To gain fine grained insight of each `loggo` command params, use
Expand Down Expand Up @@ -127,27 +153,6 @@ tail -f <my file> | loggo stream --template <my template yaml>

Note that you can pipe to anything that produces an output to the `stdin`.

**Some Additional Features:**
- Drill down onto each log entry
![](img/log_entry.png)
- Copy Log-Entry to Clipboard
- Note: Linux requires X11 dev package. For instance, install `libx11-dev` or `xorg-dev` or `libX11-devel` to access X window system.
![](img/copy_clipboard.png)
- Navigate Left-Right-Up-Down on Large Grids
- Select a Line
- Use the arrow keys (`↓ ↑ ← →`)
![](img/mov/nav_right_left.gif)
- Select on screen text
- Horizontally based selection (`Alt` + Mouse `Click/Drag`)
- Block/Vertical based selection (`Cmd`+`Opt`+ Mouse `Click/Drag` - macOS)
- Copy the selected text to clipboard (`Cmd`+`C` - macOS/`Ctrl`+`C` - other systems)
![](img/mov/selection.gif)
- Configure Rendering Templates:
![](img/render_template.png)
- Fine Tune how columns are displayed (Template):
- Note that single Value Matches are REGEX expressions.
![](img/how_to_display.png)

### `gcp-stream` Command
l`oGGo natively supports GCP Logging but in order to use this feature, there are a few caveats:
- You have [gcloud command line SDK](https://cloud.google.com/sdk/docs/install) installed locally.
Expand Down
Binary file added img/loggo_filter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion internal/loggo/log_view.go
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,10 @@ func (l *LogView) makeUIComponents() {
l.filterView = NewFilterView(l.app, func(expression *filter.Expression) {
l.rebufferFilter = true
l.filterChannel <- expression
go l.app.Draw()
go func() {
time.Sleep(200 * time.Millisecond)
l.app.Draw()
}()
})
}

Expand Down

0 comments on commit 926362b

Please sign in to comment.