Developing a Local OpenTelemetry Viewer for Developers and AI Agents

OpenTelemetry is a powerful tool that helps developers collect traces, logs, and metrics from their applications. This is done without tying the data collection to a specific observability vendor. However, when developing locally, it can be challenging to quickly see what your application has sent, especially when something goes wrong.

What is otel-gui?

To address this challenge, otel-gui has been developed as a local-first debugging tool. It allows developers to visualize and analyze telemetry data quickly. Instead of needing a full observability stack, you can simply point an OpenTelemetry exporter at the local viewer, execute a request, and explore the telemetry.

Features of otel-gui

Local Telemetry Visualization

One of the key features of otel-gui is its ability to visualize telemetry data locally. It listens on port 4318, which is the standard port for OpenTelemetry data. This means many applications can send telemetry data with little to no configuration changes required.

Support for Multiple Telemetry Signals

Initially, otel-gui focused on traces, but it has since expanded to include logs and metrics. This allows developers to get a complete view of their application's behavior. The tool provides a waterfall view for traces, showing the parent-child relationships and timing, which helps in identifying errors and understanding the flow of requests.

User-Friendly Interface

The interface is designed to be intuitive. It includes a service map that visualizes how different services interact, making it easier to spot bottlenecks. Additionally, correlated logs enrich the spans with related log entries, providing context around each span.

Data Export and Import

Another useful feature is the ability to export and import telemetry data. This makes it easier to share traces and logs with teammates or reproduce issues in different environments. For instance, you can capture a complex trace and share it without needing access to the original system. This feature supports collaboration and enhances debugging efforts.

How otel-gui Works

Step 1: Set Up the Viewer

To get started, you need to set up otel-gui on your local machine. You can run the viewer without provisioning a database, as it retains telemetry in memory by default.

Step 2: Send Telemetry Data

Once the viewer is running, configure your application to send telemetry data to it. This can be done by pointing your OpenTelemetry exporter to the viewer's address.

Step 3: Explore the Data

After sending the telemetry, you can explore the data through the user interface. You can visualize traces, logs, and metrics, helping you understand application behavior and identify issues.

Why Visual Interfaces Matter

Visual interfaces are important for debugging because they help developers form and test hypotheses about their applications. Seeing the timing and relationships of traces in a visual format makes it easier to answer questions like:

• Which service handled this request?
• Where did the time go?
• Did a retry succeed?

AI Agents and otel-gui

While the visual interface is great for developers, AI agents require a different approach. They need a direct way to ask questions and retrieve relevant records without navigating through a UI. otel-gui provides an MCP (Model Context Protocol) endpoint that allows AI agents to search traces, logs, and metrics programmatically. This means that while a developer can inspect a waterfall view, an AI agent can query the data directly.

Conclusion

In summary, otel-gui is a valuable tool for developers looking to visualize and analyze telemetry data locally. It simplifies the process of debugging applications by providing a user-friendly interface and supporting collaboration through data export and import.

Merits

• Quick local visualization of telemetry data.
• Supports traces, logs, and metrics in one tool.
• User-friendly interface for easier debugging.
• Data export and import for collaboration.

Demerits

• Limited to local development environments.
• May not replace full observability stacks for larger applications.

Caution

This article is intended for educational purposes. Any placeholder values must be replaced with actual data in practical applications. Readers should verify all claims against the original source before relying on them.

Frequently asked questions

• What is OpenTelemetry? — OpenTelemetry is a framework for collecting telemetry data such as traces, logs, and metrics from applications.
• What is otel-gui? — otel-gui is a local-first debugging tool that helps visualize telemetry data without needing a full observability stack.
• How does otel-gui help with debugging? — It provides a user-friendly interface to visualize traces, logs, and metrics, making it easier to identify issues.
• Can otel-gui export telemetry data? — Yes, otel-gui supports exporting and importing telemetry data for easier collaboration.
• What telemetry signals does otel-gui support? — It supports traces, logs, and metrics, providing a comprehensive view of application behavior.
• Is otel-gui suitable for production use? — otel-gui is designed for local development and may not replace full observability solutions for production environments.

Tags

#opentelemetry #devtools #ai