feat: add SkyWalking support in the Helm chart (#248)

Author: LinuxSuRen

CONTRIBUTION.md

@@ -34,9 +34,10 @@ docker run -p 8080:8080 -e SW_OAP_ADDRESS=http://localhost:12800 -e SW_ZIPKIN_AD
 make build
 
 export SW_AGENT_NAME=atest
-export SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE=10.121.218.184:31065
+export SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE=172.11.0.6:32591
 export SW_AGENT_PLUGIN_CONFIG_HTTP_SERVER_COLLECT_PARAMETERS=true
 export SW_AGENT_METER_COLLECT_INTERVAL=3
 export SW_AGENT_LOG_TYPE=std
+export SW_AGENT_REPORTER_DISCARD=true
 ./bin/atest server --local-storage 'bin/*.yaml' --http-port 8082 --port 7072 --console-path console/atest-ui/dist/
 ```

Dockerfile

@@ -5,20 +5,21 @@ COPY console/atest-ui .
 RUN npm install --ignore-scripts --registry=https://registry.npmmirror.com
 RUN npm run build-only
 
-FROM docker.io/apache/skywalking-go:0.2.0-go1.18 AS sk
+# FROM docker.io/apache/skywalking-go:0.4.0-go1.19 AS sk
+# use above tag once https://github.com/apache/skywalking-go/pull/134 got released
+FROM ghcr.io/apache/skywalking-go/skywalking-go:74b68861aed04b4d78fcc5b4bcd925113f7de81d-go1.19 AS sk
 
 FROM docker.io/golang:1.19 AS builder
 
 ARG VERSION
 ARG GOPROXY
-# it could be -toolexec="skywalking-go-agent"
-ARG TOOLEXEC
 WORKDIR /workspace
 COPY cmd/ cmd/
 COPY pkg/ pkg/
 COPY extensions/ extensions/
 COPY operator/ operator/
 COPY .github/testing/*.yaml sample/
+COPY .github/ .github/
 COPY sample/ sample/
 COPY docs/ docs/
 COPY go.mod go.mod
@@ -36,11 +37,11 @@ COPY --from=ui /workspace/dist/assets/*.css cmd/data/index.css
 COPY --from=sk /usr/local/bin/skywalking-go-agent /usr/local/bin/skywalking-go-agent
 
 RUN GOPROXY=${GOPROXY} go mod download
-RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build ${TOOLEXEC} -a -ldflags "-w -s -X github.com/linuxsuren/api-testing/pkg/version.version=${VERSION}" -o atest .
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -toolexec="skywalking-go-agent" -a -ldflags "-w -s -X github.com/linuxsuren/api-testing/pkg/version.version=${VERSION}" -o atest .
 RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-collector extensions/collector/main.go
 RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-orm extensions/store-orm/main.go
 RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-s3 extensions/store-s3/main.go
-RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-git extensions/store-git/main.go
+RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -toolexec="skywalking-go-agent" -a -ldflags "-w -s" -o atest-store-git extensions/store-git/main.go
 
 FROM docker.io/library/ubuntu:23.04
 
@@ -67,6 +68,7 @@ COPY --from=builder /workspace/sample /var/www/sample
 
 RUN apt update -y && \
     # required for atest-store-git
-    apt install -y --no-install-recommends ssh-client ca-certificates
+    apt install -y --no-install-recommends ssh-client ca-certificates && \
+    apt install -y curl
 
 CMD ["atest", "server", "--local-storage=/var/www/sample/*.yaml"]

Makefile

@@ -4,6 +4,7 @@ TOOLEXEC?=-toolexec="skywalking-go-agent"
 GOPROXY?=https://goproxy.cn,direct
 HELM_VERSION?=v0.0.2
 APP_VERSION?=v0.0.13
+HELM_REPORT?=docker.io/linuxsuren
 
 build:
 	mkdir -p bin
@@ -51,7 +52,7 @@ copy-restart: build-embed-ui
 helm-package:
 	helm package helm/api-testing --version ${HELM_VERSION}-helm --app-version ${APP_VERSION} -d bin
 helm-push:
-	helm push bin/api-testing-${HELM_VERSION}-helm.tgz oci://docker.io/linuxsuren
+	helm push bin/api-testing-${HELM_VERSION}-helm.tgz oci://${HELM_REPO}
 helm-lint:
 	helm lint helm/api-testing
 

docs/README.md

@@ -146,6 +146,10 @@ Please add the following flag if you want to get the browser tracing data:
 
 ```shell
 # 12800 is the HTTP port of Apache SkyWalking
+# 11800 is the gRPC port of Apache SkyWalking
+export SW_AGENT_REPORTER_GRPC_BACKEND_SERVICE=localhost:11800
+export SW_AGENT_REPORTER_DISCARD=false
+
 atest server --skywalking http://localhost:12800
 ```
 

docs/helm.md

@@ -14,3 +14,13 @@ helm upgrade atest oci://docker.io/surenpi/api-testing \
     --set image.tag=master \
     --set replicaCount=3
 ```
+
+## SkyWalking
+
+```shell
+helm install atest oci://docker.io/linuxsuren/api-testing \
+    --version v0.0.1-helm \
+    --set skywalking.endpoint.http=http://skywalking-skywalking-helm-oap.skywalking.svc:12800
+    --set skywalking.endpoint.grpc=skywalking-skywalking-helm-oap.skywalking.svc:11800
+    --set service.type=NodePort
+```

extensions/store-git/go.mod

@@ -10,6 +10,13 @@ require (
 	google.golang.org/grpc v1.57.0
 )
 
+require (
+	github.com/cncf/xds/go v0.0.0-20230607035331-e9ce68804cb4 // indirect
+	github.com/envoyproxy/protoc-gen-validate v0.10.1 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
+	skywalking.apache.org/repo/goapi v0.0.0-20230314034821-0c5a44bb767a // indirect
+)
+
 require (
 	dario.cat/mergo v1.0.0 // indirect
 	github.com/Masterminds/goutils v1.1.1 // indirect
@@ -20,6 +27,7 @@ require (
 	github.com/acomagu/bufpipe v1.0.4 // indirect
 	github.com/andreyvit/diff v0.0.0-20170406064948-c7f18ee00883 // indirect
 	github.com/antonmedv/expr v1.15.0 // indirect
+	github.com/apache/skywalking-go v0.3.1-0.20231024132233-74b68861aed0
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/bufbuild/protocompile v0.6.0 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
@@ -66,12 +74,12 @@ require (
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
 	github.com/xeipuuv/gojsonschema v1.2.0 // indirect
 	golang.org/x/crypto v0.14.0 // indirect
-	golang.org/x/mod v0.8.0 // indirect
+	golang.org/x/mod v0.9.0 // indirect
 	golang.org/x/net v0.17.0 // indirect
 	golang.org/x/sync v0.3.0 // indirect
 	golang.org/x/sys v0.13.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
-	golang.org/x/tools v0.6.0 // indirect
+	golang.org/x/tools v0.7.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20230530153820-e85fd2cbaebc // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20230530153820-e85fd2cbaebc // indirect
 	google.golang.org/protobuf v1.31.0 // indirect