Merge branch 'main' into add-k8s-example

.github/workflows/ci-all-in-one-build.yml

@@ -33,7 +33,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Build, test, and publish all-in-one image
       run: bash scripts/build-all-in-one-image.sh

.github/workflows/ci-crossdock.yml

@@ -35,7 +35,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Build, test, and publish ${{ matrix.steps.name }} image
       run: ${{ matrix.steps.cmd }}

.github/workflows/ci-docker-build.yml

@@ -34,7 +34,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Build and upload all docker images
       run: bash scripts/build-upload-docker-images.sh

.github/workflows/ci-elasticsearch.yml

@@ -39,7 +39,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Run elasticsearch integration tests
       run: bash scripts/es-integration-test.sh ${{ matrix.version.distribution }} ${{ matrix.version.image }}

.github/workflows/ci-hotrod.yml

@@ -29,7 +29,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Build, test, and publish hotrod image
       run: bash scripts/hotrod-integration-test.sh

.github/workflows/ci-opensearch.yml

@@ -33,7 +33,7 @@ jobs:
     - name: Install tools
       run: make install-ci
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Run opensearch integration tests
       run: bash scripts/es-integration-test.sh ${{ matrix.version.distribution }} ${{ matrix.version.image }}

.github/workflows/ci-release.yml

@@ -50,7 +50,7 @@ jobs:
         repo_token: ${{ secrets.GITHUB_TOKEN }}
       if: steps.package-binaries.outcome == 'success'
 
-    - uses: docker/setup-qemu-action@v1
+    - uses: docker/setup-qemu-action@v2
 
     - name: Build and upload all docker images
       run: bash scripts/build-upload-docker-images.sh

README.md

@@ -216,7 +216,7 @@ If you would like to add your organization to the list, please comment on our
 
 ## License
 
-[Apache 2.0 License](./LICENSE).
+Copyright (c) The Jaeger Authors. [Apache 2.0 License](./LICENSE).
 
 [doc]: https://jaegertracing.io/docs/
 [godoc-img]: https://godoc.org/github.com/jaegertracing/jaeger?status.svg

cmd/agent/app/reporter/grpc/reporter.go

@@ -44,7 +44,7 @@ func NewReporter(conn *grpc.ClientConn, agentTags map[string]string, logger *zap
 		collector: api_v2.NewCollectorServiceClient(conn),
 		agentTags: makeModelKeyValue(agentTags),
 		logger:    logger,
-		sanitizer: zipkin2.NewChainedSanitizer(zipkin2.StandardSanitizers...),
+		sanitizer: zipkin2.NewChainedSanitizer(zipkin2.NewStandardSanitizers()...),
 	}
 }
 

cmd/all-in-one/main.go

@@ -50,6 +50,7 @@ import (
 	"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/spanstore"
 	storageMetrics "github.com/jaegertracing/jaeger/storage/spanstore/metrics"
 )
