empty_service_name_sanitizer.go

// 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
}