OpenTelemetry Bash 项目使用教程

1. 项目介绍

OpenTelemetry Bash 项目是一个开源项目，旨在为 shell 脚本提供 OpenTelemetry 的跟踪、度量和日志功能。OpenTelemetry 是一个可观察性框架，用于收集和导出应用程序的性能指标、跟踪和日志数据。这个项目支持多种 POSIX 兼容的 shell，包括 sh、ash、dash、bash、busybox 等，并且可以与 GitHub 工作流配合使用。

2. 项目快速启动

在开始之前，确保您的系统是基于 Debian 或 RPM 的 Linux 发行版，或者是在 Windows 的 Linux 子系统中运行。

安装

1. 将以下代码添加到您想要监控的任意脚本的开头：

   export OTEL_METRICS_EXPORTER=console
   export OTEL_LOGS_EXPORTER=console
   export OTEL_TRACES_EXPORTER=console
   . /path/to/otel.sh
   

   确保 /path/to/otel.sh 是 OpenTelemetry Bash 脚本的正确路径。

2. 运行您的脚本。您将看到跟踪、度量和日志信息被输出到标准错误输出中。

示例

以下是一个简单的脚本示例，它执行一个 HTTP 请求并打印跟踪信息：

#!/bin/bash

# 导入 OpenTelemetry 功能
. /path/to/otel.sh

# 执行 HTTP 请求
curl http://www.google.com

# 查看输出的跟踪信息

3. 应用案例和最佳实践

• 自动跟踪：项目支持自动跟踪所有可用的命令，无需手动创建跟踪跨度。
• 日志收集：自动从 stderr 和 GitHub Action 日志命令中收集日志。
• 安全性：自版本 3.43.0 起，项目生成构建工件证明，以建立构建的出处，增强对供应链攻击的防护。

最佳实践：

• 在生产环境中，将跟踪、度量和日志导出到适合的导出器，而不是输出到 console。
• 对于复杂的脚本，使用手动 API 创建定制的跟踪跨度以增强自动跟踪。

4. 典型生态项目

OpenTelemetry Bash 项目是与 OpenTelemetry 生态系统中其他项目一起使用的。以下是一些与该项目配合良好的生态项目：

• OpenTelemetry Java：用于 Java 应用程序的 OpenTelemetry 实现。
• OpenTelemetry Node.js：用于 Node.js 应用的 OpenTelemetry 实现。
• OpenTelemetry .NET：用于 .NET 应用的 OpenTelemetry 实现。

通过结合这些项目，您可以在多语言环境中实现一致的可观察性实践。