[exporter/datadog] Deprecate service and version settings (#8784)

* [exporter/datadog] Deprecate `service` and `version` settings * Add changelog entry * [exporter/datadog] Remove Service and Version from tests * Address review comment * Fix lint * Bump to v0.49.0 This won't make it into v0.48.0, so I updated the deprecation and removal versions * Update CHANGELOG
open-telemetry · Mar 31, 2022 · e52d6be · e52d6be
1 parent 5f777db
commit e52d6be
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,9 @@
 
 ### 🚩 Deprecations 🚩
 
+- `datadogexporter`: Deprecate `service` setting in favor of `service.name` semantic convention (#8784)
+- `datadogexporter`: Deprecate `version` setting in favor of `service.version` semantic convention (#8784)
+
 ### 🚀 New components 🚀
 
 ## v0.48.0

diff --git a/exporter/datadogexporter/README.md b/exporter/datadogexporter/README.md
@@ -69,8 +69,6 @@ exporters:
   datadog/api:
     hostname: customhostname
     env: prod
-    service: myservice
-    version: myversion
 
     tags:
       - example:tag

diff --git a/exporter/datadogexporter/config/config.go b/exporter/datadogexporter/config/config.go
@@ -221,10 +221,14 @@ type TagsConfig struct {
 	Env string `mapstructure:"env"`
 
 	// Service is the service for unified service tagging.
+	// Deprecated: [v0.49.0] Set `service.name` semconv instead, see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/8781 for details.
+	// This option will be removed in v0.52.0.
 	// It can also be set through the `DD_SERVICE` environment variable (Deprecated: [v0.47.0] set environment variable explicitly on configuration instead).
 	Service string `mapstructure:"service"`
 
 	// Version is the version for unified service tagging.
+	// Deprecated: [v0.49.0] Set `service.version` semconv instead, see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/8783 for details.
+	// This option will be removed in v0.52.0.
 	// It can also be set through the `DD_VERSION` environment variable (Deprecated: [v0.47.0] set environment variable explicitly on configuration instead).
 	Version string `mapstructure:"version"`
 
@@ -414,5 +418,13 @@ func (c *Config) Unmarshal(configMap *config.Map) error {
 	// Add warnings about autodetected environment variables.
 	c.warnings = append(c.warnings, warnUseOfEnvVars(configMap, c)...)
 
+	deprecationTemplate := "%q has been deprecated and will be removed in %s. See https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/%d"
+	if c.Service != "" {
+		c.warnings = append(c.warnings, fmt.Errorf(deprecationTemplate, "service", "v0.52.0", 8781))
+	}
+	if c.Version != "" {
+		c.warnings = append(c.warnings, fmt.Errorf(deprecationTemplate, "version", "v0.52.0", 8783))
+	}
+
 	return nil
 }
diff --git a/exporter/datadogexporter/example/config.yaml b/exporter/datadogexporter/example/config.yaml
@@ -21,12 +21,16 @@ exporters:
 
     ## @param service - string - optional
     ## The service for unified service tagging.
+    ## Deprecated: [v0.48.0] Set `service.name` semconv instead, see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/8781 for details.
+    ## This option will be removed in v0.51.0.
     ## If unset it will be determined from the `DD_SERVICE` environment variable (Deprecated: [v0.47.0] set environment variable explicitly on configuration instead).
     #
     # service: myservice
 
     ## @param version - string - optional
     ## The version for unified service tagging.
+    ## Deprecated: [v0.48.0] Set `service.version` semconv instead, see https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/8783 for details.
+    ## This option will be removed in v0.51.0.
     ## If unset it will be determined from the `DD_VERSION` environment variable (Deprecated: [v0.47.0] set environment variable explicitly on configuration instead).
     #
     # version: myversion

diff --git a/exporter/datadogexporter/factory_test.go b/exporter/datadogexporter/factory_test.go
@@ -130,53 +130,47 @@ func TestLoadConfig(t *testing.T) {
 	err = apiConfig.Sanitize(zap.NewNop())
 
 	require.NoError(t, err)
-	assert.Equal(t, &ddconfig.Config{
-		ExporterSettings: config.NewExporterSettings(config.NewComponentIDWithName(typeStr, "api")),
-		TimeoutSettings:  defaulttimeoutSettings(),
-		RetrySettings:    exporterhelper.NewDefaultRetrySettings(),
-		QueueSettings:    exporterhelper.NewDefaultQueueSettings(),
-
-		TagsConfig: ddconfig.TagsConfig{
-			Hostname:   "customhostname",
-			Env:        "prod",
-			Service:    "myservice",
-			Version:    "myversion",
-			EnvVarTags: "",
-			Tags:       []string{"example:tag"},
+	assert.Equal(t, config.NewExporterSettings(config.NewComponentIDWithName(typeStr, "api")), apiConfig.ExporterSettings)
+	assert.Equal(t, defaulttimeoutSettings(), apiConfig.TimeoutSettings)
+	assert.Equal(t, exporterhelper.NewDefaultRetrySettings(), apiConfig.RetrySettings)
+	assert.Equal(t, exporterhelper.NewDefaultQueueSettings(), apiConfig.QueueSettings)
+	assert.Equal(t, ddconfig.TagsConfig{
+		Hostname:   "customhostname",
+		Env:        "prod",
+		Service:    "myservice",
+		Version:    "myversion",
+		EnvVarTags: "",
+		Tags:       []string{"example:tag"},
+	}, apiConfig.TagsConfig)
+	assert.Equal(t, ddconfig.APIConfig{
+		Key:  "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+		Site: "datadoghq.eu",
+	}, apiConfig.API)
+	assert.Equal(t, ddconfig.MetricsConfig{
+		TCPAddr: confignet.TCPAddr{
+			Endpoint: "https://api.datadoghq.eu",
 		},
-
-		API: ddconfig.APIConfig{
-			Key:  "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
-			Site: "datadoghq.eu",
+		DeltaTTL:      3600,
+		SendMonotonic: true,
+		Quantiles:     true,
+		HistConfig: ddconfig.HistogramConfig{
+			Mode:         "distributions",
+			SendCountSum: false,
 		},
-
-		Metrics: ddconfig.MetricsConfig{
-			TCPAddr: confignet.TCPAddr{
-				Endpoint: "https://api.datadoghq.eu",
-			},
-			DeltaTTL:      3600,
-			SendMonotonic: true,
-			Quantiles:     true,
-			HistConfig: ddconfig.HistogramConfig{
-				Mode:         "distributions",
-				SendCountSum: false,
-			},
-			SumConfig: ddconfig.SumConfig{
-				CumulativeMonotonicMode: ddconfig.CumulativeMonotonicSumModeToDelta,
-			},
+		SumConfig: ddconfig.SumConfig{
+			CumulativeMonotonicMode: ddconfig.CumulativeMonotonicSumModeToDelta,
 		},
-
-		Traces: ddconfig.TracesConfig{
-			SampleRate: 1,
-			TCPAddr: confignet.TCPAddr{
-				Endpoint: "https://trace.agent.datadoghq.eu",
-			},
-			IgnoreResources: []string{},
+	}, apiConfig.Metrics)
+	assert.Equal(t, ddconfig.TracesConfig{
+		SampleRate: 1,
+		TCPAddr: confignet.TCPAddr{
+			Endpoint: "https://trace.agent.datadoghq.eu",
 		},
-		SendMetadata:        true,
-		OnlyMetadata:        false,
-		UseResourceMetadata: true,
-	}, apiConfig)
+		IgnoreResources: []string{},
+	}, apiConfig.Traces)
+	assert.True(t, apiConfig.SendMetadata)
+	assert.False(t, apiConfig.OnlyMetadata)
+	assert.True(t, apiConfig.UseResourceMetadata)
 
 	defaultConfig := cfg.Exporters[config.NewComponentIDWithName(typeStr, "default")].(*ddconfig.Config)
 	err = defaultConfig.Sanitize(zap.NewNop())
@@ -240,8 +234,6 @@ func TestLoadConfigEnvVariables(t *testing.T) {
 	assert.NoError(t, os.Setenv("DD_API_KEY", "replacedapikey"))
 	assert.NoError(t, os.Setenv("DD_HOST", "testhost"))
 	assert.NoError(t, os.Setenv("DD_ENV", "testenv"))
-	assert.NoError(t, os.Setenv("DD_SERVICE", "testservice"))
-	assert.NoError(t, os.Setenv("DD_VERSION", "testversion"))
 	assert.NoError(t, os.Setenv("DD_SITE", "datadoghq.test"))
 	assert.NoError(t, os.Setenv("DD_TAGS", "envexample:tag envexample2:tag"))
 	assert.NoError(t, os.Setenv("DD_URL", "https://api.datadoghq.com"))
@@ -251,8 +243,6 @@ func TestLoadConfigEnvVariables(t *testing.T) {
 		assert.NoError(t, os.Unsetenv("DD_API_KEY"))
 		assert.NoError(t, os.Unsetenv("DD_HOST"))
 		assert.NoError(t, os.Unsetenv("DD_ENV"))
-		assert.NoError(t, os.Unsetenv("DD_SERVICE"))
-		assert.NoError(t, os.Unsetenv("DD_VERSION"))
 		assert.NoError(t, os.Unsetenv("DD_SITE"))
 		assert.NoError(t, os.Unsetenv("DD_TAGS"))
 		assert.NoError(t, os.Unsetenv("DD_URL"))
@@ -281,8 +271,6 @@ func TestLoadConfigEnvVariables(t *testing.T) {
 	assert.Equal(t, ddconfig.TagsConfig{
 		Hostname:   "customhostname",
 		Env:        "prod",
-		Service:    "myservice",
-		Version:    "myversion",
 		EnvVarTags: "envexample:tag envexample2:tag",
 		Tags:       []string{"example:tag"},
 	}, apiConfig.TagsConfig)
@@ -330,8 +318,6 @@ func TestLoadConfigEnvVariables(t *testing.T) {
 	assert.Equal(t, ddconfig.TagsConfig{
 		Hostname:   "testhost",
 		Env:        "testenv",
-		Service:    "testservice",
-		Version:    "testversion",
 		EnvVarTags: "envexample:tag envexample2:tag",
 	}, defaultConfig.TagsConfig)
 	assert.Equal(t, ddconfig.APIConfig{

diff --git a/exporter/datadogexporter/testdata/config.yaml b/exporter/datadogexporter/testdata/config.yaml
@@ -8,7 +8,9 @@ exporters:
   datadog/api:
     hostname: customhostname
     env: prod
+    # Deprecated; kept here to avoid regressions.
     service: myservice
+    # Deprecated; kept here to avoid regressions.
     version: myversion
 
     tags:
@@ -24,8 +26,6 @@ exporters:
   datadog/api2:
     hostname: customhostname
     env: prod
-    service: myservice
-    version: myversion
 
     tags:
       - example:tag