refactor: Organize the observability components of Cloudwego

.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,9 +27,9 @@ A clear and concise description of what you expected to happen.
 
 If applicable, add screenshots to help explain your problem.
 
-**Kitex version:**
+**Version:**
 
-Please provide the version of Kitex you are using.
+Please provide the version of {cwgo-pkg} you are using.
 
 **Environment:**
 

.github/workflows/pr-check.yml

@@ -4,26 +4,24 @@ on: [ pull_request ]
 
 jobs:
   compliant:
-    runs-on: [ self-hosted, X64 ]
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Check License Header
-        uses: apache/skywalking-eyes/header@main
+        uses: apache/skywalking-eyes/header@v0.4.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Check Spell
-        uses: crate-ci/typos@master
 
   staticcheck:
-    runs-on: [ self-hosted, X64 ]
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.19
+          go-version: "1.21"
 
       - uses: actions/cache@v3
         with:
@@ -45,13 +43,13 @@ jobs:
           staticcheck_flags: -checks=inherit,-SA1029
 
   lint:
-    runs-on: [ self-hosted, X64 ]
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.19
+          go-version: "1.22"
 
       - name: Golangci Lint
         # https://golangci-lint.run/

.github/workflows/tests.yml

@@ -4,29 +4,14 @@ on: [ push, pull_request ]
 
 jobs:
   unit-benchmark-test:
-    strategy:
-      matrix:
-        go: [ 1.17, 1.18, 1.19 ]
-        os: [ X64, ARM64 ]
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-
+      - uses: actions/checkout@v4
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: ${{ matrix.go }}
-
-       # block scenario, comment temporarily
-#      - uses: actions/cache@v3
-#        with:
-#          path: ~/go/pkg/mod
-#          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-#          restore-keys: |
-#            ${{ runner.os }}-go-
+          go-version: "1.21"
 
       - name: Unit Test
-        run: go test -race -covermode=atomic -coverprofile=coverage.out ./...
+        run: make test
 
-      - name: Benchmark
-        run: go test -bench=. -benchmem -run=none ./...

.golangci.yaml

@@ -2,14 +2,10 @@
 run:
   # include `vendor` `third_party` `testdata` `examples` `Godeps` `builtin`
   skip-dirs-use-default: true
-  skip-dirs:
-    - kitex_gen
-  skip-files:
-    - ".*\\.mock\\.go$"
 # output configuration options
 output:
   # Format: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
-  format: colored-line-number
+  formats: colored-line-number
 # All available settings of specific linters.
 # Refer to https://golangci-lint.run/usage/linters
 linters-settings:
@@ -25,12 +21,14 @@ linters-settings:
 linters:
   enable:
     - gofumpt
+    - goimports
     - gofmt
   disable:
     - errcheck
     - typecheck
-    - deadcode
-    - varcheck
     - staticcheck
 issues:
   exclude-use-default: true
+  exclude-files:
+    - ".*\\.mock\\.go$"
+  exclude-dirs:

.licenserc.yaml

@@ -3,8 +3,11 @@ header:
     spdx-id: Apache-2.0
     copyright-owner: CloudWeGo Authors
 
+
   paths:
     - '**/*.go'
     - '**/*.s'
