https://github.com/alibaba/opentelemetry-go-auto-instrumentation
OpenTelemetry Compile-Time Instrumentation for Golang
https://github.com/alibaba/opentelemetry-go-auto-instrumentation
apm go instrumentation metrics observability opentelemetry tracing
Last synced: about 16 hours ago
JSON representation
OpenTelemetry Compile-Time Instrumentation for Golang
- Host: GitHub
- URL: https://github.com/alibaba/opentelemetry-go-auto-instrumentation
- Owner: alibaba
- License: apache-2.0
- Created: 2024-02-02T09:29:44.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-15T03:40:05.000Z (about 16 hours ago)
- Last Synced: 2025-04-15T03:43:37.669Z (about 16 hours ago)
- Topics: apm, go, instrumentation, metrics, observability, opentelemetry, tracing
- Language: Go
- Homepage: https://observability.cn/project/opentelemetry-go-auto-instrumentation/gnofcamfkr8otli8/#_top
- Size: 17.1 MB
- Stars: 540
- Watchers: 10
- Forks: 60
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: docs/supported-libraries.md
Awesome Lists containing this project
- trackawesomelist - Alibaba/opentelemetry-go-auto-instrumentation (⭐470) - A tool to monitor fiber application without changing any code with OpenTelemetry APIs. (Recently Updated / [Feb 22, 2025](/content/2025/02/22/README.md))
- awesome-fiber - Alibaba/opentelemetry-go-auto-instrumentation - A tool to monitor fiber application without changing any code with OpenTelemetry APIs. (🛠️ Tools / 🌱 Third Party)
README
[](./README.md)
[](./docs/README_CN.md)
[](https://codecov.io/gh/alibaba/opentelemetry-go-auto-instrumentation)
[](https://help.aliyun.com/zh/arms/application-monitoring/getting-started/monitoring-the-golang-applications)
[](https://github.com/alibaba/opentelemetry-go-auto-instrumentation/issues/225)
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, the instrumentation is done at compile
time. Simply adding `otel` prefix to `go build` to get started :rocket:
# Installation
### Install via Bash
For Linux and MacOS users, install the tool by running the following command
```bash
$ sudo curl -fsSL https://cdn.jsdelivr.net/gh/alibaba/opentelemetry-go-auto-instrumentation@main/install.sh | sudo bash
```
It will be installed in `/usr/local/bin/otel` by default.
### Precompiled Binary
Please download the latest precompiled release version from
the [Release](https://github.com/alibaba/opentelemetry-go-auto-instrumentation/releases)
page.
### Build From Source
Checkout source code and build the tool by running one of following commands:
```bash
$ make # build only
$ make install # build and install
```
# Getting Started
Check the version by running:
```bash
$ otel version
```
The configuration for the tool can be set by the following command:
```bash
$ otel set -verbose # print verbose logs
$ otel set -debug # enable debug mode
$ otel set -rule=custom.json # use default and custom rules
$ otel set -debug -verbose -rule=custom.json # set multiple configs
```
**Normally, you don't need to set any configurations. Just adding `otel` prefix to `go build` to build your project:**
```bash
$ 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. :telescope:
The detailed usage of `otel` tool can be found in [**Usage**](./docs/usage.md).
> [!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](https://github.com/alibaba/opentelemetry-go-auto-instrumentation/issues)
> to help us enhance this project.
# Examples
You can also explore [**these examples**](./example/) to get hands-on experience. They are designed to construct a full picture of how to use the tool in different scenarios.
Also there are several [**documents**](./docs) that you may find useful for either understanding the project or contributing to it.
# Supported Libraries
| Plugin Name | Repository Url | Min Supported Version | Max Supported Version |
|---------------| ---------------------------------------------- |-----------------------|-----------------------|
| database/sql | https://pkg.go.dev/database/sql | - | - |
| echo | https://github.com/labstack/echo | v4.0.0 | v4.12.0 |
| elasticsearch | https://github.com/elastic/go-elasticsearch | v8.4.0 | v8.15.0 |
| fasthttp | https://github.com/valyala/fasthttp | v1.45.0 | v1.59.0 |
| fiber | https://github.com/gofiber/fiber | v2.43.0 | v2.52.6 |
| 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 | v1.71.0 |
| hertz | https://github.com/cloudwego/hertz | v0.8.0 | v0.9.2 |
| iris | https://github.com/kataras/iris | v12.2.0 | v12.2.11 |
| 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 | - | - |
| redigo | https://github.com/gomodule/redigo | v1.9.0 | v1.9.2 |
| 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 |
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](./docs/how-to-add-a-new-rule.md) to get started.
# Community
We are looking forward to your feedback and suggestions. You can join
our [DingTalk group](https://qr.dingtalk.com/action/joingroup?code=v1,k1,GyDX5fUTYnJ0En8MrVbHBYTGUcPXJ/NdsmLODGibd0w=&_dt_no_comment=1&origin=11? )
to engage with us.
We would thankfully acknowledge the following contributors for their valuable contributions to this project:
The star history of this project is as follows, which shows the growth of this project over time:
