This project provides compile-time instrumentation for Golang applications to enable OpenTelemetry observability without requiring code modifications. It targets Golang developers seeking to integrate tracing and metrics into their applications efficiently.

How It Works

The agent works by intercepting the go build command. It automatically injects OpenTelemetry instrumentation code into the Go source files during the compilation process. This approach avoids runtime overhead and complexity associated with dynamic instrumentation, ensuring seamless integration.

Quick Start & Requirements

• Installation: Download prebuilt binaries or use curl -fsSL https://cdn.jsdelivr.net/gh/alibaba/loongsuite-go-agent/install.sh | sudo bash for Linux/macOS. Build from source with make.
• Usage: Prefix your go build command with otel, e.g., otel go build.
• Prerequisites: Go toolchain.

Highlighted Details

• Supports automatic instrumentation for a wide range of popular Go libraries including net/http, grpc, gin, zap, gorm, and more.
• Provides examples for tracing, metrics, logging integration (zap), and security-focused code injection.
• Includes a benchmark suite to evaluate performance overhead.
• Offers guidance for instrumenting unsupported frameworks.

Maintenance & Community

The project welcomes contributions and feedback. A DingTalk group is available for community engagement.

Licensing & Compatibility

The repository does not explicitly state a license. Compatibility for commercial use or closed-source linking is not specified.

Limitations & Caveats

The project is actively open-sourcing supported libraries, implying that some may not yet be included. Users are encouraged to file bug reports for compilation failures.