otel-tui

README

otel-tui

🚧 This project is under construction 🚧

A terminal OpenTelemetry viewer inspired by otel-desktop-viewer

Traces

Logs

Getting Started

Currently, this tool exposes port 4317 to receive OpenTelemetry signals.

Homebrew

$ brew install ymtdzzz/tap/otel-tui

Docker

Run in the container simply:

$ docker run --rm -it --name otel-tui ymtdzzz/otel-tui:latest

Or, run as a background process and attach it:

# Run otel-tui as a background process
$ docker run --rm -dit --name otel-tui ymtdzzz/otel-tui:latest

# Show TUI in your current terminal session
$ docker attach otel-tui

Docker Compose

First, add service to your manifest (docker-compose.yaml) for the instrumanted app

  oteltui:
    image: ymtdzzz/otel-tui:latest
    container_name: otel-tui
    stdin_open: true
    tty: true

Modify configuration for otelcol

exporters:
  otlp:
    endpoint: oteltui:4317
service:
  pipelines:
    traces:
      exporters: [otlp]
    logs:
      exporters: [otlp]

Run as a background process and attach it:

# Run services as usual
$ docker compose up -d

# Show TUI in your current terminal session
$ docker compose attach oteltui

Executable Binary from Github Release page

https://github.com/ymtdzzz/otel-tui/releases

From Source

$ git clone https://github.com/ymtdzzz/otel-tui.git
$ cd otel-tui
$ go run ./...

TODOs

There're a lot of things to do. Here are some of them:

• Traces
  • Display traces
  • Filter traces
  • Show trace information
  • ...
• Metrics
  • Display metrics
  • ...
• Logs
  • Display logs
  • Filter logs
  • Show log information
  • Show logs related to a specific trace or span
  • ...
• UI
  • Improve UI
  • Add more keybindings
  • ...
• Performance
  • Timer based refresh
  • Data rotation (current buffer size: 1000 service root spans and logs)
  • ...
• Configurations
  • Port
  • Refresh interval
  • Buffer size
  • ...