Hanzo DevandGitHub
fe4bfd3cf4
* debrand: signoz/SigNoz/SIGNOZ -> o11y/O11y/O11Y across the tree Rename all SigNoz *branding* to O11y in file contents, file/dir names, package names, env vars, config keys, comments, docs, SDK code, and the ClickHouse schema identifiers the querier reads. Collector dependency: - Repoint github.com/hanzoai/signoz-otel-collector -> github.com/hanzoai/otel-collector and bump v0.144.6 -> v0.144.7 (go.mod + go.sum reconciled via go mod tidy). Internal package paths also debranded upstream: signozschemamigrator -> o11yschemamigrator, signozlogspipelineprocessor -> o11ylogspipelineprocessor. - Fix: v0.144.7 dropped otelconst.DistributedFieldKeysTable from the collector's public constants; pin FieldKeysTable = "distributed_field_keys" locally in pkg/telemetrymetadata/tables.go. Package/dir renames (package decl + all importers): pkg/apiserver/signozapiserver -> o11yapiserver, plus signozalertmanager, signozauthzapi, signozglobal, signozquerier, signozruler, and pkg/signoz -> pkg/o11y. Schema (read plane): signoz_traces/metrics/logs/metadata/analytics/meter and signoz_index_v3/index_v2/error_index_v2/spans (+ distributed_*) -> o11y_*. Data-preserving cutover migration added: deploy/clickhouse/migrations/0001_rename_signoz_to_o11y.sql (metadata-only RENAME DATABASE/TABLE, no drop/recreate). Preserved (attribution / external / wire contracts): - LICENSE + NOTICE verbatim (incl. "software from SigNoz", "Copyright ... SigNoz Inc."). - Upstream github.com/SigNoz/* repo URLs + @SigNoz/* CODEOWNERS teams. - Billing resource-attribute regex "signoz.workspace.*" (external wire contract). go build ./pkg/... ./cmd/... = 0; gofmt clean; renamed+schema pkg tests pass. * o11y: bump collector to v0.144.8 (o11y_* physical schema writer) + lockstep deploy plan Collector v0.144.8's schema-migrator + exporters now CREATE/WRITE the same o11y_* physical databases/tables the querier reads and the RENAME migration (0001_rename_signoz_to_o11y.sql) targets. Cross-checked byte-identical: writer DB set == migration target DB set (6); writer prefixed-table set == migration target table set (8); o11y querier reads and cloud reads are subsets of that set. Zero table-name mismatches between writer, readers, and migration. Collector go.mod unchanged between v0.144.7 and v0.144.8 (identical go.mod hash) — pure source rename, no module-graph change. Adds deploy/clickhouse/DEPLOY_signoz_to_o11y_cutover.md: the lockstep order (collector v0.144.8 -> RENAME migration -> o11y+cloud readers) with a fresh/scratch-ClickHouse pre-flight (create via migrator, emit trace+metric, query back) and rollback. Ships together or telemetry blackholes. go build ./pkg/... ./cmd/community = 0.
240 lines
11 KiB
Makefile
240 lines
11 KiB
Makefile
##############################################################
|
|
# variables
|
|
##############################################################
|
|
SHELL := /bin/bash
|
|
SRC ?= $(shell pwd)
|
|
NAME ?= o11y
|
|
OS ?= $(shell uname -s | tr '[A-Z]' '[a-z]')
|
|
ARCH ?= $(shell uname -m | sed 's/x86_64/amd64/g' | sed 's/aarch64/arm64/g')
|
|
COMMIT_SHORT_SHA ?= $(shell git rev-parse --short HEAD)
|
|
BRANCH_NAME ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
|
|
VERSION ?= $(BRANCH_NAME)-$(COMMIT_SHORT_SHA)
|
|
TIMESTAMP ?= $(shell date -u +"%Y-%m-%dT%H:%M:%SZ")
|
|
ARCHS ?= amd64 arm64
|
|
TARGET_DIR ?= $(shell pwd)/target
|
|
|
|
ZEUS_URL ?= https://api.o11y.hanzo.ai
|
|
GO_BUILD_LDFLAG_ZEUS_URL = -X github.com/hanzoai/o11y/ee/zeus.url=$(ZEUS_URL)
|
|
LICENSE_URL ?= https://license.o11y.hanzo.ai
|
|
GO_BUILD_LDFLAG_LICENSE_HANZO_IO = -X github.com/hanzoai/o11y/ee/zeus.deprecatedURL=$(LICENSE_URL)
|
|
|
|
GO_BUILD_VERSION_LDFLAGS = -X github.com/hanzoai/o11y/pkg/version.version=$(VERSION) -X github.com/hanzoai/o11y/pkg/version.hash=$(COMMIT_SHORT_SHA) -X github.com/hanzoai/o11y/pkg/version.time=$(TIMESTAMP) -X github.com/hanzoai/o11y/pkg/version.branch=$(BRANCH_NAME)
|
|
GO_BUILD_ARCHS_COMMUNITY = $(addprefix go-build-community-,$(ARCHS))
|
|
GO_BUILD_CONTEXT_COMMUNITY = $(SRC)/cmd/community
|
|
GO_BUILD_LDFLAGS_COMMUNITY = $(GO_BUILD_VERSION_LDFLAGS) -X github.com/hanzoai/o11y/pkg/version.variant=community
|
|
GO_BUILD_ARCHS_ENTERPRISE = $(addprefix go-build-enterprise-,$(ARCHS))
|
|
GO_BUILD_ARCHS_ENTERPRISE_RACE = $(addprefix go-build-enterprise-race-,$(ARCHS))
|
|
GO_BUILD_CONTEXT_ENTERPRISE = $(SRC)/cmd/enterprise
|
|
GO_BUILD_LDFLAGS_ENTERPRISE = $(GO_BUILD_VERSION_LDFLAGS) -X github.com/hanzoai/o11y/pkg/version.variant=enterprise $(GO_BUILD_LDFLAG_ZEUS_URL) $(GO_BUILD_LDFLAG_LICENSE_HANZO_IO)
|
|
|
|
DOCKER_BUILD_ARCHS_COMMUNITY = $(addprefix docker-build-community-,$(ARCHS))
|
|
DOCKERFILE_COMMUNITY = $(SRC)/cmd/community/Dockerfile
|
|
DOCKER_REGISTRY_COMMUNITY ?= ghcr.io/hanzoai/o11y-community
|
|
DOCKER_BUILD_ARCHS_ENTERPRISE = $(addprefix docker-build-enterprise-,$(ARCHS))
|
|
DOCKERFILE_ENTERPRISE = $(SRC)/cmd/enterprise/Dockerfile
|
|
DOCKER_REGISTRY_ENTERPRISE ?= ghcr.io/hanzoai/o11y
|
|
JS_BUILD_CONTEXT = $(SRC)/frontend
|
|
|
|
##############################################################
|
|
# directories
|
|
##############################################################
|
|
$(TARGET_DIR):
|
|
mkdir -p $(TARGET_DIR)
|
|
|
|
##############################################################
|
|
# common commands
|
|
##############################################################
|
|
.PHONY: help
|
|
help: ## Displays help.
|
|
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n\nTargets:\n"} /^[a-z0-9A-Z_-]+:.*?##/ { printf " \033[36m%-40s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
|
|
|
|
##############################################################
|
|
# devenv commands
|
|
##############################################################
|
|
.PHONY: devenv-clickhouse
|
|
devenv-clickhouse: ## Run clickhouse in devenv
|
|
@cd .devenv/docker/clickhouse; \
|
|
docker compose -f compose.yaml up -d
|
|
|
|
.PHONY: devenv-postgres
|
|
devenv-postgres: ## Run postgres in devenv
|
|
@cd .devenv/docker/postgres; \
|
|
docker compose -f compose.yaml up -d
|
|
|
|
.PHONY: devenv-otel-collector
|
|
devenv-otel-collector: ## Run otel-collector in devenv (requires datastore to be running)
|
|
@cd .devenv/docker/otel-collector; \
|
|
docker compose -f compose.yaml up -d
|
|
|
|
.PHONY: devenv-up
|
|
devenv-up: devenv-clickhouse devenv-otel-collector ## Start both datastore and otel-collector for local development
|
|
@echo "Development environment is ready!"
|
|
@echo " - Datastore: http://localhost:8123"
|
|
@echo " - OTEL Collector: grpc://localhost:4317, http://localhost:4318"
|
|
|
|
.PHONY: devenv-clickhouse-clean
|
|
devenv-clickhouse-clean: ## Clean all ClickHouse data from filesystem
|
|
@echo "Removing ClickHouse data..."
|
|
@rm -rf .devenv/docker/clickhouse/fs/tmp/*
|
|
@echo "ClickHouse data cleaned!"
|
|
|
|
##############################################################
|
|
# go commands
|
|
##############################################################
|
|
.PHONY: go-run-enterprise
|
|
go-run-enterprise: ## Runs the enterprise go backend server
|
|
@HANZO_INSTRUMENTATION_LOGS_LEVEL=debug \
|
|
HANZO_SQLSTORE_SQLITE_PATH=o11y.db \
|
|
HANZO_WEB_ENABLED=false \
|
|
HANZO_TOKENIZER_JWT_SECRET=secret \
|
|
HANZO_ALERTMANAGER_PROVIDER=o11y \
|
|
HANZO_TELEMETRYSTORE_PROVIDER=datastore \
|
|
HANZO_TELEMETRYSTORE_DATASTORE_DSN=tcp://127.0.0.1:9000 \
|
|
HANZO_TELEMETRYSTORE_DATASTORE_CLUSTER=cluster \
|
|
go run -race \
|
|
$(GO_BUILD_CONTEXT_ENTERPRISE)/*.go server
|
|
|
|
.PHONY: go-test
|
|
go-test: ## Runs go unit tests
|
|
@go test -race ./...
|
|
|
|
.PHONY: go-run-community
|
|
go-run-community: ## Runs the community go backend server
|
|
@HANZO_INSTRUMENTATION_LOGS_LEVEL=debug \
|
|
HANZO_SQLSTORE_SQLITE_PATH=o11y.db \
|
|
HANZO_WEB_ENABLED=false \
|
|
HANZO_TOKENIZER_JWT_SECRET=secret \
|
|
HANZO_ALERTMANAGER_PROVIDER=o11y \
|
|
HANZO_TELEMETRYSTORE_PROVIDER=datastore \
|
|
HANZO_TELEMETRYSTORE_DATASTORE_DSN=tcp://127.0.0.1:9000 \
|
|
HANZO_TELEMETRYSTORE_DATASTORE_CLUSTER=cluster \
|
|
go run -race \
|
|
$(GO_BUILD_CONTEXT_COMMUNITY)/*.go server
|
|
|
|
.PHONY: go-build-community $(GO_BUILD_ARCHS_COMMUNITY)
|
|
go-build-community: ## Builds the go backend server for community
|
|
go-build-community: $(GO_BUILD_ARCHS_COMMUNITY)
|
|
$(GO_BUILD_ARCHS_COMMUNITY): go-build-community-%: $(TARGET_DIR)
|
|
@mkdir -p $(TARGET_DIR)/$(OS)-$*
|
|
@echo ">> building binary $(TARGET_DIR)/$(OS)-$*/$(NAME)-community"
|
|
@if [ $* = "arm64" ]; then \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_COMMUNITY) -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME)-community -ldflags "-s -w $(GO_BUILD_LDFLAGS_COMMUNITY)"; \
|
|
else \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_COMMUNITY) -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME)-community -ldflags "-s -w $(GO_BUILD_LDFLAGS_COMMUNITY)"; \
|
|
fi
|
|
|
|
|
|
.PHONY: go-build-enterprise $(GO_BUILD_ARCHS_ENTERPRISE)
|
|
go-build-enterprise: ## Builds the go backend server for enterprise
|
|
go-build-enterprise: $(GO_BUILD_ARCHS_ENTERPRISE)
|
|
$(GO_BUILD_ARCHS_ENTERPRISE): go-build-enterprise-%: $(TARGET_DIR)
|
|
@mkdir -p $(TARGET_DIR)/$(OS)-$*
|
|
@echo ">> building binary $(TARGET_DIR)/$(OS)-$*/$(NAME)"
|
|
@if [ $* = "arm64" ]; then \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_ENTERPRISE) -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME) -ldflags "-s -w $(GO_BUILD_LDFLAGS_ENTERPRISE)"; \
|
|
else \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_ENTERPRISE) -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME) -ldflags "-s -w $(GO_BUILD_LDFLAGS_ENTERPRISE)"; \
|
|
fi
|
|
|
|
.PHONY: go-build-enterprise-race $(GO_BUILD_ARCHS_ENTERPRISE_RACE)
|
|
go-build-enterprise-race: ## Builds the go backend server for enterprise with race
|
|
go-build-enterprise-race: $(GO_BUILD_ARCHS_ENTERPRISE_RACE)
|
|
$(GO_BUILD_ARCHS_ENTERPRISE_RACE): go-build-enterprise-race-%: $(TARGET_DIR)
|
|
@mkdir -p $(TARGET_DIR)/$(OS)-$*
|
|
@echo ">> building binary $(TARGET_DIR)/$(OS)-$*/$(NAME)"
|
|
@if [ $* = "arm64" ]; then \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_ENTERPRISE) -race -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME) -ldflags "-s -w $(GO_BUILD_LDFLAGS_ENTERPRISE)"; \
|
|
else \
|
|
GOARCH=$* GOOS=$(OS) go build -C $(GO_BUILD_CONTEXT_ENTERPRISE) -race -tags timetzdata -o $(TARGET_DIR)/$(OS)-$*/$(NAME) -ldflags "-s -w $(GO_BUILD_LDFLAGS_ENTERPRISE)"; \
|
|
fi
|
|
|
|
##############################################################
|
|
# js commands
|
|
##############################################################
|
|
.PHONY: js-build
|
|
js-build: ## Builds the js frontend
|
|
@echo ">> building js frontend"
|
|
@cd $(JS_BUILD_CONTEXT) && CI=1 pnpm install && pnpm build
|
|
|
|
##############################################################
|
|
# docker commands
|
|
##############################################################
|
|
.PHONY: docker-build-community $(DOCKER_BUILD_ARCHS_COMMUNITY)
|
|
docker-build-community: ## Builds the docker image for community
|
|
docker-build-community: $(DOCKER_BUILD_ARCHS_COMMUNITY)
|
|
$(DOCKER_BUILD_ARCHS_COMMUNITY): docker-build-community-%: go-build-community-% js-build
|
|
@echo ">> building docker image for $(NAME)-community"
|
|
@docker build -t "$(DOCKER_REGISTRY_COMMUNITY):$(VERSION)-$*" \
|
|
--build-arg TARGETARCH="$*" \
|
|
-f $(DOCKERFILE_COMMUNITY) $(SRC)
|
|
|
|
.PHONY: docker-buildx-community
|
|
docker-buildx-community: ## Builds the docker image for community using buildx
|
|
docker-buildx-community: go-build-community js-build
|
|
@echo ">> building docker image for $(NAME)-community"
|
|
@docker buildx build --file $(DOCKERFILE_COMMUNITY) \
|
|
--progress plain \
|
|
--platform linux/arm64,linux/amd64 \
|
|
--push \
|
|
--tag $(DOCKER_REGISTRY_COMMUNITY):$(VERSION) $(SRC)
|
|
|
|
.PHONY: docker-build-enterprise $(DOCKER_BUILD_ARCHS_ENTERPRISE)
|
|
docker-build-enterprise: ## Builds the docker image for enterprise
|
|
docker-build-enterprise: $(DOCKER_BUILD_ARCHS_ENTERPRISE)
|
|
$(DOCKER_BUILD_ARCHS_ENTERPRISE): docker-build-enterprise-%: go-build-enterprise-% js-build
|
|
@echo ">> building docker image for $(NAME)"
|
|
@docker build -t "$(DOCKER_REGISTRY_ENTERPRISE):$(VERSION)-$*" \
|
|
--build-arg TARGETARCH="$*" \
|
|
-f $(DOCKERFILE_ENTERPRISE) $(SRC)
|
|
|
|
.PHONY: docker-buildx-enterprise
|
|
docker-buildx-enterprise: ## Builds the docker image for enterprise using buildx
|
|
docker-buildx-enterprise: go-build-enterprise js-build
|
|
@echo ">> building docker image for $(NAME)"
|
|
@docker buildx build --file $(DOCKERFILE_ENTERPRISE) \
|
|
--progress plain \
|
|
--platform linux/arm64,linux/amd64 \
|
|
--push \
|
|
--tag $(DOCKER_REGISTRY_ENTERPRISE):$(VERSION) $(SRC)
|
|
|
|
##############################################################
|
|
# python commands
|
|
##############################################################
|
|
.PHONY: py-fmt
|
|
py-fmt: ## Run ruff format across the shared tests project
|
|
@cd tests && uv run ruff format .
|
|
|
|
.PHONY: py-lint
|
|
py-lint: ## Run ruff check across the shared tests project
|
|
@cd tests && uv run ruff check --fix .
|
|
|
|
.PHONY: py-test-setup
|
|
py-test-setup: ## Bring up the shared O11y backend used by integration and e2e tests
|
|
@cd tests && uv run pytest --basetemp=./tmp/ -vv --reuse --capture=no integration/bootstrap/setup.py::test_setup
|
|
|
|
.PHONY: py-test-teardown
|
|
py-test-teardown: ## Tear down the shared O11y backend
|
|
@cd tests && uv run pytest --basetemp=./tmp/ -vv --teardown --capture=no integration/bootstrap/setup.py::test_teardown
|
|
|
|
.PHONY: py-test
|
|
py-test: ## Runs integration tests
|
|
@cd tests && uv run pytest --basetemp=./tmp/ -vv --capture=no integration/tests/
|
|
|
|
.PHONY: py-clean
|
|
py-clean: ## Clear all pycache and pytest cache from tests directory recursively
|
|
@echo ">> cleaning python cache files from tests directory"
|
|
@find tests -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
|
|
@find tests -type d -name .pytest_cache -exec rm -rf {} + 2>/dev/null || true
|
|
@find tests -type f -name "*.pyc" -delete 2>/dev/null || true
|
|
@find tests -type f -name "*.pyo" -delete 2>/dev/null || true
|
|
@echo ">> python cache cleaned"
|
|
|
|
|
|
##############################################################
|
|
# generate commands
|
|
##############################################################
|
|
.PHONY: gen-mocks
|
|
gen-mocks:
|
|
@echo ">> Generating mocks"
|
|
@mockery --config .mockery.yml
|