feat: modularized rules

Co-authored-by: 牧思 <[email protected]>

Author: 123liuziming

.github/workflows/go.yml

@@ -34,7 +34,7 @@ jobs:
     - name: Build
       run: make build
     - name: InstUt
-      run: go test -v ./pkg/... -coverprofile=coverage.txt -covermode=atomic
+      run: go test -v $(go list ./...|grep pkg/ |grep -v rules) -coverprofile=coverage.txt -covermode=atomic
     - name: Coverage
       run: bash <(curl -s https://codecov.io/bash)
     - name: Test

.gitignore

@@ -7,6 +7,7 @@ otelbuild-*
 .otel-build
 vendor
 test/errors-test/errors-test
+test/errorstest/errorstest
 test/helloworld/helloworld
 test/httpclient/httpclient
 test/flags/flags
@@ -19,4 +20,5 @@ otel_rules
 otel_pkgdep
 opentelemetry-go-auto-instrumentation
 *_cache
-example/demo/demo
+example/demo/demo
+test/zap/test_zap

Makefile

@@ -32,7 +32,7 @@ XVERSION := -X=$(MOD_NAME)/tool/shared.TheVersion=$(VERSION)
 XNAME := -X=$(MOD_NAME)/tool/shared.TheName=$(TOOL_REL_NAME)
 STRIP_DEBUG := -s -w
 LDFLAGS := $(XVERSION) $(XNAME) $(STRIP_DEBUG)
-BUILD_CMD = CGO_ENABLED=0 GOOS=$(1) GOARCH=$(2) go build -a -ldflags="$(LDFLAGS)" -o $(3)
+BUILD_CMD = CGO_ENABLED=0 GOOS=$(1) GOARCH=$(2) go build -ldflags="$(LDFLAGS)" -o $(3)
 
 OUTPUT_BASE = $(TOOL_REL_NAME)
 OUTPUT_DARWIN_AMD64 = $(OUTPUT_BASE)-darwin-amd64

README.md

@@ -12,20 +12,20 @@ time. Simply replace `go build` with `otelbuild` to get started.
 
 # Installation
 
-#### Install via Bash 
+### Install via Bash
 For **Linux and MacOS** users, install the tool by running the following command :rocket:
 ```bash
-$ sudo curl -fsSL https://raw.githubusercontent.com/alibaba/opentelemetry-go-auto-instrumentation/main/install.sh | sudo 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/otelbuild` by default.
 
-#### Precompiled Binary
+### 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
+### Build From Source
 
 Checkout the source code and build the tool by running the following command:
 
@@ -52,25 +52,26 @@ $ ./otelbuild -- -gcflags="-m" cmd/app
 The arguments for the tool itself should be placed before the `--` delimiter:
 
 ```bash
-$ ./otelbuild -help        # print help doc
-$ ./otelbuild -debuglog    # print log to file
+$ ./otelbuild -help                             # print help doc
+$ ./otelbuild -debug                            # enable debug mode
 $ ./otelbuild -verbose -- -gcflags="-m" cmd/app # print verbose log
+$ ./otelbuild -rule=custom.json                 # use custom rule
 ```
 
 You can also explore [**these examples**](./example/) to get hands-on experience.
 
-Also there are several [**documents**](./docs) that you may find useful
+Also there are several [**documents**](./docs) that you may find useful for either understanding the project or contributing to it.
 
 > [!NOTE]
-> If you find any compilation failures during the process, it's likely a bug.
+> 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.
 
 # 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               |
 | fasthttp     | https://github.com/valyala/fasthttp        | v1.45.0               | v1.55.0               |
@@ -90,8 +91,13 @@ Also there are several [**documents**](./docs) that you may find useful
 
 We are progressively open-sourcing the libraries we have supported, and your contributions are very welcome 💖!
 
-Please refer to [this document](./docs/how-to-add-a-new-rule.md) for guidance on how to write instrumentation
-code for new frameworks.
+> [!TIP]
+> The framework you expected is not in the support list? Don't worry, we support extensible custom rules.
+> You can easily write code to inject into
+> any frameworks/libraries that are not officially supported.
+>
+> Please refer to [this document](./docs/how-to-add-a-new-rule.md) for guidance on how to write instrumentation
+> code for new frameworks.
 
 # Community
 

api/ruledef.go

@@ -111,7 +111,7 @@ The `clientOnEnter` function performs the actual monitoring tasks:
 
 ```go
 // == otel_rule_http59729.go
-func clientOnEnter(call *http.CallContext, t *http.Transport, req *http.Request) {
+func clientOnEnter(call api.CallContext, t *http.Transport, req *http.Request) {
     ...
     var tracer trace.Tracer
     if span := trace.SpanFromContext(req.Context()); span.SpanContext().IsValid() {