@@ -120,7 +121,7 @@ by default uses only in-memory database.`,
 				logger.Fatal("Failed to create dependency reader", zap.Error(err))
 			}
 
-			metricsQueryService, err := createMetricsQueryService(metricsReaderFactory, v, logger)
+			metricsQueryService, err := createMetricsQueryService(metricsReaderFactory, v, logger, metricsFactory)
 			if err != nil {
 				logger.Fatal("Failed to create metrics reader", zap.Error(err))
 			}
@@ -307,12 +308,24 @@ func initTracer(metricsFactory metrics.Factory, logger *zap.Logger) io.Closer {
 	return closer
 }
 
-func createMetricsQueryService(factory *metricsPlugin.Factory, v *viper.Viper, logger *zap.Logger) (querysvc.MetricsQueryService, error) {
-	if err := factory.Initialize(logger); err != nil {
+func createMetricsQueryService(
+	metricsReaderFactory *metricsPlugin.Factory,
+	v *viper.Viper,
+	logger *zap.Logger,
+	metricsReaderMetricsFactory metrics.Factory,
+) (querysvc.MetricsQueryService, error) {
+
+	if err := metricsReaderFactory.Initialize(logger); err != nil {
 		return nil, fmt.Errorf("failed to init metrics reader factory: %w", err)
 	}
 
 	// Ensure default parameter values are loaded correctly.
-	factory.InitFromViper(v, logger)
-	return factory.CreateMetricsReader()
+	metricsReaderFactory.InitFromViper(v, logger)
+	reader, err := metricsReaderFactory.CreateMetricsReader()
+	if err != nil {
+		return nil, fmt.Errorf("failed to create metrics reader: %w", err)
+	}
+
+	// Decorate the metrics reader with metrics instrumentation.
+	return metricsstoreMetrics.NewReadMetricsDecorator(reader, metricsReaderMetricsFactory), nil
 }

cmd/collector/app/options.go

@@ -37,7 +37,7 @@ type options struct {
 	logger             *zap.Logger
 	serviceMetrics     metrics.Factory
 	hostMetrics        metrics.Factory
-	preProcessSpans    ProcessSpans
+	preProcessSpans    ProcessSpans // see docs in PreProcessSpans option.
 	sanitizer          sanitizer.SanitizeSpan
 	preSave            ProcessSpan
 	spanFilter         FilterSpan
@@ -78,7 +78,9 @@ func (options) HostMetrics(hostMetrics metrics.Factory) Option {
 	}
 }
 
-// PreProcessSpans creates an Option that initializes the preProcessSpans function
+// PreProcessSpans creates an Option that initializes the preProcessSpans function.
+// This function can implement non-standard pre-processing of the spans when extending
+// the collector from source. Jaeger itself does not define any pre-processing.
 func (options) PreProcessSpans(preProcessSpans ProcessSpans) Option {
 	return func(b *options) {
 		b.preProcessSpans = preProcessSpans

cmd/collector/app/sanitizer/empty_service_name_sanitizer.go

@@ -0,0 +1,41 @@
+// Copyright (c) 2022 The Jaeger Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package sanitizer
+
+import (
+	"github.com/jaegertracing/jaeger/model"
+)
+
+const (
+	serviceNameReplacement = "empty-service-name"
+	nullProcessServiceName = "null-process-and-service-name"
+)
+
+// NewEmptyServiceNameSanitizer returns a function that replaces empty service name
+// with a string "empty-service-name".
+// If the whole span.Process is null, it creates one with "null-process-and-service-name".
+func NewEmptyServiceNameSanitizer() SanitizeSpan {
+	return sanitizeEmptyServiceName
+}
+
+// Sanitize sanitizes the service names in the span annotations.
+func sanitizeEmptyServiceName(span *model.Span) *model.Span {
+	if span.Process == nil {
+		span.Process = &model.Process{ServiceName: nullProcessServiceName}
+	} else if span.Process.ServiceName == "" {
+		span.Process.ServiceName = serviceNameReplacement
+	}
+	return span
+}

cmd/collector/app/sanitizer/empty_service_name_sanitizer_test.go

@@ -0,0 +1,32 @@
+// Copyright (c) 2022 The Jaeger Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package sanitizer
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/jaegertracing/jaeger/model"
+)
+
+func TestEmptyServiceNameSanitizer(t *testing.T) {
+	s := NewEmptyServiceNameSanitizer()
+	s1 := s(&model.Span{})
+	assert.NotNil(t, s1.Process)
+	assert.Equal(t, nullProcessServiceName, s1.Process.ServiceName)
+	s2 := s(&model.Span{Process: &model.Process{}})
+	assert.Equal(t, serviceNameReplacement, s2.Process.ServiceName)
+}

cmd/collector/app/sanitizer/sanitizer.go

@@ -23,8 +23,19 @@ import (
 // span should implement this interface.
 type SanitizeSpan func(span *model.Span) *model.Span
 
-// NewChainedSanitizer creates a Sanitizer from the variadic list of passed Sanitizers
+// NewStandardSanitizers are automatically applied by SpanProcessor.
+func NewStandardSanitizers() []SanitizeSpan {
+	return []SanitizeSpan{
+		NewEmptyServiceNameSanitizer(),
+	}
+}
+
+// NewChainedSanitizer creates a Sanitizer from the variadic list of passed Sanitizers.
+// If the list only has one element, it is returned directly to minimize indirection.
 func NewChainedSanitizer(sanitizers ...SanitizeSpan) SanitizeSpan {
+	if len(sanitizers) == 1 {
+		return sanitizers[0]
+	}
 	return func(span *model.Span) *model.Span {
 		for _, s := range sanitizers {
 			span = s(span)

cmd/collector/app/sanitizer/sanitizer_test.go

@@ -0,0 +1,44 @@
+// Copyright (c) 2022 The Jaeger Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package sanitizer
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/jaegertracing/jaeger/model"
+)
+
+func TestNewStandardSanitizers(t *testing.T) {
+	NewStandardSanitizers()
+}
+
+func TestChainedSanitizer(t *testing.T) {
+	var s1 SanitizeSpan = func(span *model.Span) *model.Span {
+		span.Process = &model.Process{ServiceName: "s1"}
+		return span
+	}
+	var s2 SanitizeSpan = func(span *model.Span) *model.Span {
+		span.Process = &model.Process{ServiceName: "s2"}
+		return span
+	}
+	c1 := NewChainedSanitizer(s1)
+	sp1 := c1(&model.Span{})
+	assert.Equal(t, "s1", sp1.Process.ServiceName)
+	c2 := NewChainedSanitizer(s1, s2)
+	sp2 := c2(&model.Span{})
+	assert.Equal(t, "s2", sp2.Process.ServiceName)
+}

cmd/collector/app/sanitizer/zipkin/span_sanitizer.go

@@ -27,11 +27,17 @@ const (
 	zeroParentIDTag     = "errZeroParentID"
 )
 
-var (
-	defaultDuration = int64(1)
-	// StandardSanitizers is a list of standard zipkin sanitizers.
-	StandardSanitizers = []Sanitizer{NewSpanStartTimeSanitizer(), NewSpanDurationSanitizer(), NewParentIDSanitizer(), NewErrorTagSanitizer()}
-)
+var defaultDuration = int64(1) // not a const because we take its address
+
+// NewStandardSanitizers is a list of standard zipkin sanitizers.
+func NewStandardSanitizers() []Sanitizer {
+	return []Sanitizer{
+		NewSpanStartTimeSanitizer(),
+		NewSpanDurationSanitizer(),
+		NewParentIDSanitizer(),
+		NewErrorTagSanitizer(),
+	}
+}
 
 // Sanitizer interface for sanitizing spans. Any business logic that needs to be applied to normalize the contents of a
 // span should implement this interface.

cmd/collector/app/sanitizer/zipkin/span_sanitizer_test.go

@@ -28,6 +28,10 @@ var (
 	positiveDuration = int64(1)
 )
 
+func TestNewStandardSanitizers(t *testing.T) {
+	NewStandardSanitizers()
+}
+
 func TestChainedSanitizer(t *testing.T) {
 	sanitizer := NewChainedSanitizer(NewSpanDurationSanitizer())
 

cmd/collector/app/span_handler_builder.go

@@ -67,7 +67,11 @@ func (b *SpanHandlerBuilder) BuildSpanProcessor(additional ...ProcessSpan) proce
 // BuildHandlers builds span handlers (Zipkin, Jaeger)
 func (b *SpanHandlerBuilder) BuildHandlers(spanProcessor processor.SpanProcessor) *SpanHandlers {
 	return &SpanHandlers{
-		handler.NewZipkinSpanHandler(b.Logger, spanProcessor, zs.NewChainedSanitizer(zs.StandardSanitizers...)),
+		handler.NewZipkinSpanHandler(
+			b.Logger,
+			spanProcessor,
+			zs.NewChainedSanitizer(zs.NewStandardSanitizers()...),
+		),
 		handler.NewJaegerSpanHandler(b.Logger, spanProcessor),
 		handler.NewGRPCHandler(b.Logger, spanProcessor),
 	}

cmd/collector/app/span_processor.go

@@ -63,7 +63,7 @@ type queueItem struct {
 	span       *model.Span
 }
 
-// NewSpanProcessor returns a SpanProcessor that preProcesses, filters, queues, sanitizes, and processes spans
+// NewSpanProcessor returns a SpanProcessor that preProcesses, filters, queues, sanitizes, and processes spans.
 func NewSpanProcessor(
 	spanWriter spanstore.Writer,
 	additional []ProcessSpan,
@@ -96,13 +96,18 @@ func newSpanProcessor(spanWriter spanstore.Writer, additional []ProcessSpan, opt
 	}
 	boundedQueue := queue.NewBoundedQueue(options.queueSize, droppedItemHandler)
 
+	sanitizers := sanitizer.NewStandardSanitizers()
+	if options.sanitizer != nil {
+		sanitizers = append(sanitizers, options.sanitizer)
+	}
+
 	sp := spanProcessor{
 		queue:              boundedQueue,
 		metrics:            handlerMetrics,
 		logger:             options.logger,
 		preProcessSpans:    options.preProcessSpans,
 		filterSpan:         options.spanFilter,
-		sanitizer:          options.sanitizer,
+		sanitizer:          sanitizer.NewChainedSanitizer(sanitizers...),
 		reportBusy:         options.reportBusy,
 		numWorkers:         options.numWorkers,
 		spanWriter:         spanWriter,