forked from grafana/tempo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
348 lines (270 loc) · 11.3 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# Version number
VERSION=$(shell ./tools/image-tag | cut -d, -f 1)
GIT_REVISION := $(shell git rev-parse --short HEAD)
GIT_BRANCH := $(shell git rev-parse --abbrev-ref HEAD)
GOOS ?= $(shell go env GOOS)
GOARCH ?= $(shell go env GOARCH)
GOPATH := $(shell go env GOPATH)
GORELEASER := $(GOPATH)/bin/goreleaser
# Build Images
DOCKER_PROTOBUF_IMAGE ?= otel/build-protobuf:0.14.0
LOKI_BUILD_IMAGE ?= grafana/loki-build-image:0.21.0
DOCS_IMAGE ?= grafana/docs-base:latest
# More exclusions can be added similar with: -not -path './testbed/*'
ALL_SRC := $(shell find . -name '*.go' \
-not -path './tools*/*' \
-not -path './vendor*/*' \
-not -path './integration/*' \
-not -path './cmd/tempo-serverless/*' \
-type f | sort)
# ALL_SRC but without pkg and tempodb packages
OTHERS_SRC := $(shell find . -name '*.go' \
-not -path './tools*/*' \
-not -path './vendor*/*' \
-not -path './integration/*' \
-not -path './cmd/tempo-serverless/*' \
-not -path './pkg*/*' \
-not -path './tempodb*/*' \
-type f | sort)
# All source code and documents. Used in spell check.
ALL_DOC := $(shell find . \( -name "*.md" -o -name "*.yaml" \) \
-type f | sort)
# ALL_PKGS is used with 'go cover'
ALL_PKGS := $(shell go list $(sort $(dir $(ALL_SRC))))
GO_OPT= -mod vendor -ldflags "-X main.Branch=$(GIT_BRANCH) -X main.Revision=$(GIT_REVISION) -X main.Version=$(VERSION)"
ifeq ($(BUILD_DEBUG), 1)
GO_OPT+= -gcflags="all=-N -l"
endif
GOTEST_OPT?= -race -timeout 20m -count=1 -v
GOTEST_OPT_WITH_COVERAGE = $(GOTEST_OPT) -cover
GOTEST=gotestsum --format=testname --
LINT=golangci-lint
UNAME := $(shell uname -s)
ifeq ($(UNAME), Darwin)
SED_OPTS := ''
endif
FILES_TO_FMT=$(shell find . -type d \( -path ./vendor -o -path ./opentelemetry-proto -o -path ./vendor-fix \) -prune -o -name '*.go' -not -name "*.pb.go" -not -name '*.y.go' -print)
FILES_TO_JSONNETFMT=$(shell find ./operations/jsonnet ./operations/tempo-mixin -type f \( -name '*.libsonnet' -o -name '*.jsonnet' \) -not -path "*/vendor/*" -print)
### Build
.PHONY: tempo
tempo:
GO111MODULE=on CGO_ENABLED=0 go build $(GO_OPT) -o ./bin/$(GOOS)/tempo-$(GOARCH) $(BUILD_INFO) ./cmd/tempo
.PHONY: tempo-query
tempo-query:
GO111MODULE=on CGO_ENABLED=0 go build $(GO_OPT) -o ./bin/$(GOOS)/tempo-query-$(GOARCH) $(BUILD_INFO) ./cmd/tempo-query
.PHONY: tempo-cli
tempo-cli:
GO111MODULE=on CGO_ENABLED=0 go build $(GO_OPT) -o ./bin/$(GOOS)/tempo-cli-$(GOARCH) $(BUILD_INFO) ./cmd/tempo-cli
.PHONY: tempo-vulture
tempo-vulture:
GO111MODULE=on CGO_ENABLED=0 go build $(GO_OPT) -o ./bin/$(GOOS)/tempo-vulture-$(GOARCH) $(BUILD_INFO) ./cmd/tempo-vulture
.PHONY: exe
exe:
GOOS=linux $(MAKE) $(COMPONENT)
.PHONY: exe-debug
exe-debug:
BUILD_DEBUG=1 GOOS=linux $(MAKE) $(COMPONENT)
### Testin' and Lintin'
.PHONY: test
test:
$(GOTEST) $(GOTEST_OPT) $(ALL_PKGS)
.PHONY: benchmark
benchmark: tools
$(GOTEST) -bench=. -run=notests $(ALL_PKGS)
# Not used in CI, tests are split in pkg, tempodb, tempodb-wal and others in CI jobs
.PHONY: test-with-cover
test-with-cover: tools test-serverless
$(GOTEST) $(GOTEST_OPT_WITH_COVERAGE) $(ALL_PKGS)
# tests in pkg
.PHONY: test-with-cover-pkg
test-with-cover-pkg: tools
$(GOTEST) $(GOTEST_OPT_WITH_COVERAGE) $(shell go list $(sort $(dir $(shell find . -name '*.go' -path './pkg*/*' -type f | sort))))
# tests in tempodb (excluding tempodb/wal)
.PHONY: test-with-cover-tempodb
test-with-cover-tempodb: tools
GOMEMLIMIT=6GiB $(GOTEST) $(GOTEST_OPT_WITH_COVERAGE) $(shell go list $(sort $(dir $(shell find . -name '*.go' -not -path './tempodb/wal*/*' -path './tempodb*/*' -type f | sort))))
# tests in tempodb/wal
.PHONY: test-with-cover-tempodb-wal
test-with-cover-tempodb-wal: tools
$(GOTEST) $(GOTEST_OPT_WITH_COVERAGE) $(shell go list $(sort $(dir $(shell find . -name '*.go' -path './tempodb/wal*/*' -type f | sort))))
# all other tests (excluding pkg & tempodb)
.PHONY: test-with-cover-others
test-with-cover-others: tools test-serverless
$(GOTEST) $(GOTEST_OPT_WITH_COVERAGE) $(shell go list $(sort $(dir $(OTHERS_SRC))))
# runs e2e tests in the top level integration/e2e directory
.PHONY: test-e2e
test-e2e: tools docker-tempo docker-tempo-query
$(GOTEST) -v $(GOTEST_OPT) ./integration/e2e
# runs only serverless e2e tests
.PHONY: test-e2e-serverless
test-e2e-serverless: tools docker-tempo docker-serverless
$(GOTEST) -v $(GOTEST_OPT) ./integration/e2e/serverless
# test-all/bench use a docker image so build it first to make sure we're up to date
.PHONY: test-all
test-all: test-with-cover test-e2e test-e2e-serverless
.PHONY: test-bench
test-bench: tools docker-tempo
$(GOTEST) -v $(GOTEST_OPT) ./integration/bench
.PHONY: fmt check-fmt
fmt: tools
@gofumpt -w $(FILES_TO_FMT)
@goimports -w $(FILES_TO_FMT)
check-fmt: fmt
@git diff --exit-code -- $(FILES_TO_FMT)
.PHONY: jsonnetfmt check-jsonnetfmt
jsonnetfmt:
@jsonnetfmt -i $(FILES_TO_JSONNETFMT)
check-jsonnetfmt: jsonnetfmt
@git diff --exit-code -- $(FILES_TO_JSONNETFMT)
.PHONY: lint
lint:
$(LINT) run
### Docker Images
.PHONY: docker-component # Not intended to be used directly
docker-component: check-component exe
docker build -t grafana/$(COMPONENT) --build-arg=TARGETARCH=$(GOARCH) -f ./cmd/$(COMPONENT)/Dockerfile .
docker tag grafana/$(COMPONENT) $(COMPONENT)
.PHONY: docker-component-debug
docker-component-debug: check-component exe-debug
docker build -t grafana/$(COMPONENT)-debug --build-arg=TARGETARCH=$(GOARCH) -f ./cmd/$(COMPONENT)/Dockerfile_debug .
docker tag grafana/$(COMPONENT)-debug $(COMPONENT)-debug
.PHONY: docker-tempo
docker-tempo:
COMPONENT=tempo $(MAKE) docker-component
docker-tempo-debug:
COMPONENT=tempo $(MAKE) docker-component-debug
.PHONY: docker-cli
docker-tempo-cli:
COMPONENT=tempo-cli $(MAKE) docker-component
.PHONY: docker-tempo-query
docker-tempo-query:
COMPONENT=tempo-query $(MAKE) docker-component
.PHONY: docker-tempo-vulture
docker-tempo-vulture:
COMPONENT=tempo-vulture $(MAKE) docker-component
.PHONY: docker-images
docker-images: docker-tempo docker-tempo-query docker-tempo-vulture
.PHONY: check-component
check-component:
ifndef COMPONENT
$(error COMPONENT variable was not defined)
endif
# #########
# Gen Proto
# #########
PROTOC = docker run --rm -u ${shell id -u} -v${PWD}:${PWD} -w${PWD} ${DOCKER_PROTOBUF_IMAGE} --proto_path=${PWD}
PROTO_INTERMEDIATE_DIR = pkg/.patched-proto
PROTO_INCLUDES = -I$(PROTO_INTERMEDIATE_DIR)
PROTO_GEN = $(PROTOC) $(PROTO_INCLUDES) --gogofaster_out=plugins=grpc,paths=source_relative:$(2) $(1)
PROTO_GEN_WITH_VENDOR = $(PROTOC) $(PROTO_INCLUDES) -Ivendor -Ivendor/github.com/gogo/protobuf --gogofaster_out=plugins=grpc,paths=source_relative:$(2) $(1)
.PHONY: gen-proto
gen-proto:
@echo --
@echo -- Deleting existing
@echo --
rm -rf opentelemetry-proto
rm -rf $(PROTO_INTERMEDIATE_DIR)
find pkg/tempopb -name *.pb.go | xargs -L 1 -I rm
# Here we avoid removing our tempo.proto and our frontend.proto due to reliance on the gogoproto bits.
find pkg/tempopb -name *.proto | grep -v tempo.proto | grep -v frontend.proto | xargs -L 1 -I rm
@echo --
@echo -- Copying to $(PROTO_INTERMEDIATE_DIR)
@echo --
git submodule update --init
mkdir -p $(PROTO_INTERMEDIATE_DIR)
cp -R opentelemetry-proto/opentelemetry/proto/* $(PROTO_INTERMEDIATE_DIR)
@echo --
@echo -- Editing proto
@echo --
@# Update package and types from opentelemetry.proto.* -> tempopb.*
@# giving final types like "tempopb.common.v1.InstrumentationLibrary" which
@# will not conflict with other usages of opentelemetry proto in downstream apps.
find $(PROTO_INTERMEDIATE_DIR) -name "*.proto" | xargs -L 1 sed -i $(SED_OPTS) 's+ opentelemetry.proto+ tempopb+g'
@# Update go_package
find $(PROTO_INTERMEDIATE_DIR) -name "*.proto" | xargs -L 1 sed -i $(SED_OPTS) 's+go.opentelemetry.io/proto/otlp+github.com/grafana/tempo/pkg/tempopb+g'
@# Update import paths
find $(PROTO_INTERMEDIATE_DIR) -name "*.proto" | xargs -L 1 sed -i $(SED_OPTS) 's+import "opentelemetry/proto/+import "+g'
@echo --
@echo -- Gen proto --
@echo --
$(call PROTO_GEN,$(PROTO_INTERMEDIATE_DIR)/common/v1/common.proto,./pkg/tempopb/)
$(call PROTO_GEN,$(PROTO_INTERMEDIATE_DIR)/resource/v1/resource.proto,./pkg/tempopb/)
$(call PROTO_GEN,$(PROTO_INTERMEDIATE_DIR)/trace/v1/trace.proto,./pkg/tempopb/)
$(call PROTO_GEN,pkg/tempopb/tempo.proto,./)
$(call PROTO_GEN_WITH_VENDOR,modules/frontend/v1/frontendv1pb/frontend.proto,./)
rm -rf $(PROTO_INTERMEDIATE_DIR)
# ##############
# Gen Traceql
# ##############
.PHONY: gen-traceql
gen-traceql:
docker run --rm -v${PWD}:/src/loki ${LOKI_BUILD_IMAGE} gen-traceql-local
.PHONY: gen-traceql-local
gen-traceql-local:
goyacc -o pkg/traceql/expr.y.go pkg/traceql/expr.y && rm y.output
### Check vendored and generated files are up to date
.PHONY: vendor-check
vendor-check: gen-proto update-mod gen-traceql
git diff --exit-code -- **/go.sum **/go.mod vendor/ pkg/tempopb/ pkg/traceql/
### Tidy dependencies for tempo and tempo-serverless modules
.PHONY: update-mod
update-mod:
go mod vendor
go mod tidy -e
$(MAKE) -C cmd/tempo-serverless update-mod
### Release (intended to be used in the .github/workflows/release.yml)
$(GORELEASER):
go install github.com/goreleaser/goreleaser@latest
.PHONY: release
release: $(GORELEASER)
$(GORELEASER) release --rm-dist
.PHONY: release-snapshot
release-snapshot: $(GORELEASER)
$(GORELEASER) release --skip-validate --rm-dist --snapshot
### Docs
.PHONY: docs
docs:
docker pull ${DOCS_IMAGE}
docker run -v ${PWD}/docs/sources/tempo:/hugo/content/docs/tempo/latest:z -p 3002:3002 --rm $(DOCS_IMAGE) /bin/bash -c 'mkdir -p content/docs/grafana/latest/ && touch content/docs/grafana/latest/menu.yaml && make server'
.PHONY: docs-test
docs-test:
docker pull ${DOCS_IMAGE}
docker run -v ${PWD}/docs/sources/tempo:/hugo/content/docs/tempo/latest:z -p 3002:3002 --rm $(DOCS_IMAGE) /bin/bash -c 'mkdir -p content/docs/grafana/latest/ && touch content/docs/grafana/latest/menu.yaml && make prod'
### jsonnet
.PHONY: jsonnet jsonnet-check jsonnet-test
jsonnet:
$(MAKE) -C operations/jsonnet-compiled/util gen
jsonnet-check:
$(MAKE) -C operations/jsonnet-compiled/util check
jsonnet-test:
$(MAKE) -C operations/jsonnet/microservices test
### serverless
.PHONY: docker-serverless test-serverless
docker-serverless:
$(MAKE) -C cmd/tempo-serverless build-docker
test-serverless:
$(MAKE) -C cmd/tempo-serverless test
### tempo-mixin
.PHONY: tempo-mixin tempo-mixin-check
tempo-mixin:
$(MAKE) -C operations/tempo-mixin all
tempo-mixin-check:
$(MAKE) -C operations/tempo-mixin check
### drone
.PHONY: drone drone-jsonnet drone-signature
# this requires the drone-cli https://docs.drone.io/cli/install/
drone:
# piggyback on Loki's build image, this image contains a newer version of drone-cli than is
# released currently (1.4.0). The newer version of drone-clie keeps drone.yml human-readable.
# This will run 'make drone-jsonnet' from within the container
docker run -e DRONE_SERVER -e DRONE_TOKEN --rm -v $(shell pwd):/src/loki ${LOKI_BUILD_IMAGE} drone-jsonnet drone-signature
drone lint .drone/drone.yml --trusted
drone-jsonnet:
drone jsonnet --stream --format --source .drone/drone.jsonnet --target .drone/drone.yml
drone-signature:
ifndef DRONE_TOKEN
$(error DRONE_TOKEN is not set, visit https://drone.grafana.net/account)
endif
DRONE_SERVER=https://drone.grafana.net drone sign --save grafana/tempo .drone/drone.yml
# Import fragments
include build/tools.mk