Add service.name resource attribute to the collector's own telemetry

Resolves open-telemetry#6136

- The default service.name is set to "io.opentelemetry.collector". I think this
  is a good choice since it is unambiguous and is still short enough to be readable.
  This also coincides with OpAMP recommendations: https://github.com/open-telemetry/opamp-spec/blob/main/specification.md#agentdescriptionidentifying_attributes
- I made the service.name a setting in BuildInfo which can be overridden when building the
  Collector. Other distros may choose a different service.name.
- The service.name can be also overridden by the end user via telemetry config setting.

Author: tigrannajaryan

cmd/builder/internal/builder/config.go

@@ -27,6 +27,7 @@ import (
 )
 
 const defaultOtelColVersion = "0.60.0"
+const defaultOtelColServiceName = "io.opentelemetry.collector"
 
 // ErrInvalidGoMod indicates an invalid gomod
 var ErrInvalidGoMod = errors.New("invalid gomod specification for module")
@@ -55,6 +56,7 @@ type Distribution struct {
 	OtelColVersion string `mapstructure:"otelcol_version"`
 	OutputPath     string `mapstructure:"output_path"`
 	Version        string `mapstructure:"version"`
+	ServiceName    string `mapstructure:"service_name"`
 	BuildTags      string `mapstructure:"build_tags"`
 }
 
@@ -84,6 +86,7 @@ func NewDefaultConfig() Config {
 			OutputPath:     outputDir,
 			OtelColVersion: defaultOtelColVersion,
 			Module:         "go.opentelemetry.io/collector/cmd/builder",
+			ServiceName:    defaultOtelColServiceName,
 		},
 	}
 }

cmd/builder/internal/builder/templates/main.go.tmpl

