OpenTelemetry Inspector

OpenTelemetry Inspector is a desktop application designed to receive, decode, and visualize OpenTelemetry data (Logs, Traces, and Metrics) in real-time. It acts as a local OTLP sink, making it easy to debug and verify telemetry output from your applications.

Features

• Real-time Visualization: View traces, metrics, and logs as they arrive.
• OTLP Support: Receives data via OTLP over gRPC (port 4317) and HTTP (port 4318).
• Cross-Platform: Available for Linux (RPM/Deb), macOS, and as a Docker container.
• Modern UI: Built with Vue.js and PrimeVue for a sleek, responsive experience.

---

Installation & Usage

The application can be installed as a desktop application or as a Docker container.

Desktop Application

You can download the application for your platform from the releases page.

Docker

You can run the inspector as a Docker container and send telemetry to it from other containers or your host.

# Pull the latest image
docker pull ghcr.io/vmladenov/opentelemetry-inspect:latest

# Run the container mapping OTLP ports
docker run -d --rm \
  -p 4317:4317 \
  -p 4318:4318 \
  --name opentelemetry-inspect \
  ghcr.io/vmladenov/opentelemetry-inspect:latest

macOS (Unsigned App)

If you download the .dmg from the releases, macOS will likely block it because it is not signed. To run it, you may need to remove the "quarantine" attribute:

# After moving the app to your Applications folder
xattr -d com.apple.quarantine /Applications/OpenTelemetry.Inspector.app

---

Building from Source

Prerequisites

• Rust: Install Rust
• Bun: Install Bun
• Protobuf Compiler: Needed for decoding OTLP data.
  • Linux: sudo apt install protobuf-compiler or sudo dnf install protobuf-compiler
  • macOS: brew install protobuf

Build Steps

1. Clone the repository:

   git clone https://github.com/vmladenov/opentelemetry-inspect.git
   cd opentelemetry-inspect/app

2. Install dependencies:

   bun install

3. Build the application:

   # For a production build (RPM/Deb/DMG based on your OS)
   bun tauri build

4. Run in development mode:

   bun tauri dev

---

Prepare flatpak

Generate flatpak sources.json files by using flatpak-build-tools:

cd flatpak-builder-tools/node
uv run flatpak-node-generator -o "$PROJECT_ROOT/dist/linux/node-sources.json" npm "$PROJECT_ROOT/app/package-lock.json"
cd flatpak-builder-tools/cargo
uv run flatpak-cargo-generator.py -o "$PROJECT_ROOT/dist/linux/cargo-sources.json" "$PROJECT_ROOT/app/src-tauri/Cargo.lock"

Then build the flatpak file.

./scripts/build-flatpak.sh

License

GPL-3.0 License. See LICENSE for details.