如何快速开始使用 otel-desktop-viewer5分钟本地监控设置教程【免费下载链接】otel-desktop-viewerotel-desktop-viewer is a CLI tool for receiving OpenTelemetry traces while working on your local machine.项目地址: https://gitcode.com/gh_mirrors/ot/otel-desktop-viewerOpenTelemetry 桌面查看器 otel-desktop-viewer 是一款专为本地开发设计的强大 CLI 工具让你能在 5 分钟内快速搭建本地监控环境。这个终极指南将带你从零开始掌握这个简单、免费的开源工具轻松查看应用性能指标、追踪和日志数据。✨ 什么是 otel-desktop-viewerotel-desktop-viewer是一个基于 OpenTelemetry Collector 构建的本地监控工具使用 Go 语言开发后端采用 DuckDB 数据库前端使用 Svelte 框架。它能够接收并可视化你的应用产生的追踪、指标和日志数据无需复杂的云端服务配置。 快速安装指南方法一使用 Homebrew CaskmacOS 用户首选这是最简单快捷的安装方式特别适合 macOS 用户brew tap ctrlspice/otel-desktop-viewer brew install --cask otel-desktop-viewer方法二下载预编译二进制文件支持多种操作系统和架构直接从 GitHub Releases 下载对应版本平台架构文件macOSApple Silicon (M1–M4)otel-desktop-viewer_darwin_arm64.tar.gzmacOSIntelotel-desktop-viewer_darwin_amd64.tar.gzLinuxx86_64otel-desktop-viewer_linux_amd64.tar.gzLinuxarm64otel-desktop-viewer_linux_arm64.tar.gzWindowsx86_64otel-desktop-viewer_windows_amd64.zip下载后解压并运行即可# 以 macOS Apple Silicon 为例 curl -LO https://github.com/CtrlSpice/otel-desktop-viewer/releases/latest/download/otel-desktop-viewer_darwin_arm64.tar.gz tar xzf otel-desktop-viewer_darwin_arm64.tar.gz ./otel-desktop-viewer方法三使用 Docker 容器如果你更喜欢容器化部署Docker 是最佳选择docker pull ghcr.io/ctrlspice/otel-desktop-viewer:latest docker run -p 8000:8000 -p 4317:4317 -p 4318:4318 ghcr.io/ctrlspice/otel-desktop-viewer:latest⚙️ 一键启动与配置安装完成后启动 otel-desktop-viewer 非常简单# 基本启动默认使用内存存储 otel-desktop-viewer # 使用持久化存储 otel-desktop-viewer --db ./telemetry.duckdb # 自定义端口 otel-desktop-viewer --browser-port 8080 --http 4320 --grpc 4321启动后工具会自动打开浏览器访问http://localhost:8000你会看到友好的 Web 界面。 配置你的 OpenTelemetry SDK要让你的应用数据发送到 otel-desktop-viewer需要配置 OTLP 导出器。以下是完整的配置方法环境变量配置推荐这是最简单的方法适用于大多数 OpenTelemetry SDK# HTTP 协议配置 export OTEL_EXPORTER_OTLP_ENDPOINThttp://localhost:4318 export OTEL_TRACES_EXPORTERotlp export OTEL_METRICS_EXPORTERotlp export OTEL_LOGS_EXPORTERotlp export OTEL_EXPORTER_OTLP_PROTOCOLhttp/protobuf # 或者使用 gRPC 协议 export OTEL_EXPORTER_OTLP_ENDPOINThttp://localhost:4317 export OTEL_EXPORTER_OTLP_PROTOCOLgrpc代码配置示例如果你需要在代码中直接配置这里有几个常见语言的示例Go 语言配置import ( go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp go.opentelemetry.io/otel/sdk/trace ) func setupTracer() { exporter, _ : otlptracehttp.New(context.Background(), otlptracehttp.WithEndpoint(localhost:4318), otlptracehttp.WithInsecure(), ) tp : trace.NewTracerProvider(trace.WithBatcher(exporter)) otel.SetTracerProvider(tp) }Python 配置from opentelemetry import trace from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter from opentelemetry.sdk.trace import TracerProvider from opentelemetry.sdk.trace.export import BatchSpanProcessor trace.set_tracer_provider(TracerProvider()) tracer_provider trace.get_tracer_provider() tracer_provider.add_span_processor( BatchSpanProcessor( OTLPSpanExporter(endpointhttp://localhost:4318/v1/traces) ) ) 快速测试使用 otel-cli 发送示例数据如果你还没有可监控的应用可以使用otel-cli工具快速生成测试数据# 安装 otel-cli go install github.com/equinix-labs/otel-clilatest # 设置环境变量 export OTEL_EXPORTER_OTLP_ENDPOINThttp://localhost:4318 export OTEL_EXPORTER_OTLP_PROTOCOLhttp/protobuf # 发送一个简单的追踪 otel-cli exec --service my-service --name 测试请求 curl -s -o /dev/null https://example.com发送数据后打开http://localhost:8000/traces就能看到追踪数据了 三大核心功能详解1. 追踪可视化Tracesotel-desktop-viewer 的追踪界面提供了完整的瀑布图视图让你清晰看到服务间的调用关系每个 span 的耗时和状态详细的属性和事件信息父子 span 的层级关系2. 指标监控Metrics指标界面支持多种图表类型折线图展示趋势变化柱状图对比不同维度热图显示时间分布支持多种聚合方式sum、avg、min、max 等3. 日志查看Logs日志界面提供了强大的搜索和过滤功能按时间范围筛选按服务名称过滤关键词搜索日志级别筛选结构化日志展示️ 高级配置技巧Docker Compose 集成如果你使用 Docker Compose 管理服务可以这样集成services: your-app: image: your-app:latest environment: - OTEL_EXPORTER_OTLP_ENDPOINThttp://otel-desktop-viewer:4318 - OTEL_TRACES_EXPORTERotlp - OTEL_METRICS_EXPORTERotlp otel-desktop-viewer: image: ghcr.io/ctrlspice/otel-desktop-viewer:latest ports: - 8000:8000 - 4317:4317 - 4318:4318持久化存储配置默认情况下otel-desktop-viewer 使用内存存储重启后数据会丢失。要持久化存储使用--db参数# 使用文件存储 otel-desktop-viewer --db ./otel-data.duckdb # 或者使用绝对路径 otel-desktop-viewer --db /path/to/otel-data.duckdb自定义网络配置如果你的服务运行在不同的网络环境中# 监听所有网络接口 otel-desktop-viewer --host 0.0.0.0 # 自定义所有端口 otel-desktop-viewer --host 0.0.0.0 --browser-port 9000 --http 4320 --grpc 4321 实用命令参考常用命令行选项选项默认值说明--browser-port8000Web UI 和 JSON-RPC API 端口--db(内存)DuckDB 文件路径持久化存储--grpc4317OTLP gRPC 监听端口--hostlocalhost所有端点的绑定地址--http4318OTLP HTTP 监听端口--open-browsertrue启动时自动打开浏览器查看帮助和版本信息# 查看所有可用选项 otel-desktop-viewer --help # 查看版本信息 otel-desktop-viewer --version 界面功能亮点深色模式支持otel-desktop-viewer 提供了两种深色模式主题保护你的眼睛特别是在夜间工作时标准深色模式- 舒适的深灰色背景增强深色模式- 更深的黑色背景减少眩光实时数据更新界面会自动轮询新数据无需手动刷新。你可以实时查看最新的追踪数据监控指标变化趋势查看实时日志流强大的搜索功能所有界面都支持高级搜索按时间范围过滤按服务名称筛选按属性值搜索支持复杂查询表达式 故障排除指南常见问题解决问题1无法连接到 otel-desktop-viewer# 检查服务是否运行 curl http://localhost:8000 # 检查端口是否被占用 lsof -i :8000 lsof -i :4317 lsof -i :4318问题2应用数据没有显示# 确认环境变量设置正确 echo $OTEL_EXPORTER_OTLP_ENDPOINT # 测试 OTLP 连接 curl -X POST http://localhost:4318/v1/traces -H Content-Type: application/json -d {}问题3Docker 容器无法启动# 检查端口冲突 docker ps # 查看容器日志 docker logs container-id 最佳实践建议开发环境配置为每个项目创建独立的存储文件otel-desktop-viewer --db ./project1.duckdb使用 Docker Compose 统一管理# docker-compose.yml version: 3.8 services: app: # 你的应用配置 otel-desktop-viewer: image: ghcr.io/ctrlspice/otel-desktop-viewer:latest ports: - 8000:8000 - 4317:4317 - 4318:4318 volumes: - ./otel-data:/data command: [--db, /data/telemetry.duckdb]配置 IDE 启动脚本// VS Code launch.json { version: 0.2.0, configurations: [ { name: 启动 otel-desktop-viewer, type: go, request: launch, mode: exec, program: ${workspaceFolder}/otel-desktop-viewer, args: [--db, ./debug.duckdb] } ] }性能优化合理设置采样率- 在开发环境中可以设置较低的采样率使用批处理- 确保你的 SDK 配置了批处理处理器定期清理旧数据- 使用持久化存储时定期清理不需要的历史数据 总结otel-desktop-viewer 是一个功能强大且易于使用的本地 OpenTelemetry 监控工具。通过这个 5 分钟教程你已经学会了✅ 多种安装方法Homebrew、二进制、Docker✅ 快速启动和基本配置✅ 如何配置你的应用发送数据✅ 使用 otel-cli 进行快速测试✅ 三大核心功能的使用✅ 高级配置和故障排除技巧现在你可以在本地开发环境中轻松监控应用的性能指标、追踪和日志数据无需依赖复杂的云端服务。开始使用 otel-desktop-viewer提升你的开发调试效率吧提示更多高级功能和配置选项请参考项目文档和 ARCHITECTURE.md 文件了解内部架构。【免费下载链接】otel-desktop-viewerotel-desktop-viewer is a CLI tool for receiving OpenTelemetry traces while working on your local machine.项目地址: https://gitcode.com/gh_mirrors/ot/otel-desktop-viewer创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考