@@ -20,6 +20,7 @@ func main() {
 		Command:     "{{ .Distribution.Name }}",
 		Description: "{{ .Distribution.Description }}",
 		Version:     "{{ .Distribution.Version }}",
+		ServiceName: "{{ .Distribution.ServiceName }}",
 	}
 
 	if err := run(service.CollectorSettings{BuildInfo: info, Factories: factories}); err != nil {

cmd/builder/internal/command.go

@@ -36,6 +36,7 @@ const (
 	distributionNameFlag           = "name"
 	distributionDescriptionFlag    = "description"
 	distributionVersionFlag        = "version"
+	distributionServiceNameFlag    = "service-name"
 	distributionOtelColVersionFlag = "otelcol-version"
 	distributionOutputPathFlag     = "output-path"
 	distributionGoFlag             = "go"
@@ -180,6 +181,9 @@ func applyCfgFromFile(flags *flag.FlagSet, cfgFromFile builder.Config) {
 	if !flags.Changed(distributionVersionFlag) && cfgFromFile.Distribution.Version != "" {
 		cfg.Distribution.Version = cfgFromFile.Distribution.Version
 	}
+	if !flags.Changed(distributionServiceNameFlag) && cfgFromFile.Distribution.ServiceName != "" {
+		cfg.Distribution.ServiceName = cfgFromFile.Distribution.ServiceName
+	}
 	if !flags.Changed(distributionOtelColVersionFlag) && cfgFromFile.Distribution.OtelColVersion != "" {
 		cfg.Distribution.OtelColVersion = cfgFromFile.Distribution.OtelColVersion
 	}

cmd/builder/internal/config/default.yaml

@@ -4,6 +4,7 @@ dist:
   description: Local OpenTelemetry Collector binary, testing only.
   version: 0.60.0-dev
   otelcol_version: 0.60.0
+  service_name: io.opentelemetry.collector
 
 receivers:
   - import: go.opentelemetry.io/collector/receiver/otlpreceiver

cmd/otelcorecol/builder-config.yaml

@@ -4,6 +4,7 @@ dist:
   description: Local OpenTelemetry Collector binary, testing only.
   version: 0.60.0-dev
   otelcol_version: 0.60.0
+  service_name: io.opentelemetry.collector
 
 receivers:
   - import: go.opentelemetry.io/collector/receiver/otlpreceiver

cmd/otelcorecol/main.go

@@ -25,6 +25,11 @@ type BuildInfo struct {
 
 	// Version string.
 	Version string
+
+	// ServiceName is the value of "service.name" attribute in the telemetry
+	// that the Collector produces about itself. This can be overridden
+	// by the end user via telemetry.Config.Resource setting.
+	ServiceName string
 }
 
 // NewDefaultBuildInfo returns a default BuildInfo.
@@ -33,5 +38,6 @@ func NewDefaultBuildInfo() BuildInfo {
 		Command:     "otelcol",
 		Description: "OpenTelemetry Collector",
 		Version:     "latest",
+		ServiceName: "io.opentelemetry.collector",
 	}
 }

component/build_info.go

@@ -112,27 +112,8 @@ func (tel *telemetryInitializer) initOnce(buildInfo component.BuildInfo, logger
 
 	logger.Info("Setting up own telemetry...")
 
-	// Construct telemetry attributes from resource attributes.
-	telAttrs := map[string]string{}
-	for k, v := range cfg.Resource {
-		// nil value indicates that the attribute should not be included in the telemetry.
-		if v != nil {
-			telAttrs[k] = *v
-		}
-	}
-
-	if _, ok := cfg.Resource[semconv.AttributeServiceInstanceID]; !ok {
-		// AttributeServiceInstanceID is not specified in the config. Auto-generate one.
-		instanceUUID, _ := uuid.NewRandom()
-		instanceID := instanceUUID.String()
-		telAttrs[semconv.AttributeServiceInstanceID] = instanceID
-	}
-
-	if _, ok := cfg.Resource[semconv.AttributeServiceVersion]; !ok {
-		// AttributeServiceVersion is not specified in the config. Use the actual
-		// build version.
-		telAttrs[semconv.AttributeServiceVersion] = buildInfo.Version
-	}
+	// Construct telemetry attributes from build info and config's resource attributes.
+	telAttrs := buildTelAttrs(buildInfo, cfg)
 
 	if tp, err := textMapPropagatorFromConfig(cfg.Traces.Propagators); err == nil {
 		otel.SetTextMapPropagator(tp)
@@ -174,6 +155,37 @@ func (tel *telemetryInitializer) initOnce(buildInfo component.BuildInfo, logger
 	return nil
 }
 
+func buildTelAttrs(buildInfo component.BuildInfo, cfg telemetry.Config) map[string]string {
+	telAttrs := map[string]string{}
+
+	for k, v := range cfg.Resource {
+		// nil value indicates that the attribute should not be included in the telemetry.
+		if v != nil {
+			telAttrs[k] = *v
+		}
+	}
+
+	if _, ok := cfg.Resource[semconv.AttributeServiceName]; !ok {
+		// AttributeServiceName is not specified in the config. Use the Service name.
+		telAttrs[semconv.AttributeServiceName] = buildInfo.ServiceName
+	}
+
+	if _, ok := cfg.Resource[semconv.AttributeServiceInstanceID]; !ok {
+		// AttributeServiceInstanceID is not specified in the config. Auto-generate one.
+		instanceUUID, _ := uuid.NewRandom()
+		instanceID := instanceUUID.String()
+		telAttrs[semconv.AttributeServiceInstanceID] = instanceID
+	}
+
+	if _, ok := cfg.Resource[semconv.AttributeServiceVersion]; !ok {
+		// AttributeServiceVersion is not specified in the config. Use the actual
+		// build version.
+		telAttrs[semconv.AttributeServiceVersion] = buildInfo.Version
+	}
+
+	return telAttrs
+}
+
 func (tel *telemetryInitializer) initOpenCensus(cfg telemetry.Config, telAttrs map[string]string) (http.Handler, error) {
 	tel.ocRegistry = ocmetric.NewRegistry()
 	metricproducer.GlobalManager().AddProducer(tel.ocRegistry)

service/telemetry.go

@@ -0,0 +1,54 @@
+package service
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/collector/component"
+	semconv "go.opentelemetry.io/collector/semconv/v1.5.0"
+	"go.opentelemetry.io/collector/service/telemetry"
+)
+
+func TestBuildTelAttrs(t *testing.T) {
+	buildInfo := component.NewDefaultBuildInfo()
+
+	// Check default config
+	cfg := telemetry.Config{}
+	telAttrs := buildTelAttrs(buildInfo, cfg)
+
+	assert.Len(t, telAttrs, 3)
+	assert.Equal(t, buildInfo.ServiceName, telAttrs[semconv.AttributeServiceName])
+	assert.Equal(t, buildInfo.Version, telAttrs[semconv.AttributeServiceVersion])
+
+	_, exists := telAttrs[semconv.AttributeServiceInstanceID]
+	assert.True(t, exists)
+
+	// Check override by nil
+	cfg = telemetry.Config{
+		Resource: map[string]*string{
+			semconv.AttributeServiceName:       nil,
+			semconv.AttributeServiceVersion:    nil,
+			semconv.AttributeServiceInstanceID: nil,
+		},
+	}
+	telAttrs = buildTelAttrs(buildInfo, cfg)
+
+	// Attribute should not exist
+	assert.Len(t, telAttrs, 0)
+
+	// Check override values
+	strPtr := func(v string) *string { return &v }
+	cfg = telemetry.Config{
+		Resource: map[string]*string{
+			semconv.AttributeServiceName:       strPtr("a"),
+			semconv.AttributeServiceVersion:    strPtr("b"),
+			semconv.AttributeServiceInstanceID: strPtr("c"),
+		},
+	}
+	telAttrs = buildTelAttrs(buildInfo, cfg)
+
+	assert.Len(t, telAttrs, 3)
+	assert.Equal(t, "a", telAttrs[semconv.AttributeServiceName])
+	assert.Equal(t, "b", telAttrs[semconv.AttributeServiceVersion])
+	assert.Equal(t, "c", telAttrs[semconv.AttributeServiceInstanceID])
+}