Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ymtdzzz committed Apr 7, 2024
1 parent 8b4c3b6 commit 45f2292
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@

A terminal OpenTelemetry viewer inspired by [otel-desktop-viewer](https://github.com/CtrlSpice/otel-desktop-viewer/tree/main)

Traces
![Traces](./docs/traces.png)
![Spans](./docs/spans.png)

Logs
![Logs](./docs/logs.png)

## Getting Started

Expand All @@ -31,18 +34,21 @@ There're a lot of things to do. Here are some of them:
- [ ] Display metrics
- [ ] ...
- Logs
- [ ] Display logs
- [x] Display logs
- [x] Filter logs
- [x] Show log information
- [ ] Show logs related to a specific trace or span
- [ ] ...
- UI
- [ ] Improve UI
- [ ] Add more keybindings
- [ ] ...
- Performance
- [x] Timer based refresh
- [x] Data rotation (current buffer size: 1000 service root spans)
- [x] Data rotation (current buffer size: 1000 service root spans and logs)
- [ ] ...
- Configurations
- [ ] Endpoint
- [ ] Port
- [ ] Refresh interval
- [ ] Buffer size
- [ ] ...
Binary file added docs/logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/spans.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/traces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 45f2292

Please sign in to comment.