otelttrpc: implement unary interceptors for opentelemetry instrumentation.

.github/workflows/ci.yml

@@ -36,17 +36,32 @@ jobs:
           go-version: ${{ env.GO_VERSION }}
 
       - name: golangci-lint
+        id: lint-main
         uses: golangci/golangci-lint-action@v3
         with:
           version: v1.51.2
           args: --timeout=5m
           skip-cache: true
           working-directory: src/github.com/containerd/ttrpc
 
+      - name: golangci-lint for otelttrpc
+        id: lint-otelttrpc
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.51.2
+          args: --timeout=5m
+          skip-cache: true
+          working-directory: src/github.com/containerd/ttrpc/otelttrpc
+
       - name: golangci-lint errors
         run: golangci-lint run
         working-directory: src/github.com/containerd/ttrpc
-        if: ${{ failure() }}
+        if: ${{ failure() && steps.lint-main.conclusion == 'failure' }}
+
+      - name: golangci-lint errors for otelttrpc
+        run: golangci-lint run
+        working-directory: src/github.com/containerd/ttrpc/otelttrpc
+        if: ${{ failure() && steps.lint-otelttrpc.conclusion == 'failure' }}
 
   #
   # Project checks

Makefile

@@ -12,169 +12,66 @@
 #   See the License for the specific language governing permissions and
 #   limitations under the License.
 
-
-# Go command to use for build
-GO ?= go
-INSTALL ?= install
-
 # Root directory of the project (absolute path).
-ROOTDIR=$(dir $(abspath $(lastword $(MAKEFILE_LIST))))
-
-WHALE = "🇩"
-ONI = "👹"
+export ROOTDIR = $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 
 # Project binaries.
-COMMANDS=protoc-gen-go-ttrpc protoc-gen-gogottrpc
-
-ifdef BUILDTAGS
-    GO_BUILDTAGS = ${BUILDTAGS}
-endif
-GO_BUILDTAGS ?=
-GO_TAGS=$(if $(GO_BUILDTAGS),-tags "$(strip $(GO_BUILDTAGS))",)
-
-# Project packages.
-PACKAGES=$(shell $(GO) list ${GO_TAGS} ./... | grep -v /example)
-TESTPACKAGES=$(shell $(GO) list ${GO_TAGS} ./... | grep -v /cmd | grep -v /integration | grep -v /example)
-BINPACKAGES=$(addprefix ./cmd/,$(COMMANDS))
-
-#Replaces ":" (*nix), ";" (windows) with newline for easy parsing
-GOPATHS=$(shell echo ${GOPATH} | tr ":" "\n" | tr ";" "\n")
-
-TESTFLAGS_RACE=
-GO_BUILD_FLAGS=
-# See Golang issue re: '-trimpath': https://github.com/golang/go/issues/13809
-GO_GCFLAGS=$(shell				\
-	set -- ${GOPATHS};			\
-	echo "-gcflags=-trimpath=$${1}/src";	\
-	)
-
-BINARIES=$(addprefix bin/,$(COMMANDS))
-
-# Flags passed to `go test`
-TESTFLAGS ?= $(TESTFLAGS_RACE) $(EXTRA_TESTFLAGS)
-TESTFLAGS_PARALLEL ?= 8
-
-# Use this to replace `go test` with, for instance, `gotestsum`
-GOTEST ?= $(GO) test
-
-.PHONY: clean all AUTHORS build binaries test integration generate protos check-protos coverage ci check help install vendor install-protobuf install-protobuild
-.DEFAULT: default
+COMMANDS = protoc-gen-go-ttrpc protoc-gen-gogottrpc
 
 # Forcibly set the default goal to all, in case an include above brought in a rule definition.
 .DEFAULT_GOAL := all
 
 all: binaries
 
-check: proto-fmt ## run all linters
-	@echo "$(WHALE) $@"
-	GOGC=75 golangci-lint run
+check: proto-fmt lint
+
+integration: ## run integration tests
+	$(Q)$(call WHALE_TARGET); \
+	cd "${ROOTDIR}/integration" && \
+	    $(GOTEST) -v ${TESTFLAGS} -parallel ${TESTFLAGS_PARALLEL} .
+
 
 ci: check binaries check-protos coverage # coverage-integration ## to be used by the CI
 
 AUTHORS: .mailmap .git/HEAD
 	git log --format='%aN <%aE>' | sort -fu > $@
 
-generate: protos
-	@echo "$(WHALE) $@"
-	@PATH="${ROOTDIR}/bin:${PATH}" $(GO) generate -x ${PACKAGES}
-
-protos: bin/protoc-gen-gogottrpc bin/protoc-gen-go-ttrpc ## generate protobuf
-	@echo "$(WHALE) $@"
-	@(PATH="${ROOTDIR}/bin:${PATH}" protobuild --quiet ${PACKAGES})
+protos: $(BINARIES) ## generate protobuf
 
 check-protos: protos ## check if protobufs needs to be generated again
-	@echo "$(WHALE) $@"
-	@test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \
+	$(Q)$(call WHALE_TARGET); \
+	test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \
 		((git diff | cat) && \
 		(echo "$(ONI) please run 'make protos' when making changes to proto files" && false))
 
