5分钟上手otel-cli:从安装到生成第一个分布式追踪的快速教程
5分钟上手otel-cli从安装到生成第一个分布式追踪的快速教程【免费下载链接】otel-cliOpenTelemetry command-line tool for sending events from shell scripts similar environments项目地址: https://gitcode.com/gh_mirrors/ot/otel-cliotel-cli 是一款用于发送 OpenTelemetry 追踪数据的命令行工具专为 shell 脚本及类似环境设计能帮助开发者轻松实现分布式追踪。通过简单的命令你可以快速生成和发送追踪数据监控系统运行状态。一、快速安装otel-cli的3种方法1. 使用Go直接安装推荐如果你已安装Go环境只需一行命令即可完成安装go install github.com/equinix-labs/otel-clilatest安装完成后确保GOPATH已添加到系统PATH即可直接使用otel-cli命令。2. 通过Homebrew安装macOS用户macOS用户可通过Homebrew快速安装brew install otel-cli3. 源码编译安装如果你需要最新开发版本可克隆仓库后手动编译git clone https://gitcode.com/gh_mirrors/ot/otel-cli cd otel-cli go build -o otel-cli main.go编译后的可执行文件位于当前目录可将其移动到/usr/local/bin方便全局使用。二、生成第一个追踪数据的3个简单步骤1. 启动本地OTLP服务器可选为了方便查看追踪数据可先启动本地OTLP服务器otel-cli server json --dir ./traces --timeout 60 --max-spans 5服务器会将接收到的追踪数据保存到./traces目录便于后续查看。2. 创建基础追踪Span使用以下命令创建一个简单的追踪Spanotel-cli span -n my-first-span -s hello otel-cli-n指定Span名称-s添加Span描述信息3. 查看生成的追踪数据如果使用了本地服务器可在./traces目录下找到JSON格式的追踪数据文件。你也可以安装可视化工具查看go install github.com/CtrlSpice/otel-desktop-viewerlatest otel-desktop-viewer三、进阶使用创建嵌套追踪和背景Span1. 生成嵌套Spanotel-cli支持通过环境变量传递追踪上下文创建嵌套Span# 生成父Span并导出追踪上下文 carrier$(mktemp) otel-cli span -n parent-span --tp-print --tp-carrier $carrier # 在子进程中创建子Span source $carrier otel-cli span -n child-span --tp-required2. 后台运行Span对于长时间运行的任务可使用后台Span模式# 启动后台Span sockdir$(mktemp -d) otel-cli span background -n background-task --sockdir $sockdir # 向后台Span添加事件 otel-cli span event --name task-progress --attrs statusrunning --sockdir $sockdir # 结束后台Span otel-cli span end --sockdir $sockdir四、配置与环境变量otel-cli支持通过命令行参数或环境变量进行配置常用配置项包括参数环境变量描述默认值--traces-endpointOTEL_EXPORTER_OTLP_TRACES_ENDPOINT追踪数据接收端点https://localhost:4318/v1/traces--kindOTEL_CLI_TRACE_KINDSpan类型server--attrsOTEL_CLI_ATTRIBUTES自定义属性kv,ab例如指定自定义追踪端点otel-cli span -n custom-endpoint --traces-endpoint http://my-collector:4318/v1/traces五、实际应用示例1. 追踪Shell脚本执行在部署脚本中添加追踪监控各步骤执行情况#!/bin/bash start$(date %s) otel-cli span -n deploy-script --start $start --attrs envproduction,appmy-service # 执行部署步骤 ./deploy.sh end$(date %s) otel-cli span -n deploy-script --end $end --status-code $?2. 追踪构建过程通过demo脚本追踪完整构建流程./demos/30-trace-build-process/otel-wrapper-shim.sh六、总结通过otel-cli你可以在5分钟内快速实现分布式追踪功能无论是简单的脚本监控还是复杂的系统追踪都能轻松应对。开始使用otel-cli让你的系统可观测性提升到新高度更多使用示例和详细说明请参考项目中的demo脚本如demos/01-simple-span.sh、demos/15span-background-layered.sh和源码文件如otelcli/span.go。【免费下载链接】otel-cliOpenTelemetry command-line tool for sending events from shell scripts similar environments项目地址: https://gitcode.com/gh_mirrors/ot/otel-cli创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考