[exporter/datadog] Add configurable reporter_period for host metadata

.chloggen/add-configurable-reporter-period-for-host-metadata.yaml

@@ -0,0 +1,27 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: datadogexporter
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add a configurable `reporter_period` parameter to the Datadog exporter’s host metadata configuration to allow users to specify the frequency at which host metadata is sent to Datadog.
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [36450]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext:
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

exporter/datadogexporter/examples/collector.yaml

@@ -449,6 +449,11 @@ exporters:
       #
       # tags: ["team:infra", "<TAG_KEY>:<TAG_VALUE>"]
 
+      ## @param reporter_period - duration - optional - default: 30m
+      ## The period at which the host metadata reporter sends host metadata to Datadog.
+      ## The default is 30 minutes.
+      # reporter_period: 30m
+
     ## @param logs - custom object - optional
     ## Logs exporter specific configuration.
     #

exporter/datadogexporter/factory.go

@@ -79,8 +79,6 @@ func enableZorkianMetricExport() error {
 	return featuregate.GlobalRegistry().Set(metricExportNativeClientFeatureGate.ID(), false)
 }
 
-const metadataReporterPeriod = 30 * time.Minute
-
 func consumeResource(metadataReporter *inframetadata.Reporter, res pcommon.Resource, logger *zap.Logger) {
 	if err := metadataReporter.ConsumeResource(res); err != nil {
 		logger.Warn("failed to consume resource for host metadata", zap.Error(err), zap.Any("resource", res))
@@ -124,7 +122,7 @@ func (f *factory) AttributesTranslator(set component.TelemetrySettings) (*attrib
 func (f *factory) Reporter(params exporter.Settings, pcfg hostmetadata.PusherConfig) (*inframetadata.Reporter, error) {
 	f.onceReporter.Do(func() {
 		pusher := hostmetadata.NewPusher(params, pcfg)
-		f.reporter, f.reporterErr = inframetadata.NewReporter(params.Logger, pusher, metadataReporterPeriod)
+		f.reporter, f.reporterErr = inframetadata.NewReporter(params.Logger, pusher, pcfg.ReporterPeriod)
 		if f.reporterErr == nil {
 			go func() {
 				if err := f.reporter.Run(context.Background()); err != nil {

exporter/datadogexporter/factory_test.go

@@ -308,6 +308,7 @@ func TestOnlyMetadata(t *testing.T) {
 		HostMetadata: HostMetadataConfig{
 			Enabled:        true,
 			HostnameSource: HostnameSourceFirstResource,
+			ReporterPeriod: 30 * time.Minute,
 		},
 	}
 	cfg.HostMetadata.SetSourceTimeout(50 * time.Millisecond)

exporter/datadogexporter/hostmetadata.go

@@ -18,5 +18,6 @@ func newMetadataConfigfromConfig(cfg *Config) hostmetadata.PusherConfig {
 		InsecureSkipVerify:  cfg.TLSSetting.InsecureSkipVerify,
 		ClientConfig:        cfg.ClientConfig,
 		RetrySettings:       cfg.BackOffConfig,
+		ReporterPeriod:      cfg.HostMetadata.ReporterPeriod,
 	}
 }

exporter/datadogexporter/internal/hostmetadata/config.go

@@ -4,6 +4,8 @@
 package hostmetadata // import "github.com/open-telemetry/opentelemetry-collector-contrib/exporter/datadogexporter/internal/hostmetadata"
 
 import (
+	"time"
+
 	"go.opentelemetry.io/collector/config/confighttp"
 	"go.opentelemetry.io/collector/config/configretry"
 )
@@ -26,4 +28,6 @@ type PusherConfig struct {
 	ClientConfig confighttp.ClientConfig
 	// RetrySettings of exporter.
 	RetrySettings configretry.BackOffConfig
+	// ReporterPeriod is the period of the reporter goroutine.
+	ReporterPeriod time.Duration
 }

exporter/datadogexporter/logs_exporter_test.go

@@ -230,6 +230,9 @@ func TestLogsExporter(t *testing.T) {
 						Endpoint: server.URL,
 					},
 				},
+				HostMetadata: HostMetadataConfig{
+					ReporterPeriod: 30 * time.Minute,
+				},
 			}
 
 			params := exportertest.NewNopSettings()
@@ -595,6 +598,9 @@ func TestLogsAgentExporter(t *testing.T) {
 					CompressionLevel: 6,
 					BatchWait:        1,
 				},
+				HostMetadata: HostMetadataConfig{
+					ReporterPeriod: 30 * time.Minute,
+				},
 			}
 			params := exportertest.NewNopSettings()
 			f := NewFactory()

exporter/datadogexporter/metrics_exporter_test.go

@@ -58,7 +58,9 @@ func TestNewExporter(t *testing.T) {
 				CumulativeMonotonicMode: CumulativeMonotonicSumModeToDelta,
 			},
 		},
-		HostMetadata: HostMetadataConfig{},
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
 	}
 	cfg.HostMetadata.SetSourceTimeout(50 * time.Millisecond)
 	params := exportertest.NewNopSettings()
@@ -437,6 +439,9 @@ func TestNewExporter_Zorkian(t *testing.T) {
 				CumulativeMonotonicMode: CumulativeMonotonicSumModeToDelta,
 			},
 		},
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
 	}
 	params := exportertest.NewNopSettings()
 	f := NewFactory()

exporter/datadogexporter/traces_exporter_test.go

@@ -145,6 +145,9 @@ func TestTracesSource(t *testing.T) {
 				IgnoreResources: []string{},
 			},
 		},
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
 	}
 
 	assert := assert.New(t)
