[exporter/datadog] Add configurable reporter_period for host metadata (…

…#36451)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This pull request introduces a new configurable parameter
`reporter_period` for the Datadog exporter’s host metadata
configuration. This enhancement allows users to specify the frequency at
which host metadata is sent to Datadog. The changes span multiple files
and include updates to configuration, factory methods, and test cases.

Enhancements to Datadog exporter:

*
[`.chloggen/add-configurable-reporter-period-for-host-metadata.yaml`](diffhunk://#diff-e3e3c57c49d2a921abc8470bccafabf4d632b0dc142eb3e95b3b6fac57107a11R1-R27):
Added a changelog entry for the new `reporter_period` parameter.
*
[`exporter/datadogexporter/examples/collector.yaml`](diffhunk://#diff-766be9823b8ec8b8de17e2c6c785d9f93e13b5a7e84ff441040077ab5e726a79R452-R456):
Added documentation for the new `reporter_period` parameter in the
example configuration file.
*
[`exporter/datadogexporter/factory.go`](diffhunk://#diff-c9e9f39ffda08a2af74c0d54d37f21e14cdb95c4136cdbe238de6be2bfe31389L127-R125):
Updated the factory to use the `reporter_period` from the configuration
instead of a hardcoded value.

Configuration updates:

*
[`exporter/datadogexporter/internal/hostmetadata/config.go`](diffhunk://#diff-0c9f0862d61390add366aca3e30834a1e01f16a3865ef9aca61831cad3459f53R31-R32):
Added `ReporterPeriod` to the `PusherConfig` struct.
*
[`pkg/datadog/config/config.go`](diffhunk://#diff-747858d4c8fea28a92227df09f17ebee01df63dad04812ac5d30a392c9970b73R136-R139):
Added validation for the `reporter_period` to ensure it is a positive
duration and set a default value.
[[1]](diffhunk://#diff-747858d4c8fea28a92227df09f17ebee01df63dad04812ac5d30a392c9970b73R136-R139)
[[2]](diffhunk://#diff-747858d4c8fea28a92227df09f17ebee01df63dad04812ac5d30a392c9970b73R347)

Test case updates:

* `exporter/datadogexporter/factory_test.go`,
`exporter/datadogexporter/logs_exporter_test.go`,
`exporter/datadogexporter/metrics_exporter_test.go`,
`exporter/datadogexporter/traces_exporter_test.go`: Updated test cases
to include the new `reporter_period` parameter.
[[1]](diffhunk://#diff-c50b6d1f06d62a58b6422f3218526437c16554faa2b7fc8eee1d32c021f00ca4R311)
[[2]](diffhunk://#diff-94f5b0119d06dbcfee20cd9b99a104ef208e027c166c463321670a5197e83714R233-R235)
[[3]](diffhunk://#diff-005adb1774d2a402bdd7adf3b6aa150117bf6b3c0bb634bf2c68c6b33f0ce1b5L61-R63)
[[4]](diffhunk://#diff-c19daad040b7310787c0012e5c660dc18a07ba16036d0eaa31a0e18c551d0ef3R148-R150)
*
[`pkg/datadog/config/config_test.go`](diffhunk://#diff-d3a3c19e78bbac07597c6210b4d051f4678df2752e06c82d0f040c52207c5970R97-R105):
Added test cases to validate the `reporter_period` configuration.
[[1]](diffhunk://#diff-d3a3c19e78bbac07597c6210b4d051f4678df2752e06c82d0f040c52207c5970R97-R105)
[[2]](diffhunk://#diff-d3a3c19e78bbac07597c6210b4d051f4678df2752e06c82d0f040c52207c5970R186-R197)
<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes #36450

<!--Describe what testing was performed and which tests were added.-->
#### Testing

<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

.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 < 5*time.Minute {
+		return errors.New("reporter_period must be 5 minutes or higher")
+	}
+
 	return nil
 }
 
@@ -340,6 +344,7 @@ func CreateDefaultConfig() component.Config {
 		HostMetadata: HostMetadataConfig{
 			Enabled:        true,
 			HostnameSource: HostnameSourceConfigOrSystem,
+			ReporterPeriod: 30 * time.Minute,
 		},
 	}
 }