You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
186 lines
11 KiB
186 lines
11 KiB
GOPATH_DIR := $(GOPATH)/src/github.com/open-telemetry/opentelemetry-proto |
|
GENDIR := gen |
|
GOPATH_GENDIR := $(GOPATH_DIR)/$(GENDIR) |
|
|
|
# Find all .proto files. |
|
PROTO_FILES := $(wildcard opentelemetry/proto/*/*/*.proto opentelemetry/proto/*/*/*/*.proto) |
|
|
|
# Function to execute a command. Note the empty line before endef to make sure each command |
|
# gets executed separately instead of concatenated with previous one. |
|
# Accepts command to execute as first parameter. |
|
define exec-command |
|
$(1) |
|
|
|
endef |
|
|
|
.PHONY: all |
|
all: gen-all markdown-link-check markdownlint |
|
|
|
# Generate all implementations |
|
.PHONY: gen-all |
|
gen-all: gen-cpp gen-csharp gen-go gen-java gen-kotlin gen-objc gen-openapi gen-php gen-python gen-ruby |
|
|
|
OTEL_DOCKER_PROTOBUF ?= otel/build-protobuf:0.9.0 |
|
BUF_DOCKER ?= bufbuild/buf:1.7.0 |
|
|
|
PROTOC := docker run --rm -u ${shell id -u} -v${PWD}:${PWD} -w${PWD} ${OTEL_DOCKER_PROTOBUF} --proto_path=${PWD} |
|
BUF := docker run --rm -v "${PWD}:/workspace" -w /workspace ${BUF_DOCKER} |
|
# When checking for protobuf breaking changes, check against the latest release tag |
|
LAST_RELEASE_TAG := $(shell git tag --sort=committerdate | tail -1) |
|
# Options are described in https://docs.buf.build/breaking/usage#git |
|
BUF_AGAINST ?= "https://github.com/open-telemetry/opentelemetry-proto.git\#tag=$(LAST_RELEASE_TAG)" |
|
|
|
PROTO_GEN_CPP_DIR ?= $(GENDIR)/cpp |
|
PROTO_GEN_CSHARP_DIR ?= $(GENDIR)/csharp |
|
PROTO_GEN_GO_DIR ?= $(GENDIR)/go |
|
PROTO_GEN_JAVA_DIR ?= $(GENDIR)/java |
|
PROTO_GEN_JS_DIR ?= $(GENDIR)/js |
|
PROTO_GEN_KOTLIN_DIR ?= $(GENDIR)/kotlin |
|
PROTO_GEN_OBJC_DIR ?= $(GENDIR)/objc |
|
PROTO_GEN_OPENAPI_DIR ?= $(GENDIR)/openapi |
|
PROTO_GEN_PHP_DIR ?= $(GENDIR)/php |
|
PROTO_GEN_PYTHON_DIR ?= $(GENDIR)/python |
|
PROTO_GEN_RUBY_DIR ?= $(GENDIR)/ruby |
|
|
|
# Docker pull image. |
|
.PHONY: docker-pull |
|
docker-pull: |
|
docker pull $(OTEL_DOCKER_PROTOBUF) |
|
docker pull $(BUF_DOCKER) |
|
|
|
# Generate gRPC/Protobuf implementation for C++. |
|
.PHONY: gen-cpp |
|
gen-cpp: |
|
rm -rf ./$(PROTO_GEN_CPP_DIR) |
|
mkdir -p ./$(PROTO_GEN_CPP_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --cpp_out=./$(PROTO_GEN_CPP_DIR) $(file))) |
|
$(PROTOC) --cpp_out=./$(PROTO_GEN_CPP_DIR) --grpc-cpp_out=./$(PROTO_GEN_CPP_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --cpp_out=./$(PROTO_GEN_CPP_DIR) --grpc-cpp_out=./$(PROTO_GEN_CPP_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --cpp_out=./$(PROTO_GEN_CPP_DIR) --grpc-cpp_out=./$(PROTO_GEN_CPP_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --cpp_out=./$(PROTO_GEN_CPP_DIR) --grpc-cpp_out=./$(PROTO_GEN_CPP_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for C#. |
|
.PHONY: gen-csharp |
|
gen-csharp: |
|
rm -rf ./$(PROTO_GEN_CSHARP_DIR) |
|
mkdir -p ./$(PROTO_GEN_CSHARP_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --csharp_out=./$(PROTO_GEN_CSHARP_DIR) $(file))) |
|
$(PROTOC) --csharp_out=./$(PROTO_GEN_CSHARP_DIR) --grpc-csharp_out=./$(PROTO_GEN_CSHARP_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --csharp_out=./$(PROTO_GEN_CSHARP_DIR) --grpc-csharp_out=./$(PROTO_GEN_CSHARP_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --csharp_out=./$(PROTO_GEN_CSHARP_DIR) --grpc-csharp_out=./$(PROTO_GEN_CSHARP_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --csharp_out=./$(PROTO_GEN_CSHARP_DIR) --grpc-csharp_out=./$(PROTO_GEN_CSHARP_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for Go. |
|
.PHONY: gen-go |
|
gen-go: |
|
rm -rf ./$(PROTO_GEN_GO_DIR) |
|
mkdir -p ./$(PROTO_GEN_GO_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command,$(PROTOC) --go_out=plugins=grpc:./$(PROTO_GEN_GO_DIR) $(file))) |
|
$(PROTOC) --grpc-gateway_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/trace/v1/trace_service_http.yaml:./$(PROTO_GEN_GO_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --grpc-gateway_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/metrics/v1/metrics_service_http.yaml:./$(PROTO_GEN_GO_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --grpc-gateway_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/logs/v1/logs_service_http.yaml:./$(PROTO_GEN_GO_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --grpc-gateway_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/profiles/v1experimental/profiles_service_http.yaml:./$(PROTO_GEN_GO_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for Java. |
|
.PHONY: gen-java |
|
gen-java: |
|
rm -rf ./$(PROTO_GEN_JAVA_DIR) |
|
mkdir -p ./$(PROTO_GEN_JAVA_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --java_out=./$(PROTO_GEN_JAVA_DIR) $(file))) |
|
|
|
# Generate gRPC/Protobuf implementation for Kotlin. |
|
.PHONY: gen-kotlin |
|
gen-kotlin: gen-java |
|
rm -rf ./$(PROTO_GEN_KOTLIN_DIR) |
|
mkdir -p ./$(PROTO_GEN_KOTLIN_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --kotlin_out=./$(PROTO_GEN_KOTLIN_DIR) $(file))) |
|
|
|
|
|
# Generate gRPC/Protobuf implementation for JavaScript. |
|
.PHONY: gen-js |
|
gen-js: |
|
rm -rf ./$(PROTO_GEN_JS_DIR) |
|
mkdir -p ./$(PROTO_GEN_JS_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --js_out=import_style=commonjs:./$(PROTO_GEN_JS_DIR) $(file))) |
|
$(PROTOC) --js_out=import_style=commonjs:./$(PROTO_GEN_JS_DIR) --grpc-web_out=import_style=commonjs,mode=grpcweb:./$(PROTO_GEN_JS_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --js_out=import_style=commonjs:./$(PROTO_GEN_JS_DIR) --grpc-web_out=import_style=commonjs,mode=grpcweb:./$(PROTO_GEN_JS_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --js_out=import_style=commonjs:./$(PROTO_GEN_JS_DIR) --grpc-web_out=import_style=commonjs,mode=grpcweb:./$(PROTO_GEN_JS_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --js_out=import_style=commonjs:./$(PROTO_GEN_JS_DIR) --grpc-web_out=import_style=commonjs,mode=grpcweb:./$(PROTO_GEN_JS_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for Objective-C. |
|
.PHONY: gen-objc |
|
gen-objc: |
|
rm -rf ./$(PROTO_GEN_OBJC_DIR) |
|
mkdir -p ./$(PROTO_GEN_OBJC_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --objc_out=./$(PROTO_GEN_OBJC_DIR) $(file))) |
|
$(PROTOC) --objc_out=./$(PROTO_GEN_OBJC_DIR) --grpc-objc_out=./$(PROTO_GEN_OBJC_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --objc_out=./$(PROTO_GEN_OBJC_DIR) --grpc-objc_out=./$(PROTO_GEN_OBJC_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --objc_out=./$(PROTO_GEN_OBJC_DIR) --grpc-objc_out=./$(PROTO_GEN_OBJC_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --objc_out=./$(PROTO_GEN_OBJC_DIR) --grpc-objc_out=./$(PROTO_GEN_OBJC_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf for openapi v2 (swagger) |
|
.PHONY: gen-openapi |
|
gen-openapi: |
|
mkdir -p $(PROTO_GEN_OPENAPI_DIR) |
|
$(PROTOC) --openapiv2_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/trace/v1/trace_service_http.yaml:$(PROTO_GEN_OPENAPI_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --openapiv2_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/metrics/v1/metrics_service_http.yaml:$(PROTO_GEN_OPENAPI_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --openapiv2_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/logs/v1/logs_service_http.yaml:$(PROTO_GEN_OPENAPI_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --openapiv2_out=logtostderr=true,grpc_api_configuration=opentelemetry/proto/collector/profiles/v1experimental/profiles_service_http.yaml:$(PROTO_GEN_OPENAPI_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for PhP. |
|
.PHONY: gen-php |
|
gen-php: |
|
rm -rf ./$(PROTO_GEN_PHP_DIR) |
|
mkdir -p ./$(PROTO_GEN_PHP_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --php_out=./$(PROTO_GEN_PHP_DIR) $(file))) |
|
$(PROTOC) --php_out=./$(PROTO_GEN_PHP_DIR) --grpc-php_out=./$(PROTO_GEN_PHP_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --php_out=./$(PROTO_GEN_PHP_DIR) --grpc-php_out=./$(PROTO_GEN_PHP_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --php_out=./$(PROTO_GEN_PHP_DIR) --grpc-php_out=./$(PROTO_GEN_PHP_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --php_out=./$(PROTO_GEN_PHP_DIR) --grpc-php_out=./$(PROTO_GEN_PHP_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for Python. |
|
.PHONY: gen-python |
|
gen-python: |
|
rm -rf ./$(PROTO_GEN_PYTHON_DIR) |
|
mkdir -p ./$(PROTO_GEN_PYTHON_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --python_out=./$(PROTO_GEN_PYTHON_DIR) $(file))) |
|
$(PROTOC) --python_out=./$(PROTO_GEN_PYTHON_DIR) --grpc-python_out=./$(PROTO_GEN_PYTHON_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --python_out=./$(PROTO_GEN_PYTHON_DIR) --grpc-python_out=./$(PROTO_GEN_PYTHON_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --python_out=./$(PROTO_GEN_PYTHON_DIR) --grpc-python_out=./$(PROTO_GEN_PYTHON_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --python_out=./$(PROTO_GEN_PYTHON_DIR) --grpc-python_out=./$(PROTO_GEN_PYTHON_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# Generate gRPC/Protobuf implementation for Ruby. |
|
.PHONY: gen-ruby |
|
gen-ruby: |
|
rm -rf ./$(PROTO_GEN_RUBY_DIR) |
|
mkdir -p ./$(PROTO_GEN_RUBY_DIR) |
|
$(foreach file,$(PROTO_FILES),$(call exec-command, $(PROTOC) --ruby_out=./$(PROTO_GEN_RUBY_DIR) $(file))) |
|
$(PROTOC) --ruby_out=./$(PROTO_GEN_RUBY_DIR) --grpc-ruby_out=./$(PROTO_GEN_RUBY_DIR) opentelemetry/proto/collector/trace/v1/trace_service.proto |
|
$(PROTOC) --ruby_out=./$(PROTO_GEN_RUBY_DIR) --grpc-ruby_out=./$(PROTO_GEN_RUBY_DIR) opentelemetry/proto/collector/metrics/v1/metrics_service.proto |
|
$(PROTOC) --ruby_out=./$(PROTO_GEN_RUBY_DIR) --grpc-ruby_out=./$(PROTO_GEN_RUBY_DIR) opentelemetry/proto/collector/logs/v1/logs_service.proto |
|
$(PROTOC) --ruby_out=./$(PROTO_GEN_RUBY_DIR) --grpc-ruby_out=./$(PROTO_GEN_RUBY_DIR) opentelemetry/proto/collector/profiles/v1experimental/profiles_service.proto |
|
|
|
# The Profiling protocol is still experimental. So it is excluded from the breaking-change check. |
|
.PHONY: breaking-change |
|
breaking-change: |
|
$(BUF) breaking --against $(BUF_AGAINST) --config '{"version":"v1","breaking":{"ignore":["opentelemetry/proto/profiles", "opentelemetry/proto/collector/profiles"]}}' $(BUF_FLAGS) |
|
|
|
|
|
ALL_DOCS := $(shell find . -type f -name '*.md' -not -path './.github/*' -not -path './node_modules/*' | sort) |
|
|
|
.PHONY: markdown-link-check |
|
markdown-link-check: |
|
@if ! npm ls markdown-link-check; then npm install; fi |
|
@for f in $(ALL_DOCS); do \ |
|
npx --no -- markdown-link-check --quiet --config .markdown_link_check_config.json $$f \ |
|
|| exit 1; \ |
|
done |
|
|
|
.PHONY: markdownlint |
|
markdownlint: |
|
@if ! npm ls markdownlint; then npm install; fi |
|
@for f in $(ALL_DOCS); do \ |
|
echo $$f; \ |
|
npx --no -p markdownlint-cli markdownlint -c .markdownlint.yaml $$f \ |
|
|| exit 1; \ |
|
done
|
|
|