@@ -267,6 +270,9 @@ func TestTraceExporter(t *testing.T) {
 			},
 			TraceBuffer: 2,
 		},
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
 	}
 	cfg.Traces.SetFlushInterval(0.1)
 
@@ -292,7 +298,11 @@ func TestNewTracesExporter(t *testing.T) {
 	metricsServer := testutil.DatadogServerMock()
 	defer metricsServer.Close()
 
-	cfg := &Config{}
+	cfg := &Config{
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
+	}
 	cfg.API.Key = "ddog_32_characters_long_api_key1"
 	cfg.Metrics.TCPAddrConfig.Endpoint = metricsServer.URL
 	params := exportertest.NewNopSettings()
@@ -320,10 +330,10 @@ func TestPushTraceData(t *testing.T) {
 		Traces: TracesConfig{
 			TCPAddrConfig: confignet.TCPAddrConfig{Endpoint: server.URL},
 		},
-
 		HostMetadata: HostMetadataConfig{
 			Enabled:        true,
 			HostnameSource: HostnameSourceFirstResource,
+			ReporterPeriod: 30 * time.Minute,
 		},
 	}
 
@@ -358,6 +368,9 @@ func TestPushTraceData_NewEnvConvention(t *testing.T) {
 		Traces: TracesConfig{
 			TCPAddrConfig: confignet.TCPAddrConfig{Endpoint: server.URL},
 		},
+		HostMetadata: HostMetadataConfig{
+			ReporterPeriod: 30 * time.Minute,
+		},
 	}
 	cfg.Traces.SetFlushInterval(0.1)
 

pkg/datadog/config/config.go

@@ -133,6 +133,10 @@ func (c *Config) Validate() error {
 		return err
 	}
 
+	if c.HostMetadata.ReporterPeriod <= 0 {
+		return errors.New("reporter_period must be a positive duration")
+	}
+
 	return nil
 }
 
@@ -340,6 +344,7 @@ func CreateDefaultConfig() component.Config {
 		HostMetadata: HostMetadataConfig{
 			Enabled:        true,
 			HostnameSource: HostnameSourceConfigOrSystem,
+			ReporterPeriod: 30 * time.Minute,
 		},
 	}
 }