Merge branch 'main' into v2-reader

Signed-off-by: Mahad Zaryab <[email protected]>

.gitignore

@@ -42,7 +42,6 @@ cmd/tracegen/tracegen-*
 crossdock/crossdock-*
 
 run-crossdock.log
-proto-gen/.patched-otel-proto/
 __pycache__
 .asset-manifest.json
 deploy/

.golangci.yml

@@ -105,6 +105,9 @@ linters:
     # Checks usage of github.com/stretchr/testify.
     - testifylint
 
+    # Detects the possibility to use variables/constants from the Go standard library.
+    - usestdlibvars
+
     # TODO consider adding more linters, cf. https://olegk.dev/go-linters-configuration-the-right-version
 
 linters-settings:

.mockery.yaml

@@ -5,6 +5,12 @@ dir: "{{.InterfaceDir}}/mocks/"
 mockname: "{{.InterfaceName}}"
 filename: "{{.InterfaceName}}.go"
 boilerplate-file: .mockery.header.txt
+
+# Flags for future v3 compatibility.
+# See https://github.com/vektra/mockery/issues/848
+issue-845-fix: true
+resolve-type-alias: false
+
 packages:
   github.com/jaegertracing/jaeger/cmd/collector/app/sanitizer/cache:
     interfaces:

CHANGELOG.md

@@ -263,7 +263,7 @@ Dependencies upgrades only.
 
 #### 🚧 Experimental Features
 