-check-api-descriptors: protos ## check that protobuf changes aren't present.
-	@echo "$(WHALE) $@"
-	@test -z "$$(git status --short | grep ".pb.txt" | tee /dev/stderr)" || \
+check-api-descriptors: protos ## check that protobuf changes aren't present
+	$(Q)$(call WHALE_TARGET); \
+	test -z "$$(git status --short | grep ".pb.txt" | tee /dev/stderr)" || \
 		((git diff $$(find . -name '*.pb.txt') | cat) && \
 		(echo "$(ONI) please run 'make protos' when making changes to proto files and check-in the generated descriptor file changes" && false))
 
 proto-fmt: ## check format of proto files
-	@echo "$(WHALE) $@"
-	@test -z "$$(find . -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \
-		(echo "$(ONI) please indent proto files with tabs only" && false)
-	@test -z "$$(find . -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \
+	$(Q)$(call WHALE_TARGET); \
+	test -z "$$(find . -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \
+		(echo "$(ONI) please indent proto files with tabs only" && false); \
+	test -z "$$(find . -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \
 		(echo "$(ONI) meta fields in proto files must have option (gogoproto.nullable) = false" && false)
 
-build: ## build the go packages
-	@echo "$(WHALE) $@"
-	@$(GO) build ${DEBUG_GO_GCFLAGS} ${GO_GCFLAGS} ${GO_BUILD_FLAGS} ${EXTRA_FLAGS} ${PACKAGES}
-
-test: ## run tests, except integration tests and tests that require root
-	@echo "$(WHALE) $@"
-	@$(GOTEST) ${TESTFLAGS} ${TESTPACKAGES}
-
-integration: ## run integration tests
-	@echo "$(WHALE) $@"
-	@cd "${ROOTDIR}/integration" && $(GOTEST) -v ${TESTFLAGS}  -parallel ${TESTFLAGS_PARALLEL} .
-
-benchmark: ## run benchmarks tests
-	@echo "$(WHALE) $@"
-	@$(GO) test ${TESTFLAGS} -bench . -run Benchmark
-
-FORCE:
-
-define BUILD_BINARY
-@echo "$(WHALE) $@"
-@$(GO) build ${DEBUG_GO_GCFLAGS} ${GO_GCFLAGS} ${GO_BUILD_FLAGS} -o $@ ${GO_TAGS}  ./$<
-endef
-
-# Build a binary from a cmd.
-bin/%: cmd/% FORCE
-	$(call BUILD_BINARY)
-
-binaries: $(BINARIES) ## build binaries
-	@echo "$(WHALE) $@"
-
-clean: ## clean up binaries
-	@echo "$(WHALE) $@"
-	@rm -f $(BINARIES)
-
-install: ## install binaries
-	@echo "$(WHALE) $@ $(BINPACKAGES)"
-	@$(GO) install $(BINPACKAGES)
-
 install-protobuf:
-	@echo "$(WHALE) $@"
-	@script/install-protobuf
+	$(Q)$(call WHALE_TARGET); \
+	script/install-protobuf
 
 install-protobuild:
-	@echo "$(WHALE) $@"
-	@$(GO) install google.golang.org/protobuf/cmd/[email protected]
-	@$(GO) install github.com/containerd/protobuild@14832ccc41429f5c4f81028e5af08aa233a219cf
-
-coverage: ## generate coverprofiles from the unit tests, except tests that require root
-	@echo "$(WHALE) $@"
-	@rm -f coverage.txt
-	@$(GO) test ${TESTFLAGS} ${TESTPACKAGES} 2> /dev/null
-	@( for pkg in ${PACKAGES}; do \
-		$(GO) test ${TESTFLAGS} \
-			-cover \
-			-coverprofile=profile.out \
-			-covermode=atomic $$pkg || exit; \
-		if [ -f profile.out ]; then \
-			cat profile.out >> coverage.txt; \
-			rm profile.out; \
-		fi; \
-	done )
-
-vendor: ## ensure all the go.mod/go.sum files are up-to-date
-	@echo "$(WHALE) $@"
-	@$(GO) mod tidy
-	@$(GO) mod verify
-
-verify-vendor: ## verify if all the go.mod/go.sum files are up-to-date
-	@echo "$(WHALE) $@"
-	@$(GO) mod tidy
-	@$(GO) mod verify
-	@test -z "$$(git status --short | grep "go.sum" | tee /dev/stderr)" || \
+	$(Q)$(call WHALE_TARGET); \
+	$(GOINSTALL) google.golang.org/protobuf/cmd/[email protected] && \
+	$(GOINSTALL) github.com/containerd/protobuild@14832ccc41429f5c4f81028e5af08aa233a219cf
+
+verify-vendor: vendor ## verify if all the go.mod/go.sum files are up-to-date
+	$(Q)test -z "$$(git status --short | grep "go.sum" | tee /dev/stderr)" || \
 		((git diff | cat) && \
 		(echo "$(ONI) make sure to checkin changes after go mod tidy" && false))
 
-help: ## this help
-	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
+.PHONY: all check integration ci protos check-protos check-api-descriptors proto-fmt \
+        install-protobuf install-protobuild verify-vendor
+
+include common.mk

README.md

@@ -41,6 +41,11 @@ directly, if required.
   client and server interface that are different.
 - The Go stdlib context package is used instead.
 
+# Instrumentation
+
+The [otelttrpc](otelttrpc) module implements OpenTracing instrumentation
+support for ttrpc.
+
 # Status
 
 TODO: