OpenTelemetry Go Auto Instrumentation

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. Simply replace go build with otelbuild to get started.

Installation

Install via Bash

For Linux and MacOS users, install the tool by running the following command 🚀

$ sudo curl -fsSL https://raw.githubusercontent.com/alibaba/opentelemetry-go-auto-instrumentation/main/install.sh | sudo bash

It will be installed in /usr/local/bin/otelbuild by default.

Precompiled Binary

Please download the latest precompiled release version from the Release page.

Build From Source

Checkout the source code and build the tool by running the following command:

$ make build

Getting Started

Replace go build with the following command to build your project:

# go build
$ ./otelbuild

The arguments for go build should be placed after the -- delimiter:

# go build -gcflags="-m" cmd/app
$ ./otelbuild -- -gcflags="-m" cmd/app

The 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 log

You can also explore these examples to get hands-on experience.

Also there are several documents that you may find useful

[!NOTE] If 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.

Supported Libraries

We are progressively open-sourcing the libraries we have supported, and your contributions are very welcome 💖!

Please refer to this document for guidance on how to write instrumentation code for new frameworks.

Community

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