Orchestrion 项目使用教程

Orchestrion 项目使用教程

1. 项目介绍

Orchestrion 是一个用于 Go 语言的自动编译时插桩工具，旨在为 Go 代码自动插入监控和追踪代码。通过 Orchestrion，开发者可以在编译时自动为代码添加 Datadog APM 追踪和 Datadog 应用安全管理（ASM）支持。Orchestrion 目前处于积极开发阶段，支持的功能正在快速增长，用户体验可能会随着未来版本的变化而演变。

主要功能

• 自动插桩：在编译时自动为 Go 代码插入监控和追踪代码。
• Datadog APM 支持：生成 Datadog APM 追踪。
• Datadog ASM 支持：支持 Datadog 应用安全管理。

项目地址

• GitHub: DataDog/orchestrion

2. 项目快速启动

安装 Orchestrion

首先，确保你已经安装了 Go 语言环境。然后，通过以下命令安装 Orchestrion：

go install github.com/datadog/orchestrion@latest

项目依赖注册

为了确保 Orchestrion 被正确添加到你的项目依赖中，可以运行以下命令：

orchestrion pin

该命令会自动生成一个 orchestrion.tool.go 文件，并更新 go.mod 文件以包含 Orchestrion 的依赖。

使用 Orchestrion 编译和测试

在编译和测试你的 Go 项目时，使用 Orchestrion 提供的命令前缀：

orchestrion go build
orchestrion go test -race

手动配置 -toolexec

如果你不想使用 orchestrion go 命令，也可以手动配置 -toolexec 参数：

go build -toolexec 'orchestrion toolexec'
go test -toolexec 'orchestrion toolexec' -race

3. 应用案例和最佳实践

应用案例

Orchestrion 主要用于需要高可观测性和安全性的 Go 项目。例如，在一个微服务架构中，通过 Orchestrion 可以自动为每个服务插入追踪代码，从而实现全链路追踪和监控。

最佳实践

• 版本管理：通过 go.mod 文件管理 Orchestrion 的版本，确保项目依赖的稳定性。
• 自动化集成：在 CI/CD 流程中集成 Orchestrion，确保每次构建都包含最新的监控和追踪代码。
• 日志与追踪结合：结合 Datadog 的日志和追踪功能，实现更全面的监控和故障排查。

4. 典型生态项目

Datadog APM

Datadog APM 是 Datadog 提供的应用性能监控服务，Orchestrion 生成的追踪数据可以直接与 Datadog APM 集成，提供详细的性能分析和监控。

Datadog ASM

Datadog 应用安全管理（ASM）是 Datadog 提供的安全监控服务，Orchestrion 支持自动插入安全监控代码，帮助开发者及时发现和应对安全威胁。

Go 语言生态

Orchestrion 支持多种 Go 语言生态中的库，如 database/sql、github.com/gin-gonic/gin、github.com/go-chi/chi 等，通过自动插桩，可以为这些库提供全面的监控和追踪支持。

通过以上步骤，你可以快速上手并使用 Orchestrion 为你的 Go 项目添加自动监控和追踪功能。