Log version/build info on startup (#4723)

## Which problem is this PR solving?
- When users ask questions and include logs, it's difficult to tell
which version of the binary they are running, especially when they use
the `latest` Docker tag.

## Description of the changes
- Log build / version info on startup in all binaries
- Move sub-commands into cmd/internal, to not confuse them with the
actual binaries

## How was this change tested?
```
$ go run ./cmd/tracegen
2023-09-04T11:24:55.559-0400	INFO	tracegen/main.go:56	application version: git-commit=, git-version=, build-date=

$ go run ./cmd/all-in-one
2023/09/04 11:24:31 application version: git-commit=, git-version=, build-date=
```

## Checklist
- [ ] I have read
https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
- [ ] I have signed all commits
- [ ] I have added unit tests for the new functionality
- [ ] I have run lint and test steps successfully
  - for `jaeger`: `make lint test`
  - for `jaeger-ui`: `yarn lint` and `yarn test`

---------

Signed-off-by: Yuri Shkuro <[email protected]>

.gitignore

@@ -35,10 +35,6 @@ cmd/query/query
 cmd/query/query-*
 cmd/tracegen/tracegen
 cmd/tracegen/tracegen-*
-cmd/docs/*.md
-cmd/docs/*.rst
-cmd/docs/*.1
-cmd/docs/*.yaml
 crossdock/crossdock-*
 run-crossdock.log
 proto-gen/.patched-otel-proto/

cmd/agent/app/reporter/flags.go

@@ -22,7 +22,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/jaegertracing/jaeger/cmd/all-in-one/setupcontext"
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
 )
 
 const (

cmd/agent/main.go

@@ -27,9 +27,9 @@ import (
 	"github.com/jaegertracing/jaeger/cmd/agent/app"
 	"github.com/jaegertracing/jaeger/cmd/agent/app/reporter"
 	"github.com/jaegertracing/jaeger/cmd/agent/app/reporter/grpc"
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/flags"
-	"github.com/jaegertracing/jaeger/cmd/status"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/internal/metrics/expvar"
 	"github.com/jaegertracing/jaeger/internal/metrics/fork"
 	"github.com/jaegertracing/jaeger/pkg/config"

cmd/all-in-one/main.go

@@ -33,12 +33,12 @@ import (
 	"github.com/jaegertracing/jaeger/cmd/all-in-one/setupcontext"
 	collectorApp "github.com/jaegertracing/jaeger/cmd/collector/app"
 	collectorFlags "github.com/jaegertracing/jaeger/cmd/collector/app/flags"
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/env"
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/env"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	queryApp "github.com/jaegertracing/jaeger/cmd/query/app"
 	"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
-	"github.com/jaegertracing/jaeger/cmd/status"
 	"github.com/jaegertracing/jaeger/internal/metrics/expvar"
 	"github.com/jaegertracing/jaeger/internal/metrics/fork"
 	"github.com/jaegertracing/jaeger/pkg/config"

cmd/collector/app/flags/flags.go

@@ -23,7 +23,7 @@ import (
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
 
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
 	"github.com/jaegertracing/jaeger/pkg/config/corscfg"
 	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"

cmd/collector/app/span_handler_builder_test.go

@@ -23,7 +23,7 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/jaegertracing/jaeger/cmd/collector/app/flags"
-	cmdFlags "github.com/jaegertracing/jaeger/cmd/flags"
+	cmdFlags "github.com/jaegertracing/jaeger/cmd/internal/flags"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"

cmd/collector/main.go

@@ -28,10 +28,10 @@ import (
 
 	"github.com/jaegertracing/jaeger/cmd/collector/app"
 	"github.com/jaegertracing/jaeger/cmd/collector/app/flags"
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/env"
-	cmdFlags "github.com/jaegertracing/jaeger/cmd/flags"
-	"github.com/jaegertracing/jaeger/cmd/status"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/env"
+	cmdFlags "github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/internal/metrics/expvar"
 	"github.com/jaegertracing/jaeger/internal/metrics/fork"
 	"github.com/jaegertracing/jaeger/pkg/config"

cmd/ingester/main.go

@@ -25,12 +25,12 @@ import (
 	_ "go.uber.org/automaxprocs"
 	"go.uber.org/zap"
 
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/env"
-	"github.com/jaegertracing/jaeger/cmd/flags"
 	"github.com/jaegertracing/jaeger/cmd/ingester/app"
 	"github.com/jaegertracing/jaeger/cmd/ingester/app/builder"
-	"github.com/jaegertracing/jaeger/cmd/status"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/env"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
 	"github.com/jaegertracing/jaeger/pkg/version"

cmd/internal/docs/.gitignore

@@ -0,0 +1,4 @@
+*.md
+*.rst
+*.1
+*.yaml

cmd/flags/admin_test.go → cmd/internal/flags/admin_test.go

@@ -35,7 +35,7 @@ import (
 	"github.com/jaegertracing/jaeger/ports"
 )
 
-var testCertKeyLocation = "../../pkg/config/tlscfg/testdata"
+var testCertKeyLocation = "../../../pkg/config/tlscfg/testdata"
 
 func TestAdminServerHandlesPortZero(t *testing.T) {
 	adminServer := NewAdminServer(":0")

cmd/query/app/server_test.go

@@ -33,7 +33,7 @@ import (
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/credentials/insecure"
 
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
 	"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
 	"github.com/jaegertracing/jaeger/internal/grpctest"
 	"github.com/jaegertracing/jaeger/model"

cmd/query/app/token_propagation_test.go

@@ -26,7 +26,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.uber.org/zap/zaptest"
 
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
 	"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
 	"github.com/jaegertracing/jaeger/pkg/bearertoken"
 	"github.com/jaegertracing/jaeger/pkg/config"

cmd/query/main.go

@@ -26,12 +26,12 @@ import (
 	_ "go.uber.org/automaxprocs"
 	"go.uber.org/zap"
 
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/env"
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/env"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/cmd/query/app"
 	"github.com/jaegertracing/jaeger/cmd/query/app/querysvc"
-	"github.com/jaegertracing/jaeger/cmd/status"
 	"github.com/jaegertracing/jaeger/pkg/bearertoken"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/jtracer"

cmd/remote-storage/app/server_test.go

@@ -30,7 +30,7 @@ import (
 	"google.golang.org/grpc/credentials"
 	"google.golang.org/grpc/credentials/insecure"
 
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
 	"github.com/jaegertracing/jaeger/internal/grpctest"
 	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 	"github.com/jaegertracing/jaeger/pkg/healthcheck"

cmd/remote-storage/main.go

@@ -24,11 +24,11 @@ import (
 	_ "go.uber.org/automaxprocs"
 	"go.uber.org/zap"
 
-	"github.com/jaegertracing/jaeger/cmd/docs"
-	"github.com/jaegertracing/jaeger/cmd/env"
-	"github.com/jaegertracing/jaeger/cmd/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/docs"
+	"github.com/jaegertracing/jaeger/cmd/internal/env"
+	"github.com/jaegertracing/jaeger/cmd/internal/flags"
+	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/cmd/remote-storage/app"
-	"github.com/jaegertracing/jaeger/cmd/status"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"

cmd/tracegen/main.go

@@ -36,6 +36,7 @@ import (
 
 	"github.com/jaegertracing/jaeger/internal/jaegerclientenv2otel"
 	"github.com/jaegertracing/jaeger/internal/tracegen"
+	"github.com/jaegertracing/jaeger/pkg/version"
 )
 
 func main() {
@@ -52,6 +53,8 @@ func main() {
 	cfg.Flags(fs)
 	flag.Parse()
 
+	logger.Info(version.Get().String())
+
 	otel.SetTextMapPropagator(propagation.TraceContext{})
 	jaegerclientenv2otel.MapJaegerToOtelEnvVars(logger)
 

pkg/version/build.go

@@ -14,7 +14,11 @@
 
 package version
 
-import "github.com/jaegertracing/jaeger/pkg/metrics"
+import (
+	"fmt"
+
+	"github.com/jaegertracing/jaeger/pkg/metrics"
+)
 
 var (
 	// commitFromGit is a constant representing the source version that
@@ -27,14 +31,14 @@ var (
 	date string
 )
 
-// Info holds build information
+// Info holds build information.
 type Info struct {
 	GitCommit  string `json:"gitCommit"`
 	GitVersion string `json:"gitVersion"`
 	BuildDate  string `json:"buildDate"`
 }
 
-// InfoMetrics hold metrics about build information
+// InfoMetrics hold a gauge whose tags include build information.
 type InfoMetrics struct {
 	BuildInfo metrics.Gauge `metric:"build_info"`
 }
@@ -62,3 +66,10 @@ func NewInfoMetrics(metricsFactory metrics.Factory) *InfoMetrics {
 
 	return &info
 }
+
+func (i Info) String() string {
+	return fmt.Sprintf(
+		"application version: git-commit=%s, git-version=%s, build-date=%s",
+		i.GitCommit, i.GitVersion, i.BuildDate,
+	)
+}

pkg/version/command.go

@@ -17,18 +17,20 @@ package version
 import (
 	"encoding/json"
 	"fmt"
+	"log"
 
 	"github.com/spf13/cobra"
 )
 
 // Command creates version command
 func Command() *cobra.Command {
+	info := Get()
+	log.Println(info)
 	return &cobra.Command{
 		Use:   "version",
 		Short: "Print the version.",
 		Long:  `Print the version and build information.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
-			info := Get()
 			json, err := json.Marshal(info)
 			if err != nil {
 				return err