+  paths-ignore:
+    - example/prom/promWithkitex/kitex_gen/**
 
   comment: on-failure

CONTRIBUTING.md

@@ -1,17 +1,17 @@
 # How to Contribute
 
 ## Your First Pull Request
-We use github for our codebase. You can start by reading [How To Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
+We use GitHub for our codebase. You can start by reading [How To Pull Request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
 
 ## Branch Organization
 We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) as our branch organization, as known as [FDD](https://en.wikipedia.org/wiki/Feature-driven_development)
 
 ## Bugs
 ### 1. How to Find Known Issues
-We are using [Github Issues](https://github.com/cloudwego/kitex/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
+We are using [Github Issues](https://github.com/cloudwego/{project_name}/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
 
 ### 2. Reporting New Issues
-Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
+Providing a reduced test code is a recommended way for reporting issues. Then can place in:
 - Just in issues
 - [Golang Playground](https://play.golang.org/)
 
@@ -23,9 +23,9 @@ Please do not report the safe disclosure of bugs to public issues. Contact us by
 
 ## Submit a Pull Request
 Before you submit your Pull Request (PR) consider the following guidelines:
-1. Search [GitHub](https://github.com/cloudwego/kitex/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
+1. Search [GitHub](https://github.com/cloudwego/{project_name}/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate existing efforts.
 2. Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design upfront helps to ensure that we're ready to accept your work.
-3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego/kitex repo.
+3. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the cloudwego {project_name} repo.
 4. In your forked repository, make your changes in a new git branch:
     ```
     git checkout -b my-fix-branch develop
@@ -38,18 +38,14 @@ Before you submit your Pull Request (PR) consider the following guidelines:
     ```
     git push origin my-fix-branch
     ```
-9. In GitHub, send a pull request to `kitex:develop`
+9. In GitHub, send a pull request to `{project_name}:develop`
 
 ## Contribution Prerequisites
 - Our development environment keeps up with [Go Official](https://golang.org/project/).
 - You need fully checking with lint tools before submit your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint)
-- You are familiar with [Github](https://github.com)
+- You are familiar with [GitHub](https://github.com)
 - Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
 
 ## Code Style Guides
-Also see [Pingcap General advice](https://pingcap.github.io/style-guide/general.html).
-
-Good resources:
 - [Effective Go](https://golang.org/doc/effective_go)
 - [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
-- [Uber Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md)

Makefile

@@ -0,0 +1,15 @@
+TOOLS_SHELL="./hack/tools.sh"
+
+.PHONY: test
+test:
+	chmod +x ${TOOLS_SHELL}
+	@${TOOLS_SHELL} test
+	@echo "go test finished"
+
+
+
+.PHONY: vet
+vet:
+	chmod +x ${TOOLS_SHELL}
+	@${TOOLS_SHELL} vet
+	@echo "vet check finished"

example/main.go

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2024 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package main
+
+func main() {
+}

example/otel/otelwithhertz/client/main.go

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2024 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package main
+
+import (
+	"context"
+	"time"
+
+	"github.com/cloudwego-contrib/cwgo-pkg/telemetry/instrumentation/otelhertz"
+	"github.com/cloudwego-contrib/cwgo-pkg/telemetry/provider/otelprovider"
+	"github.com/cloudwego/hertz/pkg/app/client"
+	"github.com/cloudwego/hertz/pkg/common/hlog"
+	hertzlogrus "github.com/hertz-contrib/obs-opentelemetry/logging/logrus"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/attribute"
+)
+
+func main() {
+	hlog.SetLogger(hertzlogrus.NewLogger())
+	hlog.SetLevel(hlog.LevelDebug)
+
+	serviceName := "demo-hertz-client"
+
+	p := otelprovider.NewOpenTelemetryProvider(
+		otelprovider.WithServiceName(serviceName),
+		// Support setting ExportEndpoint via environment variables: OTEL_EXPORTER_OTLP_ENDPOINT
+		otelprovider.WithExportEndpoint("localhost:4317"),
+		otelprovider.WithHttpServer(),
+		otelprovider.WithInsecure(),
+	)
+	defer p.Shutdown(context.Background())
+
+	c, _ := client.NewClient()
+	c.Use(otelhertz.ClientMiddleware())
+
+	for {
+		ctx, span := otel.Tracer("github.com/hertz-contrib/obs-opentelemetry").
+			Start(context.Background(), "loop")
+
+		_, b, err := c.Get(ctx, nil, "http://0.0.0.0:8888/ping?foo=bar")
+		if err != nil {
+			hlog.CtxErrorf(ctx, err.Error())
+		}
+
+		span.SetAttributes(attribute.String("msg", string(b)))
+
+		hlog.CtxInfof(ctx, "hertz client %s", string(b))
+		span.End()
+
+		<-time.After(time.Second)
+	}
+}

example/otel/otelwithhertz/go.mod

@@ -0,0 +1,15 @@
+module otelwithhertz
+
+go 1.21
+
+require (
+	github.com/cloudwego/hertz v0.9.3
+	github.com/hertz-contrib/obs-opentelemetry/logging/logrus v0.1.1
+)
+
+require (
+	github.com/sirupsen/logrus v1.8.1 // indirect
+	go.opentelemetry.io/otel v1.4.1 // indirect
+	go.opentelemetry.io/otel/trace v1.4.1 // indirect
+	golang.org/x/sys v0.24.0 // indirect
+)

example/otel/otelwithhertz/server/main.go

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2024 CloudWeGo Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package main
+
+import (
+	"context"
+	"exampleprom/promWithkitex/kitex_gen/api"
+
+	"github.com/cloudwego-contrib/cwgo-pkg/telemetry/instrumentation/otelhertz"
+	"github.com/cloudwego-contrib/cwgo-pkg/telemetry/provider/otelprovider"
+	"github.com/cloudwego/hertz/pkg/app"
+	"github.com/cloudwego/hertz/pkg/app/server"
+	"github.com/cloudwego/hertz/pkg/common/hlog"
+	"github.com/cloudwego/hertz/pkg/protocol/consts"
+	hertzlogrus "github.com/hertz-contrib/obs-opentelemetry/logging/logrus"
+)
+
+func main() {
+	hlog.SetLogger(hertzlogrus.NewLogger())
+	hlog.SetLevel(hlog.LevelDebug)
+
+	serviceName := "demo-hertz-server"
+	p := otelprovider.NewOpenTelemetryProvider(
+		otelprovider.WithServiceName(serviceName),
+		// Support setting ExportEndpoint via environment variables: OTEL_EXPORTER_OTLP_ENDPOINT
+		otelprovider.WithExportEndpoint("localhost:4317"),
+		otelprovider.WithHttpServer(),
+		otelprovider.WithInsecure(),
+	)
+	defer p.Shutdown(context.Background())
+
+	tracer, cfg := otelhertz.NewServerOption()
+	h := server.Default(tracer)
+	h.Use(otelhertz.ServerMiddleware(cfg))
+
+	h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
+		req := &api.Request{Message: "my request"}
+
+		hlog.CtxDebugf(c, "message received successfully: %s", req.Message)
+		ctx.JSON(consts.StatusOK, "resp")
+	})
+
+	h.Spin()
+}