otel-tui

https://github.com/ymtdzzz/otel-tui
Admin
A terminal-based viewer for OpenTelemetry, Zipkin (Traces), and Prometheus (Metrics) data, offering...
Tokens:2,241
Snippets:8
Trust Score:9.1
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install otel-tui with go install

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Installs the otel-tui tool using the 'go install' command. This method fetches the latest version directly from the GitHub repository and compiles it.

```go
$ go install github.com/ymtdzzz/otel-tui@latest
```

--------------------------------

### Install otel-tui with Homebrew

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Installs the otel-tui tool using the Homebrew package manager. This is a convenient way to get the latest version of the application on macOS and Linux systems.

```sh
$ brew install ymtdzzz/tap/otel-tui
```

--------------------------------

### Configure otel-tui with Docker Compose

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Sets up otel-tui as a service within a Docker Compose configuration. This example shows how to define the service, override the entrypoint to enable Zipkin, and configure other services to send telemetry data to otel-tui.

```yml
oteltui:
  image: ymtdzzz/otel-tui:latest
  container_name: otel-tui
  stdin_open: true
  tty: true
  # Override entrypoint if you want use options
  entrypoint: ["/otel-tui", "--enable-zipkin"]

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

--------------------------------

### Run otel-tui with Docker Compose

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Starts and attaches to the otel-tui service defined in a Docker Compose setup. This command allows users to view the terminal UI after the services have been started in the background.

```sh
# Run services as usual
$ docker compose up -d

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

# Detach by pressing Ctrl+p -> Ctrl+q
```

--------------------------------

### Run otel-tui with Docker

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Runs the otel-tui application using a Docker container. This allows for isolated execution without needing to install the tool directly on the host system. It can be run interactively or in detached mode.

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

# 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

# Detach by pressing Ctrl+p -> Ctrl+q
```

--------------------------------

### Build and run otel-tui from source

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Clones the otel-tui repository from GitHub and runs the application using Go. This method is suitable for developers who want to contribute to the project or run the latest unreleased code.

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

--------------------------------

### Develop with otel-tui using Nix

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Enables a development environment for otel-tui using Nix. This command fetches the necessary dependencies and sets up the environment for working with the project.

```nix
nix develop github:ymtdzzz/otel-tui
```

--------------------------------

### Run lint and test commands for otel-tui

Source: https://github.com/ymtdzzz/otel-tui/blob/main/README.md

Executes linting and testing commands for the otel-tui project. These commands ensure code quality and verify the functionality of the application before or during development.

```sh
make lint
make lint-exporter
make test
make test-exporter
```
Tokens:
Raw