Makefile

OUTFILE := pganalyze-collector
PROTOBUF_FILES := $(wildcard protobuf/*.proto)

PATH := $(PWD)/protoc/bin:$(PWD)/bin:$(PATH)
SHELL := env PATH=$(PATH) /bin/sh

PROTOC_VERSION_NEEDED := 28.2
PROTOC_VERSION := $(shell command -v protoc > /dev/null 2>&1 && protoc --version)

.PHONY: default build build_dist vendor test docker_release packages integration_test

default: build test

build: install_protoc output/pganalyze_collector/snapshot.pb.go build_dist

build_dist:
	go build -o ${OUTFILE}
	make -C helper OUTFILE=../pganalyze-collector-helper
	make -C setup OUTFILE=../pganalyze-collector-setup

build_dist_alpine:
	# Increase stack size from Alpine's default of 80kb to 2mb - otherwise we see
	# crashes on very complex queries, pg_query expects at least 100kb stack size
	go build -o ${OUTFILE} -ldflags '-extldflags "-Wl,-z,stack-size=0x200000"'
	make -C helper OUTFILE=../pganalyze-collector-helper
	make -C setup OUTFILE=../pganalyze-collector-setup

vendor:
	GO111MODULE=on go mod tidy
	# See CONTRIBUTING.md if modvendor can't be found
	GO111MODULE=on go mod vendor
	modvendor -copy="**/*.c **/*.h **/*.proto" -v

test: build
	go test -race -coverprofile=coverage.out ./...

coverage: test
	go tool cover -html=coverage.out

run: build
	go run -race .

integration_test:
	make -C integration_test

packages:
	make -C packages

DOCKER_RELEASE_TAG := $(shell git describe --tags --exact-match --abbrev=0 2> /dev/null)
docker_release:
	@test -n "$(DOCKER_RELEASE_TAG)" || (echo "ERROR: DOCKER_RELEASE_TAG is not set, make sure you are on a git release tag or override by setting DOCKER_RELEASE_TAG" ; exit 1)
	docker buildx create --name collector-build --driver docker-container
	docker buildx build --platform linux/amd64,linux/arm64 --builder collector-build --push \
	-t quay.io/pganalyze/collector:$(DOCKER_RELEASE_TAG) \
	-t quay.io/pganalyze/collector:latest \
	-t quay.io/pganalyze/collector:stable \
	.
	docker buildx rm collector-build

output/pganalyze_collector/snapshot.pb.go: $(PROTOBUF_FILES)
ifdef PROTOC_VERSION
	mkdir -p $(PWD)/bin
	GOBIN=$(PWD)/bin go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.31.0
	protoc --go_out=. --go_opt=module=github.com/pganalyze/collector -I protobuf $(PROTOBUF_FILES)
else
	@echo '👷 Warning: protoc not found, skipping protocol buffer regeneration (to install protoc check Makefile instructions in install_protoc step)'
endif

install_protoc:
ifdef PROTOC_VERSION
ifeq (,$(findstring $(PROTOC_VERSION_NEEDED), $(PROTOC_VERSION)))
	@echo "⚠️  protoc version needed: $(PROTOC_VERSION_NEEDED) vs $(PROTOC_VERSION) installed"
	@echo "ℹ️  Please download the correct protobuf binary for your OS from https://github.com/protocolbuffers/protobuf/releases/tag/v${PROTOC_VERSION_NEEDED}"
	@echo "ℹ️  Note the download's name will look like this: protoc-${PROTOC_VERSION_NEEDED}-osx-x86_64.zip"
	@echo "ℹ️  Copy the unzipped folder into this project, and rename it to \"protoc\""
	@echo "ℹ️  If this is macOS, you will need to try running the binary yourself, then go to Security & Privacy to explicitly allow it."
	exit 1
endif
endif