Loongsuite Go Agent provides an automatic solution for Golang applications that want to leverage OpenTelemetry to enable effective observability. No code changes are required in the target application, the instrumentation is done at compile time. Simply adding otel prefix to go build to get started 🚀

Installation

Prebuilt Binaries

• 
• 
• 
• 
• 

This is the recommended way to install the tool.

Install via Bash

For Linux and MacOS users, the following script will install otel in /usr/local/bin/otel by default:

$ sudo curl -fsSL https://cdn.jsdelivr.net/gh/alibaba/loongsuite-go-agent@main/install.sh | sudo bash

Build from Source

$ make         # build only
$ make install # build and install

Getting Started

Make sure the tool is installed:

$ # You may use "otel-linux-amd64" instead of "otel"
$ otel version

Just adding otel prefix to go build to build your project:

$ otel go build
$ otel go build -o app cmd/app
$ otel go build -gcflags="-m" cmd/app

That's the whole process! The tool will automatically instrument your code with OpenTelemetry, and you can start to observe your application. 🔭

The detailed usage of otel tool can be found in Usage.

NOTE

If you find any compilation failures while go build works, it's likely a bug. Please feel free to file a bug at GitHub Issues to help us enhance this project.

Examples

• demo - End-to-end example with OpenTelemetry tracing and metrics
• zap logging - Auto-instrumentation for github.com/uber-go/zap logging
• benchmark - Performance testing and overhead measurement
• sql injection - Custom code injection for SQL injection detection
• nethttp - HTTP monitoring with request/response instrumentation
• kratos-demo - Integration with the Kratos framework

Supported Libraries

List of Supported Libraries

Library	Repository Url	Min Version	Max Version
database/sql	https://pkg.go.dev/database/sql	-	-
dubbo-go	https://github.com/apache/dubbo-go	v3.3.0	-
echo	https://github.com/labstack/echo	v4.0.0	v4.12.0
eino	https://github.com/cloudwego/eino	v0.3.51	-
elasticsearch	https://github.com/elastic/go-elasticsearch	v8.4.0	v8.15.0
fasthttp	https://github.com/valyala/fasthttp	v1.45.0	v1.63.0
fiber	https://github.com/gofiber/fiber	v2.43.0	v2.52.8
gin	https://github.com/gin-gonic/gin	v1.7.0	v1.10.0
go-redis	https://github.com/redis/go-redis	v9.0.5	v9.5.1
go-redis v8	https://github.com/redis/go-redis	v8.11.0	v8.11.5
gomicro	https://github.com/micro/go-micro	v5.0.0	v5.3.0
gorestful	https://github.com/emicklei/go-restful	v3.7.0	v3.12.1
gorm	https://github.com/go-gorm/gorm	v1.22.0	v1.25.9
grpc	https://google.golang.org/grpc	v1.44.0	-
hertz	https://github.com/cloudwego/hertz	v0.8.0	-
iris	https://github.com/kataras/iris	v12.2.0	v12.2.11
client-go	https://github.com/kubernetes/client-go	v0.33.3	-
kitex	https://github.com/cloudwego/kitex	v0.5.1	v0.11.3
kratos	https://github.com/go-kratos/kratos	v2.6.3	v2.8.4
langchaingo	https://github.com/tmc/langchaingo	v0.1.13	v0.1.13
log	https://pkg.go.dev/log	-	-
logrus	https://github.com/sirupsen/logrus	v1.5.0	v1.9.3
mongodb	https://github.com/mongodb/mongo-go-driver	v1.11.1	v1.15.1
mux	https://github.com/gorilla/mux	v1.3.0	v1.8.1
nacos	https://github.com/nacos-group/nacos-sdk-go/v2	v2.0.0	v2.2.7
net/http	https://pkg.go.dev/net/http	-	-
ollama	https://github.com/ollama/ollama	v0.3.14	-
redigo	https://github.com/gomodule/redigo	v1.9.0	v1.9.2
sentinel	https://github.com/alibaba/sentinel-golang	v1.0.4	-
slog	https://pkg.go.dev/log/slog	-	-
trpc-go	https://github.com/trpc-group/trpc-go	v1.0.0	v1.0.3
zap	https://github.com/uber-go/zap	v1.20.0	v1.27.0
zerolog	https://github.com/rs/zerolog	v1.10.0	v1.33.0
go-kit/log	https://github.com/go-kit/log	v0.1.0	v0.2.1
pg	https://github.com/go-pg/pg	v1.10.0	v1.14.0
gocql	https://github.com/gocql/gocql	v1.3.0	v1.7.0
sqlx	https://github.com/jmoiron/sqlx	v1.3.0	v1.4.0

We are progressively open-sourcing the libraries we have supported, and your contributions are Very Welcome

IMPORTANT

The framework you expected is not in the list? Don't worry, you can easily inject your code into any frameworks/libraries that are not officially supported.

Please refer to this document to get started.

Community

We are looking forward to your feedback and suggestions. You can join our DingTalk group to engage with us.

DingTalk	Star History