Skip to content

Commit

Permalink
exp: Rename jaeger-v2 binary to just jaeger (#4918)
Browse files Browse the repository at this point in the history
## Which problem is this PR solving?
- Part of #4843

## Description of the changes
- Per discussion with maintainers, rename `jaeger-v2` binary to just
`jaeger`.
- Motivation:
- In the long run it's not going to be convenient for users to refer to
`jaeger-v2`, projects typically don't do that
  - The name `jaeger` is currently unused (e.g. in Docker Hub)
- Since we're combining all deployment units into one binary, `jaeger`
name is quite appropriate

## How was this change tested?
```
$ go run -tags=ui ./cmd/jaeger
```
`grep -ri jaeger-v2 .` does not find any references (except in the
changelog)

---------

Signed-off-by: Yuri Shkuro <github@ysh.us>
  • Loading branch information
yurishkuro committed Nov 3, 2023
1 parent 5e91855 commit 080b77f
Show file tree
Hide file tree
Showing 33 changed files with 35 additions and 31 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci-all-in-one-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ jobs:
if: github.ref_name != 'main'
run: bash scripts/build-all-in-one-image.sh pr-only

- name: Build and test jaeger-v2 as all-in-one
- name: Build and test jaeger (v2) as all-in-one
if: github.ref_name != 'main'
run: BINARY=jaeger-v2 bash scripts/build-all-in-one-image.sh pr-only
run: BINARY=jaeger bash scripts/build-all-in-one-image.sh pr-only

- name: Build, test, and publish all-in-one image
if: github.ref_name == 'main'
Expand Down
14 changes: 7 additions & 7 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -263,10 +263,10 @@ BIN_PATH = ./cmd/$(BIN_NAME)
_build-a-binary-%:
$(GOBUILD) $(DISABLE_OPTIMIZATIONS) $(GO_TAGS) -o $(BIN_PATH)/$(BIN_NAME)$(SUFFIX)-$(GOOS)-$(GOARCH) $(BUILD_INFO) $(BIN_PATH)

.PHONY: build-jaeger-v2
build-jaeger-v2: BIN_NAME = jaeger-v2
build-jaeger-v2: GO_TAGS = -tags ui
build-jaeger-v2: build-ui _build-a-binary-jaeger-v2$(SUFFIX)-$(GOOS)-$(GOARCH)
.PHONY: build-jaeger
build-jaeger: BIN_NAME = jaeger
build-jaeger: GO_TAGS = -tags ui
build-jaeger: build-ui _build-a-binary-jaeger$(SUFFIX)-$(GOOS)-$(GOARCH)

.PHONY: build-all-in-one
build-all-in-one: BIN_NAME = all-in-one
Expand Down Expand Up @@ -346,7 +346,7 @@ _prepare-winres:
$(MAKE) _prepare-winres-helper NAME="Jaeger Ingester" PKGPATH="cmd/ingester"
$(MAKE) _prepare-winres-helper NAME="Jaeger Remote Storage" PKGPATH="cmd/remote-storage"
$(MAKE) _prepare-winres-helper NAME="Jaeger All-In-One" PKGPATH="cmd/all-in-one"
$(MAKE) _prepare-winres-helper NAME="Jaeger V2" PKGPATH="cmd/jaeger-v2"
$(MAKE) _prepare-winres-helper NAME="Jaeger V2" PKGPATH="cmd/jaeger"
$(MAKE) _prepare-winres-helper NAME="Jaeger Tracegen" PKGPATH="cmd/tracegen"
$(MAKE) _prepare-winres-helper NAME="Jaeger Anonymizer" PKGPATH="cmd/anonymizer"
$(MAKE) _prepare-winres-helper NAME="Jaeger ES-Index-Cleaner" PKGPATH="cmd/es-index-cleaner"
Expand Down Expand Up @@ -392,7 +392,7 @@ _build-platform-binaries: build-agent \
build-collector \
build-query \
build-ingester \
build-jaeger-v2 \
build-jaeger \
build-remote-storage \
build-examples \
build-tracegen \
Expand Down Expand Up @@ -500,7 +500,7 @@ changelog:
draft-release:
./scripts/draft-release.py

.PHONY: install-test-tools
.PHONY: install-test-tools
install-test-tools:
$(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.1
$(GO) install mvdan.cc/gofumpt@latest
Expand Down
2 changes: 0 additions & 2 deletions cmd/jaeger-v2/.gitignore

This file was deleted.

2 changes: 2 additions & 0 deletions cmd/jaeger/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
jaeger-*-*
jaeger
12 changes: 6 additions & 6 deletions cmd/jaeger-v2/Dockerfile → cmd/jaeger/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ EXPOSE 16686

# Default configuration file for setting sampling strategies
# ENV SAMPLING_STRATEGIES_FILE=/etc/jaeger/sampling_strategies.json

COPY jaeger-v2-linux-$TARGETARCH /go/bin/jaeger-v2-linux
# COPY sampling_strategies.json /etc/jaeger/

COPY jaeger-linux-$TARGETARCH /go/bin/jaeger-linux

VOLUME ["/tmp"]
ENTRYPOINT ["/go/bin/jaeger-v2-linux"]
ENTRYPOINT ["/go/bin/jaeger-linux"]
USER ${USER_UID}

FROM $debug_image AS debug
Expand Down Expand Up @@ -84,10 +84,10 @@ EXPOSE 12345

# Default configuration file for setting sampling strategies
# ENV SAMPLING_STRATEGIES_FILE=/etc/jaeger/sampling_strategies.json

COPY jaeger-v2-debug-linux-$TARGETARCH /go/bin/jaeger-v2-linux
# COPY sampling_strategies.json /etc/jaeger/

COPY jaeger-debug-linux-$TARGETARCH /go/bin/jaeger-linux

VOLUME ["/tmp"]
ENTRYPOINT ["/go/bin/dlv", "exec", "/go/bin/jaeger-v2-linux", "--headless", "--listen=:12345", "--api-version=2", "--accept-multiclient", "--log", "--"]
ENTRYPOINT ["/go/bin/dlv", "exec", "/go/bin/jaeger-linux", "--headless", "--listen=:12345", "--api-version=2", "--accept-multiclient", "--log", "--"]
USER ${USER_UID}
4 changes: 4 additions & 0 deletions cmd/jaeger/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# jaeger

This is experimental Jaeger V2 based on OpenTelemetry collector.
See https://github.com/jaegertracing/jaeger/issues/4843.
File renamed without changes.
2 changes: 1 addition & 1 deletion cmd/jaeger-v2/config.yaml → cmd/jaeger/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ extensions:
jaeger_query:
trace_storage: memstore
trace_storage_archive: memstore_archive
ui_config: ./cmd/jaeger-v2/config-ui.json
ui_config: ./cmd/jaeger/config-ui.json

jaeger_storage:
memory:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ import (
"go.opentelemetry.io/collector/service/telemetry"
"go.uber.org/zap/zapcore"

"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/exporters/storageexporter"
"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerquery"
"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerstorage"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/exporters/storageexporter"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerquery"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerstorage"
)

type configProvider struct {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ func Command() *cobra.Command {
}

info := component.BuildInfo{
Command: "jaeger-v2",
Command: "jaeger",
Description: description,
Version: version.Get().String(),
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ import (
"go.opentelemetry.io/collector/receiver"
"go.opentelemetry.io/collector/receiver/otlpreceiver"

"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/exporters/storageexporter"
"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerquery"
"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerstorage"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/exporters/storageexporter"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerquery"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerstorage"
)

func components() (otelcol.Factories, error) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import (
"go.opentelemetry.io/collector/pdata/ptrace"
"go.uber.org/zap"

"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerstorage"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerstorage"
"github.com/jaegertracing/jaeger/storage/spanstore"
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
"go.opentelemetry.io/collector/extension"
"go.uber.org/zap"

"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal/extension/jaegerstorage"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal/extension/jaegerstorage"
queryApp "github.com/jaegertracing/jaeger/cmd/query/app"
"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
"github.com/jaegertracing/jaeger/pkg/jtracer"
Expand Down
2 changes: 1 addition & 1 deletion cmd/jaeger-v2/main.go → cmd/jaeger/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"github.com/spf13/viper"

"github.com/jaegertracing/jaeger/cmd/internal/docs"
"github.com/jaegertracing/jaeger/cmd/jaeger-v2/internal"
"github.com/jaegertracing/jaeger/cmd/jaeger/internal"
"github.com/jaegertracing/jaeger/pkg/config"
"github.com/jaegertracing/jaeger/pkg/version"
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/query/app/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ type QueryOptionsStaticAssets struct {
LogAccess bool `valid:"optional" mapstructure:"log_access"`
}

// QueryOptionsBase holds configuration for query service shared with jaeger-v2
// QueryOptionsBase holds configuration for query service shared with jaeger(v2)
type QueryOptionsBase struct {
// BasePath is the base path for all HTTP routes
BasePath string
Expand Down
2 changes: 1 addition & 1 deletion plugin/storage/memory/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func NewFactory() *Factory {
return &Factory{}
}

// NewFactoryWithConfig is used from jaeger-v2.
// NewFactoryWithConfig is used from jaeger(v2).
func NewFactoryWithConfig(
cfg config.Configuration,
metricsFactory metrics.Factory,
Expand Down
2 changes: 1 addition & 1 deletion scripts/build-all-in-one-image.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ else
is_pull_request=false
fi

# alternative can be jaeger-v2
# alternative can be jaeger (the v2 binary)
BINARY=${BINARY:-'all-in-one'}

# Set default GOARCH variable to the host GOARCH, the target architecture can
Expand Down

0 comments on commit 080b77f

Please sign in to comment.