Zero‑Intrusion Go Auto‑Instrumentation: Monitor and Govern Services Without Code Changes

Background

Although Go is renowned for its performance and efficient coding, developers still face significant cost and technical challenges when implementing application monitoring and service governance. Traditional solutions often require manual source code modifications, increasing workload and impacting existing architectures, especially in complex heterogeneous systems.

Zero‑Intrusive Auto‑Instrumentation

Alibaba Cloud ARMS, the compiler team, and the MSE team jointly released an open‑source compile‑time automatic instrumentation solution for Go. By simply replacing the go build command with a custom build command, developers can achieve full monitoring and governance of Go applications without any code changes.

Modular Extension Principle

The open‑source version supports 16 mainstream frameworks (38 in the commercial version). For frameworks not on the list or for advanced custom needs, a modular instrumentation extension allows zero‑intrusive injection of custom code into any target function via a simple JSON configuration.

Preprocess

During preprocessing, the tool reads a user‑defined rule.json file that specifies which functions in which libraries should receive custom hooks. Example configuration:

[{ "ImportPath": "google.golang.org/grpc", "Function": "NewClient", "OnEnter": "grpcNewClientOnEnter", "OnExit": "grpcNewClientOnExit", "Path": "/path/to/my/code" }]

The tool analyzes third‑party dependencies, matches them against the rules, and prepares any additional dependencies required.

Code Injection

Before each package’s compilation, the tool inserts a trampoline code segment that forwards execution to the user‑defined hooks (e.g., grpcNewClientOnEnter and grpcNewClientOnExit). The trampoline is optimized at the AST level to minimize overhead.

Usage Examples

1. Record HTTP Request Headers

Create a hook module, add hook.go with entry and exit hooks that log request and response headers, and configure rule.json to target net/http::(*Transport).RoundTrip. Build with otelbuild -rule=conf.json -- main.go to see the injected logs.

2. Replace Standard Library Sort Algorithm

Inject a custom dual‑pivot quicksort by targeting sort.Ints. The hook sets call.SetSkipCall(true) to bypass the original sort and executes the new algorithm.

3. Prevent SQL Injection

Inject a hook into database/sql::(*DB).Query that checks the query string for common injection patterns and aborts execution if a risk is detected.

4. Add Traffic Protection to gRPC Requests

Inject a middleware into the gRPC client creation process ( google.golang.org/grpc::NewClient) that registers a Sentinel‑based unary interceptor for outbound traffic control.

Summary and Outlook

The compile‑time automatic instrumentation for Go eliminates the tedious manual instrumentation required in microservice monitoring and has been commercialized on Alibaba Cloud. While originally designed for non‑intrusive monitoring, its applications now span service governance, code auditing, security, debugging, and more. The project is being open‑sourced and contributed to the OpenTelemetry community, inviting further collaboration and innovation.