github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity
VictoriaMetrics/Makefile

188 lines
6 KiB
Makefile
Raw Normal View History

all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
PKG_PREFIX := github.com/VictoriaMetrics/VictoriaMetrics
Allow specifying build date from a variable (#1200) Just like the existing infrastructure for `BUILDINFO_TAG`, this can ease the production of [reproducible builds](https://wiki.freebsd.org/ReproducibleBuilds). (e.g. in FreeBSD the date the port was committed is used at build time, not the actual build time, so that an identical port produced at different times produces an identical executable)
2021-04-10 12:46:53 +00:00
DATEINFO_TAG ?= $(shell date -u +'%Y%m%d-%H%M%S')
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
BUILDINFO_TAG ?= $(shell echo $$(git describe --long --all | tr '/' '-')$$( \
all: port to FreeBSD on GOARCH=amd64
2019-08-27 22:04:44 +00:00
git diff-index --quiet HEAD -- || echo '-dirty-'$$(git diff-index -u HEAD | openssl sha1 | cut -c 10-17)))
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
PKG_TAG ?= $(shell git tag -l --points-at HEAD)
ifeq ($(PKG_TAG),)
PKG_TAG := $(BUILDINFO_TAG)
endif
Allow specifying build date from a variable (#1200) Just like the existing infrastructure for `BUILDINFO_TAG`, this can ease the production of [reproducible builds](https://wiki.freebsd.org/ReproducibleBuilds). (e.g. in FreeBSD the date the port was committed is used at build time, not the actual build time, so that an identical port produced at different times produces an identical executable)
2021-04-10 12:46:53 +00:00
GO_BUILDINFO = -X '$(PKG_PREFIX)/lib/buildinfo.Version=$(APP_NAME)-$(DATEINFO_TAG)-$(BUILDINFO_TAG)'
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: force running Makefile rules if there is a file matching their names
2020-12-18 10:20:01 +00:00
.PHONY: $(MAKECMDGOALS)
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: \
all: open-sourcing cluster version
2019-05-22 21:23:23 +00:00
vminsert \
vmselect \
Makefile: do not build vmagent, vmalert, vmauth, vmbackup and vmrestore binaries in cluster branch, since they are identical to binaries in single-node version There are subtle differences between these binaries in cluster branch from binaries in single-node branch such as missing `-httpAuth.*` command-line flags. These differences introduce confusion to users, so let's stop building these binaries from cluster version.
2020-12-18 16:27:04 +00:00
vmstorage
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
all-pure: \
vminsert-pure \
vmselect-pure \
Makefile: do not build vmagent, vmalert, vmauth, vmbackup and vmrestore binaries in cluster branch, since they are identical to binaries in single-node version There are subtle differences between these binaries in cluster branch from binaries in single-node branch such as missing `-httpAuth.*` command-line flags. These differences introduce confusion to users, so let's stop building these binaries from cluster version.
2020-12-18 16:27:04 +00:00
vmstorage-pure
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
include app/*/Makefile
include deployment/*/Makefile
clean:
rm -rf bin/*
all: open-sourcing cluster version
2019-05-22 21:23:23 +00:00
publish: \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
publish-vminsert \
Makefile: add missing `vmbackup` and `vmrestore` to `all` and `all-pure` targets
2020-02-16 14:55:28 +00:00
publish-vmselect \
Makefile: do not build vmagent, vmalert, vmauth, vmbackup and vmrestore binaries in cluster branch, since they are identical to binaries in single-node version There are subtle differences between these binaries in cluster branch from binaries in single-node branch such as missing `-httpAuth.*` command-line flags. These differences introduce confusion to users, so let's stop building these binaries from cluster version.
2020-12-18 16:27:04 +00:00
publish-vmstorage
all: open-sourcing cluster version
2019-05-22 21:23:23 +00:00
package: \
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
package-vminsert \
Makefile: add missing `vmbackup` and `vmrestore` to `all` and `all-pure` targets
2020-02-16 14:55:28 +00:00
package-vmselect \
Makefile: do not build vmagent, vmalert, vmauth, vmbackup and vmrestore binaries in cluster branch, since they are identical to binaries in single-node version There are subtle differences between these binaries in cluster branch from binaries in single-node branch such as missing `-httpAuth.*` command-line flags. These differences introduce confusion to users, so let's stop building these binaries from cluster version.
2020-12-18 16:27:04 +00:00
package-vmstorage
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: add `TAG=v... make publish-release` rule for building and publishing a release for the given TAG
2021-11-08 10:29:10 +00:00
publish-release:
git checkout $(TAG) && $(MAKE) release publish && \
git checkout $(TAG)-cluster && $(MAKE) release publish && \
git checkout $(TAG)-enterprise && $(MAKE) release publish && \
git checkout $(TAG)-enterprise-cluster && $(MAKE) release publish
Makefile: add `make release` rule for building release tar.gz file with cluster binaries Fixes https://github.com/VictoriaMetrics/VictoriaMetrics/issues/146
2019-08-15 11:05:17 +00:00
release: \
Makefile: do not build vmagent, vmalert, vmauth, vmbackup and vmrestore binaries in cluster branch, since they are identical to binaries in single-node version There are subtle differences between these binaries in cluster branch from binaries in single-node branch such as missing `-httpAuth.*` command-line flags. These differences introduce confusion to users, so let's stop building these binaries from cluster version.
2020-12-18 16:27:04 +00:00
release-vmcluster
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
release-vmcluster: \
Makefile: prepare `arm64` and `amd64` release archives for cluster version on `make release` command
2021-04-05 20:01:45 +00:00
release-vmcluster-amd64 \
release-vmcluster-arm64
release-vmcluster-amd64:
GOARCH=amd64 $(MAKE) release-vmcluster-generic
release-vmcluster-arm64:
GOARCH=arm64 $(MAKE) release-vmcluster-generic
release-vmcluster-generic: \
vminsert-$(GOARCH)-prod \
vmselect-$(GOARCH)-prod \
vmstorage-$(GOARCH)-prod
cd bin && \
tar --transform="flags=r;s|-$(GOARCH)||" -czf victoria-metrics-$(GOARCH)-$(PKG_TAG).tar.gz \
vminsert-$(GOARCH)-prod \
vmselect-$(GOARCH)-prod \
vmstorage-$(GOARCH)-prod \
&& sha256sum victoria-metrics-$(GOARCH)-$(PKG_TAG).tar.gz \
vminsert-$(GOARCH)-prod \
vmselect-$(GOARCH)-prod \
vmstorage-$(GOARCH)-prod \
| sed s/-$(GOARCH)-prod/-prod/ > victoria-metrics-$(GOARCH)-$(PKG_TAG)_checksums.txt
Makefile: add `make release` rule for building release tar.gz file with cluster binaries Fixes https://github.com/VictoriaMetrics/VictoriaMetrics/issues/146
2019-08-15 11:05:17 +00:00
Makefile: add `pprof-cpu` rule for inspecting CPU profiles with `PPROF_FILE=/path/to/cpu.pprof make pprof-cpu`
2019-11-04 10:43:26 +00:00
pprof-cpu:
go tool pprof -trim_path=github.com/VictoriaMetrics/VictoriaMetrics@ $(PPROF_FILE)
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
fmt:
Makefile: pass `GO111MODULE=on` to all the `go` invocations
2019-05-26 20:19:34 +00:00
GO111MODULE=on gofmt -l -w -s ./lib
GO111MODULE=on gofmt -l -w -s ./app
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
vet:
Makefile: run `go vet` with `-mod=vendor` in order to disable downloading vendored deps
2019-05-28 22:38:13 +00:00
GO111MODULE=on go vet -mod=vendor ./lib/...
GO111MODULE=on go vet -mod=vendor ./app/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
lint: install-golint
golint lib/...
golint app/...
install-golint:
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
which golint || GO111MODULE=off go get golang.org/x/lint/golint
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
errcheck: install-errcheck
errcheck -exclude=errcheck_excludes.txt ./lib/...
errcheck -exclude=errcheck_excludes.txt ./app/vminsert/...
errcheck -exclude=errcheck_excludes.txt ./app/vmselect/...
errcheck -exclude=errcheck_excludes.txt ./app/vmstorage/...
app/vmagent: initial implementation for vmagent
2020-02-23 11:35:47 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmagent/...
app/vmalert: include it into the next release
2020-04-27 21:09:35 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmalert/...
app/vmauth: add initial version of vmauth. See https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/app/vmauth/README.md for details
2020-05-05 07:53:42 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmauth/...
app/{vmbackup,vmrestore}: add `vmbackup` and `vmrestore` tools for creating backups on s3 or gcs from instant snapshots Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/203 Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/38
2019-11-07 19:05:39 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmbackup/...
errcheck -exclude=errcheck_excludes.txt ./app/vmrestore/...
app/vmctl: move vmctl code from github.com/VictoriaMetrics/vmctl It is better developing vmctl tool in VictoriaMetrics repository, so it could be released together with the rest of vmutils tools such as vmalert, vmagent, vmbackup, vmrestore and vmauth.
2021-01-31 23:10:16 +00:00
errcheck -exclude=errcheck_excludes.txt ./app/vmctl/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
install-errcheck:
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
which errcheck || GO111MODULE=off go get github.com/kisielk/errcheck
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
Makefile: consistency renaming: check_all -> check-all
2019-08-13 18:31:13 +00:00
check-all: fmt vet lint errcheck golangci-lint
Makefile: enable golangci-lint in `make check_all`
2019-06-20 11:52:48 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
test:
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
GO111MODULE=on go test -mod=vendor ./lib/... ./app/...
Makefile: enable golangci-lint in `make check_all`
2019-06-20 11:52:48 +00:00
Makefile: add build and test rules with enabled race detector. These rules have `-race` suffix Fix also `unsafe pointer conversion` errors detected by Go1.14. See https://golang.org/doc/go1.14#compiler .
2020-03-05 10:02:06 +00:00
test-race:
GO111MODULE=on go test -mod=vendor -race ./lib/... ./app/...
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
test-pure:
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
GO111MODULE=on CGO_ENABLED=0 go test -mod=vendor ./lib/... ./app/...
test-full:
GO111MODULE=on go test -mod=vendor -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
all: add support for GOARCH=386 and fix all the issues related to 32-bit architectures such as GOARCH=arm Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/212
2019-10-17 15:22:56 +00:00
test-full-386:
app/victoria-metrics: remove `integration` build tag from tests This simplifies testing with `go test ./app/victoria-metrics` without the need to remember to pass `-tags=integration` to Go commands.
2020-01-27 18:25:26 +00:00
GO111MODULE=on GOARCH=386 go test -mod=vendor -coverprofile=coverage.txt -covermode=atomic ./lib/... ./app/...
all: add support for GOARCH=386 and fix all the issues related to 32-bit architectures such as GOARCH=arm Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/212
2019-10-17 15:22:56 +00:00
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
benchmark:
Makefile: add `-mod=vendor` to `go test`, so tests use external deps from `vendor` folder
2019-05-26 21:35:46 +00:00
GO111MODULE=on go test -mod=vendor -bench=. ./lib/...
GO111MODULE=on go test -mod=vendor -bench=. ./app/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: add Pure Go build (pull request #114) Updates #94
2019-07-23 16:26:39 +00:00
benchmark-pure:
GO111MODULE=on CGO_ENABLED=0 go test -mod=vendor -bench=. ./lib/...
GO111MODULE=on CGO_ENABLED=0 go test -mod=vendor -bench=. ./app/...
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
vendor-update:
Makefile: add `-d` flag to `go get` in `vendor-update` target This should skip unnecessary build step for the updated packages
2020-11-16 18:48:38 +00:00
GO111MODULE=on go get -u -d ./lib/...
GO111MODULE=on go get -u -d ./app/...
Makefile: pass `GO111MODULE=on` to all the `go` invocations
2019-05-26 20:19:34 +00:00
GO111MODULE=on go mod tidy
GO111MODULE=on go mod vendor
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
all: open-sourcing cluster version
2019-05-22 21:23:23 +00:00
app-local:
all: small updates after PR #114
2019-07-23 16:54:50 +00:00
CGO_ENABLED=1 GO111MODULE=on go build $(RACE) -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
app-local-pure:
CGO_ENABLED=0 GO111MODULE=on go build $(RACE) -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-pure$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
all: open-sourcing cluster version
2019-05-22 21:23:23 +00:00
all: add mssing APP_NAME to vm*-GOARCH builds
2020-07-31 10:42:09 +00:00
app-local-with-goarch:
GO111MODULE=on go build $(RACE) -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-$(GOARCH)$(RACE) $(PKG_PREFIX)/app/$(APP_NAME)
Makefile: prepare vmutils-windows-*.zip archive on `make release-vmutils` command The archive contains the following executables for Windows: * vmagent * vmalert * vmauth * vmctl Other components - vmbackup, vmrestore, victoria-metrics - aren't supported for Windows yet
2021-03-16 18:49:07 +00:00
app-local-windows-with-goarch:
CGO_ENABLED=0 GO111MODULE=on go build $(RACE) -mod=vendor -ldflags "$(GO_BUILDINFO)" -o bin/$(APP_NAME)-windows-$(GOARCH)$(RACE).exe $(PKG_PREFIX)/app/$(APP_NAME)
all: open-sourcing single-node version
2019-05-22 21:16:55 +00:00
quicktemplate-gen: install-qtc
qtc
install-qtc:
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
which qtc || GO111MODULE=off go get github.com/valyala/quicktemplate/qtc
Makefile: add `make golangci-lint` rule for running `golangci-lint run`; updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/69
2019-06-20 11:30:55 +00:00
golangci-lint: install-golangci-lint
Makefile: suppress false positives for golangci-lint on nil pointer dereference
2020-05-07 16:40:53 +00:00
golangci-lint run --exclude '(SA4003|SA1019|SA5011):' -D errcheck -D structcheck --timeout 2m
Makefile: add `make golangci-lint` rule for running `golangci-lint run`; updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/69
2019-06-20 11:30:55 +00:00
install-golangci-lint:
bumped golangci-lint to the latest 1.43 (#1781)
2021-11-04 09:34:08 +00:00
which golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin v1.43.0
Makefile: add `make docs-sync` command for syncing docs contents
2020-06-02 16:12:07 +00:00
Add `make check-licenses` rule for the ability to manually check licenses in vendored dependencies This is a follow-up for c687536956c6ad820bb6cbb33e1d1e02dfe7c844
2021-05-10 08:54:35 +00:00
install-wwhrd:
which wwhrd || GO111MODULE=off go get github.com/frapposelli/wwhrd
check-licenses: install-wwhrd
wwhrd check -f .wwhrd.yml
docs: update docs ordering and formatting (#1192) The major change is adding `sort` directive to docs. For those docs which are copied from internal packages `sort` is added via makefile command. For the rest it is added manually since they're updated manually as well. The rest of changes is connected with markdown formatting. For example, changing headers in some files (`##` => `#`) makes navigation on .github.io to look better. This especially useful for `changelog` docs. Table of contents for `vmctl` is dropped, since we already have it autogenerated on .github.io. No link changes expected. The corresponding PR to `cluster` branch will be made in follow-up PR.
2021-04-07 10:39:16 +00:00
copy-docs:
echo "---\nsort: ${ORDER}\n---\n" > ${DST}
cat ${SRC} >> ${DST}
# Copies docs for all components and adds the order tag.
# Cluster docs are supposed to be ordered as 9th.
# For The rest of docs is ordered manually.t
Makefile: add `make docs-sync` command for syncing docs contents
2020-06-02 16:12:07 +00:00
docs-sync:
Docs review (#1330) * re-order components by prioritizing Cluster-VictoriaMetrics.md * drop Home.md since it just duplicates other links
2021-05-26 09:28:58 +00:00
SRC=README.md DST=docs/Cluster-VictoriaMetrics.md ORDER=2 $(MAKE) copy-docs
SRC=app/vmagent/README.md DST=docs/vmagent.md ORDER=3 $(MAKE) copy-docs
SRC=app/vmalert/README.md DST=docs/vmalert.md ORDER=4 $(MAKE) copy-docs
SRC=app/vmauth/README.md DST=docs/vmauth.md ORDER=5 $(MAKE) copy-docs
SRC=app/vmbackup/README.md DST=docs/vmbackup.md ORDER=6 $(MAKE) copy-docs
SRC=app/vmrestore/README.md DST=docs/vmrestore.md ORDER=7 $(MAKE) copy-docs
SRC=app/vmctl/README.md DST=docs/vmctl.md ORDER=8 $(MAKE) copy-docs
SRC=app/vmgateway/README.md DST=docs/vmgateway.md ORDER=9 $(MAKE) copy-docs
SRC=app/vmbackupmanager/README.md DST=docs/vmbackupmanager.md ORDER=10 $(MAKE) copy-docs
Reference in a new issue Copy permalink