[WIP]refactor: Log component refactoring 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.21"
 
       - name: Golangci Lint
         # https://golangci-lint.run/

.github/workflows/tests.yml

@@ -4,29 +4,16 @@ 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:

go.mod

@@ -0,0 +1,5 @@
+module github.com/cloudwego-contrib/cwgo-pkg
+
+go 1.21
+
+// replace github.com/apache/thrift => github.com/apache/thrift v0.13.0

go.work

@@ -0,0 +1,13 @@
+go 1.21
+
+use (
+	.
+	./log/logging/logrus
+	./log/logging/slog
+	./log/logging/zap
+	./log/logging/zerolog
+	./telemetry/instrumentation/otellogrus
+	./telemetry/instrumentation/otelslog
+	./telemetry/instrumentation/otelzap
+	./telemetry/instrumentation/otelzerolog
+)

hack/resolve-modules.sh

@@ -0,0 +1,22 @@
+#!/usr/bin/env bash
+
+# This is used by the linter action.
+# Recursively finds all directories with a go.mod file and creates
+# a GitHub Actions JSON output option.
+
+set -o errexit
+
+HOME=$(
+	cd "$(dirname "${BASH_SOURCE[0]}")" &&
+		cd .. &&
+		pwd
+)
+
+source "${HOME}/hack/util.sh"
+all_modules=$(util::find_modules)
+PATHS=""
+for mod in $all_modules; do
+		PATHS+=$(printf '{"workdir":"%s"},' ${mod})
+done
+
+echo "::set-output name=matrix::{\"include\":[${PATHS%?}]}"

hack/tools.sh

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+HOME=$(
+	cd "$(dirname "${BASH_SOURCE[0]}")" &&
+		cd .. &&
+		pwd
+)
+
+source "${HOME}/hack/util.sh"
+
+all_modules=$(util::find_modules)
+
+# test all mod
+function test() {
+	for mod in $all_modules; do
+			pushd "$mod" >/dev/null &&
+				echo "go test $(sed -n 1p go.mod | cut -d ' ' -f2)" &&
+				go test -race -covermode=atomic -coverprofile=coverage.out ./...
+			popd >/dev/null || exit
+	done
+}
+
+# vet all mod
+function vet() {
+	for mod in $all_modules; do
+			pushd "$mod" >/dev/null &&
+				echo "go vet $(sed -n 1p go.mod | cut -d ' ' -f2)" &&
+				go vet -stdmethods=false ./...
+			popd >/dev/null || exit
+	done
+}
+
+function help() {
+	echo "use: test,vet"
+}
+
+case $1 in
+vet)
+	vet
+	;;
+test)
+	test
+	;;
+*)
+	help
+	;;
+esac

hack/util.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# find all go mod path
+# returns an array contains mod path
+function util::find_modules() {
+	find . -mindepth 2 -not \( \
+		\( \
+		-path './output' \
+		-o -path './.git' \
+		-o -path '*/third_party/*' \
+		-o -path '*/vendor/*' \
+		\) -prune \
+		\) -name 'go.mod' -print0 | xargs -0 -I {} dirname {}
+}

log/logging/cwfield.go

@@ -0,0 +1,22 @@
+/*
+ * 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 logging
+
+type CwField struct {
+	Key   string
+	Value any
+}