-* Implement telemetery struct for v1 components initialization ([@Wise-Wizard](https://github.com/Wise-Wizard) in [#5695](https://github.com/jaegertracing/jaeger/pull/5695))
+* Implement telemetry struct for v1 components initialization ([@Wise-Wizard](https://github.com/Wise-Wizard) in [#5695](https://github.com/jaegertracing/jaeger/pull/5695))
 * Support default configs for storage backends ([@yurishkuro](https://github.com/yurishkuro) in [#5691](https://github.com/jaegertracing/jaeger/pull/5691))
 * Simplify configs organization ([@yurishkuro](https://github.com/yurishkuro) in [#5690](https://github.com/jaegertracing/jaeger/pull/5690))
 * Create metrics.factory adapter for otel metrics ([@Wise-Wizard](https://github.com/Wise-Wizard) in [#5661](https://github.com/jaegertracing/jaeger/pull/5661))

Makefile.Protobuf.mk

@@ -14,15 +14,15 @@
 # instead of the go_package's declared by the imported protof files.
 #
 
+DOCKER=docker
 DOCKER_PROTOBUF_VERSION=0.5.0
 DOCKER_PROTOBUF=jaegertracing/protobuf:$(DOCKER_PROTOBUF_VERSION)
-PROTOC := docker run --rm -u ${shell id -u} -v${PWD}:${PWD} -w${PWD} ${DOCKER_PROTOBUF} --proto_path=${PWD}
+PROTOC := ${DOCKER} run --rm -u ${shell id -u} -v${PWD}:${PWD} -w${PWD} ${DOCKER_PROTOBUF} --proto_path=${PWD}
 
 PATCHED_OTEL_PROTO_DIR = proto-gen/.patched-otel-proto
 
 PROTO_INCLUDES := \
 	-Iidl/proto/api_v2 \
-	-Iidl/proto/api_v3 \
 	-Imodel/proto/metrics \
 	-I/usr/include/github.com/gogo/protobuf
 
@@ -127,9 +127,18 @@ proto-zipkin:
 # Note that the .pb.go types must be generated into the same internal package $(API_V3_PATH)
 # where a manually defined traces.go file is located.
 API_V3_PATH=cmd/query/app/internal/api_v3
+API_V3_PATCHED_DIR=proto-gen/.patched/api_v3
+API_V3_PATCHED=$(API_V3_PATCHED_DIR)/query_service.proto
+.PHONY: patch-api-v3
+patch-api-v3:
+	mkdir -p $(API_V3_PATCHED_DIR)
+	cat idl/proto/api_v3/query_service.proto | \
+		$(SED) -f ./proto-gen/patch-api-v3.sed \
+		> $(API_V3_PATCHED)
+
 .PHONY: proto-api-v3
-proto-api-v3:
-	$(call proto_compile, $(API_V3_PATH), idl/proto/api_v3/query_service.proto, -Iidl/opentelemetry-proto)
+proto-api-v3: patch-api-v3
+	$(call proto_compile, $(API_V3_PATH), $(API_V3_PATCHED), -I$(API_V3_PATCHED_DIR) -Iidl/opentelemetry-proto)
 	@echo "🏗️  replace TracesData with internal custom type"
 	$(SED) -i 's/v1.TracesData/TracesData/g' $(API_V3_PATH)/query_service.pb.go
 	@echo "🏗️  remove OTEL import because we're not using any other OTLP types"

cmd/all-in-one/main.go

@@ -14,9 +14,7 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-	"go.opentelemetry.io/collector/config/configtelemetry"
-	"go.opentelemetry.io/otel/metric"
-	"go.opentelemetry.io/otel/metric/noop"
+	noopmetric "go.opentelemetry.io/otel/metric/noop"
 	_ "go.uber.org/automaxprocs"
 	"go.uber.org/zap"
 
@@ -33,17 +31,19 @@ import (
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/jtracer"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
-	"github.com/jaegertracing/jaeger/pkg/telemetery"
+	"github.com/jaegertracing/jaeger/pkg/telemetry"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"
 	"github.com/jaegertracing/jaeger/pkg/version"
 	metricsPlugin "github.com/jaegertracing/jaeger/plugin/metrics"
 	ss "github.com/jaegertracing/jaeger/plugin/sampling/strategyprovider"
 	"github.com/jaegertracing/jaeger/plugin/storage"
 	"github.com/jaegertracing/jaeger/ports"
 	"github.com/jaegertracing/jaeger/storage/dependencystore"
-	metricsstoreMetrics "github.com/jaegertracing/jaeger/storage/metricsstore/metrics"
 	"github.com/jaegertracing/jaeger/storage_v2/factoryadapter"
 	"github.com/jaegertracing/jaeger/storage_v2/spanstore"
+	"github.com/jaegertracing/jaeger/storage/metricsstore/metricstoremetrics"
+	"github.com/jaegertracing/jaeger/storage/spanstore"
+	"github.com/jaegertracing/jaeger/storage/spanstore/spanstoremetrics"
 )
 
 // all-in-one/main is a standalone full-stack jaeger backend, backed by a memory store
@@ -96,8 +96,16 @@ by default uses only in-memory database.`,
 				logger.Fatal("Failed to initialize tracer", zap.Error(err))
 			}
 
+			baseTelset := telemetry.Settings{
+				Logger:         svc.Logger,
+				TracerProvider: tracer.OTEL,
+				Metrics:        baseFactory,
+				MeterProvider:  noopmetric.NewMeterProvider(),
+				ReportStatus:   telemetry.HCAdapter(svc.HC()),
+			}
+
 			storageFactory.InitFromViper(v, logger)
-			if err := storageFactory.Initialize(baseFactory, logger); err != nil {
+			if err := storageFactory.Initialize(baseTelset.Metrics, baseTelset.Logger); err != nil {
 				logger.Fatal("Failed to init storage factory", zap.Error(err))
 			}
 
@@ -160,20 +168,13 @@ by default uses only in-memory database.`,
 				log.Fatal(err)
 			}
 
-			telset := telemetery.Setting{
-				Logger:         svc.Logger,
-				TracerProvider: tracer.OTEL,
-				Metrics:        queryMetricsFactory,
-				ReportStatus:   telemetery.HCAdapter(svc.HC()),
-				LeveledMeterProvider: func(_ configtelemetry.Level) metric.MeterProvider {
-					return noop.NewMeterProvider()
-				},
-			}
 			// query
+			queryTelset := baseTelset // copy
+			queryTelset.Metrics = queryMetricsFactory
 			querySrv := startQuery(
 				svc, qOpts, qOpts.BuildQueryServiceOptions(storageFactory, logger),
 				traceReader, dependencyReader, metricsQueryService,
-				tm, telset,
+				tm, queryTelset,
 			)
 
 			svc.RunAndThen(func() {
@@ -223,10 +224,10 @@ func startQuery(
 	depReader dependencystore.Reader,
 	metricsQueryService querysvc.MetricsQueryService,
 	tm *tenancy.Manager,
-	telset telemetery.Setting,
+	telset telemetry.Settings,
 ) *queryApp.Server {
-	// TODO: decorate trace reader with metrics
-	qs := querysvc.NewQueryService(traceReader, depReader, *queryOpts)
+	spanReader = spanstoremetrics.NewReaderDecorator(spanReader, telset.Metrics)
+	qs := querysvc.NewQueryService(spanReader, depReader, *queryOpts)
 
 	server, err := queryApp.NewServer(context.Background(), qs, metricsQueryService, qOpts, tm, telset)
 	if err != nil {
@@ -257,5 +258,5 @@ func createMetricsQueryService(
 	}
 
 	// Decorate the metrics reader with metrics instrumentation.
-	return metricsstoreMetrics.NewReadMetricsDecorator(reader, metricsReaderMetricsFactory), nil
+	return metricstoremetrics.NewReaderDecorator(reader, metricsReaderMetricsFactory), nil
 }

cmd/anonymizer/app/anonymizer/anonymizer_test.go

@@ -4,6 +4,7 @@
 package anonymizer
 
 import (
+	"net/http"
 	"os"
 	"path/filepath"
 	"testing"
@@ -18,7 +19,7 @@ import (
 
 var tags = []model.KeyValue{
 	model.Bool("error", true),
-	model.String("http.method", "POST"),
+	model.String("http.method", http.MethodPost),
 	model.Bool("foobar", true),
 }
 
@@ -127,7 +128,7 @@ func TestAnonymizer_SaveMapping(t *testing.T) {
 func TestAnonymizer_FilterStandardTags(t *testing.T) {
 	expected := []model.KeyValue{
 		model.Bool("error", true),
-		model.String("http.method", "POST"),
+		model.String("http.method", http.MethodPost),
 	}
 	actual := filterStandardTags(tags)
 	assert.Equal(t, expected, actual)

cmd/anonymizer/app/writer/writer_test.go

@@ -4,6 +4,7 @@
 package writer
 
 import (
+	"net/http"
 	"testing"
 	"time"
 
@@ -15,7 +16,7 @@ import (
 
 var tags = []model.KeyValue{
 	model.Bool("error", true),
-	model.String("http.method", "POST"),
+	model.String("http.method", http.MethodPost),
 	model.Bool("foobar", true),
 }
 

cmd/collector/main.go

@@ -24,6 +24,7 @@ import (
 	"github.com/jaegertracing/jaeger/cmd/internal/status"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/metrics"
+	"github.com/jaegertracing/jaeger/pkg/telemetry"
 	"github.com/jaegertracing/jaeger/pkg/tenancy"
 	"github.com/jaegertracing/jaeger/pkg/version"
 	ss "github.com/jaegertracing/jaeger/plugin/sampling/strategyprovider"
@@ -63,8 +64,12 @@ func main() {
 			metricsFactory := baseFactory.Namespace(metrics.NSOptions{Name: "collector"})
 			version.NewInfoMetrics(metricsFactory)
 
+			baseTelset := telemetry.NoopSettings()
+			baseTelset.Logger = svc.Logger
+			baseTelset.Metrics = baseFactory
+
 			storageFactory.InitFromViper(v, logger)
-			if err := storageFactory.Initialize(baseFactory, logger); err != nil {
+			if err := storageFactory.Initialize(baseTelset.Metrics, baseTelset.Logger); err != nil {
 				logger.Fatal("Failed to init storage factory", zap.Error(err))
 			}
 			spanWriter, err := storageFactory.CreateSpanWriter()

cmd/es-index-cleaner/app/flags.go

@@ -7,6 +7,9 @@ import (
 	"flag"
 
 	"github.com/spf13/viper"
+	"go.opentelemetry.io/collector/config/configtls"
+
+	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 )
 
 const (
@@ -19,6 +22,8 @@ const (
 	password           = "es.password"
 )
 
+var tlsFlagsCfg = tlscfg.ClientFlagsConfig{Prefix: "es"}
+
 // Config holds configuration for index cleaner binary.
 type Config struct {
 	IndexPrefix              string
@@ -29,6 +34,7 @@ type Config struct {
 	Username                 string
 	Password                 string
 	TLSEnabled               bool
+	TLSConfig                configtls.ClientConfig
 }
 
 // AddFlags adds flags for TLS to the FlagSet.
@@ -40,6 +46,7 @@ func (*Config) AddFlags(flags *flag.FlagSet) {
 	flags.String(indexDateSeparator, "-", "Index date separator")
 	flags.String(username, "", "The username required by storage")
 	flags.String(password, "", "The password required by storage")
+	tlsFlagsCfg.AddFlags(flags)
 }
 
 // InitFromViper initializes config from viper.Viper.
@@ -55,4 +62,9 @@ func (c *Config) InitFromViper(v *viper.Viper) {
 	c.IndexDateSeparator = v.GetString(indexDateSeparator)
 	c.Username = v.GetString(username)
 	c.Password = v.GetString(password)
+	opts, err := tlsFlagsCfg.InitFromViper(v)
+	if err != nil {
+		panic(err)
+	}
+	c.TLSConfig = opts.ToOtelClientConfig()
 }

cmd/es-index-cleaner/main.go

@@ -4,6 +4,7 @@
 package main
 
 import (
+	"context"
 	"encoding/base64"
 	"errors"
 	"fmt"
@@ -18,15 +19,13 @@ import (
 
 	"github.com/jaegertracing/jaeger/cmd/es-index-cleaner/app"
 	"github.com/jaegertracing/jaeger/pkg/config"
-	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 	"github.com/jaegertracing/jaeger/pkg/es/client"
 )
 
 func main() {
 	logger, _ := zap.NewProduction()
 	v := viper.New()
 	cfg := &app.Config{}
-	tlsFlags := tlscfg.ClientFlagsConfig{Prefix: "es"}
 
 	command := &cobra.Command{
 		Use:   "jaeger-es-index-cleaner NUM_OF_DAYS http://HOSTNAME:PORT",
@@ -42,21 +41,18 @@ func main() {
 			}
 
 			cfg.InitFromViper(v)
-			tlsOpts, err := tlsFlags.InitFromViper(v)
-			if err != nil {
-				return err
-			}
-			tlsCfg, err := tlsOpts.Config(logger)
+
+			ctx := context.Background()
+			tlscfg, err := cfg.TLSConfig.LoadTLSConfig(ctx)
 			if err != nil {
-				return err
+				return fmt.Errorf("error loading tls config : %w", err)
 			}
-			defer tlsOpts.Close()
 
 			c := &http.Client{
 				Timeout: time.Duration(cfg.MasterNodeTimeoutSeconds) * time.Second,
 				Transport: &http.Transport{
 					Proxy:           http.ProxyFromEnvironment,
-					TLSClientConfig: tlsCfg,
+					TLSClientConfig: tlscfg,
 				},
 			}
 			i := client.IndicesClient{
@@ -101,7 +97,6 @@ func main() {
 		v,
 		command,
 		cfg.AddFlags,
-		tlsFlags.AddFlags,
 	)
 
 	if err := command.Execute(); err != nil {

cmd/es-rollover/app/actions.go

@@ -4,14 +4,15 @@
 package app
 
 import (
+	"context"
 	"crypto/tls"
+	"fmt"
 	"net/http"
 	"time"
 
 	"github.com/spf13/viper"
 	"go.uber.org/zap"
 
-	"github.com/jaegertracing/jaeger/pkg/config/tlscfg"
 	"github.com/jaegertracing/jaeger/pkg/es/client"
 )
 
@@ -37,10 +38,9 @@ type Action interface {
 
 // ActionExecuteOptions are the options passed to the execute action function
 type ActionExecuteOptions struct {
-	Args     []string
-	Viper    *viper.Viper
-	Logger   *zap.Logger
-	TLSFlags tlscfg.ClientFlagsConfig
+	Args   []string
+	Viper  *viper.Viper
+	Logger *zap.Logger
 }
 
 // ActionCreatorFunction type is the function type in charge of create the action to be executed
@@ -50,15 +50,12 @@ type ActionCreatorFunction func(client.Client, Config) Action
 func ExecuteAction(opts ActionExecuteOptions, createAction ActionCreatorFunction) error {
 	cfg := Config{}
 	cfg.InitFromViper(opts.Viper)
-	tlsOpts, err := opts.TLSFlags.InitFromViper(opts.Viper)
-	if err != nil {
-		return err
-	}
-	tlsCfg, err := tlsOpts.Config(opts.Logger)
+
+	ctx := context.Background()
+	tlsCfg, err := cfg.TLSConfig.LoadTLSConfig(ctx)
 	if err != nil {
-		return err
+		return fmt.Errorf("TLS configuration failed: %w", err)
 	}
-	defer tlsOpts.Close()
 
 	esClient := newESClient(opts.Args[0], &cfg, tlsCfg)
 	action := createAction(esClient, cfg)