This project 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, and the instrumentation is done at compile
time. The only thing you need to do is to replace go build with otelbuild.
Run the following command to build otelbuild:
$ make buildTo build all supported platforms for release purpose:
$ make allTo run all tests:
$ make testReplace go build with the following command to build you project:
# go build
$ ./otelbuildThe arguments for go build should be placed after the -- delimiter:
# go build -gcflags="-m" cmd/app
$ ./otelbuild -- -gcflags="-m" cmd/appThe arguments for the tool itself should be placed before the -- delimiter:
$ ./otelbuild -help # print help doc
$ ./otelbuild -debuglog # print log to file
$ ./otelbuild -verbose -- -gcflags="-m" cmd/app # print verbose logIf you find any compilation failures during the process, it's likely a bug. Please feel free to file a bug at GitHub Issues to help us enhance this project.
Lastly, we've provided some examples in example direcory, you can try the project through those examples.
| Plugin Name | Repository Url | Min Supported Version | Max Supported Version |
|---|---|---|---|
| net/http | https://pkg.go.dev/net/http | - | - |
| database/sql | https://pkg.go.dev/database/sql | - | - |
| go-redis | https://github.com/redis/go-redis | v9.0.5 | v9.5.1 |
| mongodb | https://github.com/mongodb/mongo-go-driver | v1.11.1 | v1.15.2 |
We are gradually open-sourcing the libraries we have supported, and your contributions are very welcome.
We are looking forward to your feedback and suggestions. Please feel free to join our DingTalk group to communicate with us.
Also there are several documents that you may find useful: