[exporter/datadog] Add configurable reporter_period for host metadata by NassimBtk · Pull Request #36451 · open-telemetry/opentelemetry-collector-contrib

NassimBtk · 2024-11-19T17:20:57Z

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: Added a changelog entry for the new reporter_period parameter.
exporter/datadogexporter/examples/collector.yaml: Added documentation for the new reporter_period parameter in the example configuration file.
exporter/datadogexporter/factory.go: Updated the factory to use the reporter_period from the configuration instead of a hardcoded value.

Configuration updates:

exporter/datadogexporter/internal/hostmetadata/config.go: Added ReporterPeriod to the PusherConfig struct.
pkg/datadog/config/config.go: Added validation for the reporter_period to ensure it is a positive duration and set a default value. [1] [2]

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] [2] [3] [4]
pkg/datadog/config/config_test.go: Added test cases to validate the reporter_period configuration. [1] [2]

Link to tracking issue

Fixes #36450

Testing

Documentation

- Introduced a `reporter_period` field in `HostMetadataConfig` to allow customization of the metadata reporting interval. - Default value set to 30 minutes for backward compatibility. - Updated `pkg/datadog/config/host.go` to support the new `reporter_period` field. - Validated `reporter_period` in `pkg/datadog/config/config.go` to ensure positive durations. - Passed `reporter_period` to the metadata pusher in `exporter/datadogexporter/internal/hostmetadata/config.go`. - Modified `exporter/datadogexporter/hostmetadata.go` and `factory.go` to integrate `reporter_period` into the reporter logic. - Removed hardcoded constant for metadata reporting interval in favor of the configurable value. Fixes open-telemetry#36450

- Added a changelog entry

…igurable-reporter-period-for-host-metadata

- Fixed formatting

…atadogexporter-add-configurable-reporter-period-for-host-metadata

- make gofmt

…igurable-reporter-period-for-host-metadata

jade-guiton-dd

Everything looks good to me, just one small change. I'll probably take care of following up with #36522 once this is merged.

jade-guiton-dd · 2024-12-02T14:34:37Z

+	if c.HostMetadata.ReporterPeriod <= 0 {
+		return errors.New("reporter_period must be a positive duration")


We would like to prevent users from accidentally spamming the backend by setting the reporter period too low. The Agent currently has a minimum of 5 minutes, so unless you believe there to be strong use cases for even lower values, I think we should do the same here.

Suggested change

if c.HostMetadata.ReporterPeriod <= 0 {

return errors.New("reporter_period must be a positive duration")

if c.HostMetadata.ReporterPeriod < 5 * time.Minute {

return errors.New("reporter_period must be 5 minutes or higher")

Yes, that makes sense, we can go with minimum 5 minutes. It's already very good like this. Thank you!

@jade-guiton-dd

* Minimum reporter_period 5-minutes as suggested by @jade-guiton-dd

jade-guiton-dd

LGTM!

…open-telemetry#36451)  #### 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)  #### Link to tracking issue Fixes open-telemetry#36450  #### Testing  #### Documentation

NassimBtk added 2 commits November 19, 2024 18:00

[exporter/datadog] Add configurable reporter_period for host metadata

5588e25

- Added a changelog entry

NassimBtk requested review from a team, mx-psi and songy23 as code owners November 19, 2024 17:20

github-actions Bot assigned djaglowski Nov 19, 2024

github-actions Bot added exporter/datadog Datadog components pkg/datadog labels Nov 19, 2024

github-actions Bot requested review from ankitpatel96, dineshg13, liustanley and mackjmr November 19, 2024 17:21

NassimBtk added 5 commits November 19, 2024 18:24

Merge branch 'main' into feature/issue-36450-datadogexporter-add-conf…

6e2db4b

…igurable-reporter-period-for-host-metadata

[exporter/datadog] Add configurable reporter_period for host metadata

d141124

- Fixed formatting

Merge remote-tracking branch 'origin/main' into feature/issue-36450-d…

14ebcc7

…atadogexporter-add-configurable-reporter-period-for-host-metadata

[exporter/datadog] Add configurable reporter_period for host metadata

88aa1fb

- make gofmt

Merge branch 'main' into feature/issue-36450-datadogexporter-add-conf…

3fb9231

…igurable-reporter-period-for-host-metadata

songy23 reviewed Nov 20, 2024

View reviewed changes

Comment thread exporter/datadogexporter/factory.go

Merge branch 'main' into feature/issue-36450-datadogexporter-add-conf…

feddfd0

…igurable-reporter-period-for-host-metadata

github-actions Bot requested a review from jade-guiton-dd November 20, 2024 23:02

jade-guiton-dd reviewed Nov 21, 2024

View reviewed changes

Comment thread exporter/datadogexporter/logs_exporter_test.go

NassimBtk requested review from jade-guiton-dd and songy23 November 21, 2024 19:37

jade-guiton-dd mentioned this pull request Nov 25, 2024

[exporter/datadog] Host metrics export is never fully disabled #36522

Closed

jade-guiton-dd suggested changes Dec 2, 2024

View reviewed changes

[exporter/datadog] Add configurable reporter_period for host metadata

2bbe04b

* Minimum reporter_period 5-minutes as suggested by @jade-guiton-dd

NassimBtk requested a review from jade-guiton-dd December 2, 2024 18:04

jade-guiton-dd approved these changes Dec 3, 2024

View reviewed changes

mx-psi approved these changes Dec 3, 2024

View reviewed changes

mx-psi merged commit 5002476 into open-telemetry:main Dec 3, 2024

github-actions Bot added this to the next release milestone Dec 3, 2024

NassimBtk mentioned this pull request Dec 17, 2024

REQUEST: New membership for NassimBtk open-telemetry/community#2493

Closed

6 tasks

NassimBtk deleted the feature/issue-36450-datadogexporter-add-configurable-reporter-period-for-host-metadata branch December 23, 2024 13:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[exporter/datadog] Add configurable reporter_period for host metadata#36451

[exporter/datadog] Add configurable reporter_period for host metadata#36451
mx-psi merged 9 commits into
open-telemetry:mainfrom
sentrysoftware:feature/issue-36450-datadogexporter-add-configurable-reporter-period-for-host-metadata

NassimBtk commented Nov 19, 2024

Uh oh!

Uh oh!

Uh oh!

jade-guiton-dd left a comment

Uh oh!

jade-guiton-dd Dec 2, 2024

Uh oh!

NassimBtk Dec 2, 2024

Uh oh!

jade-guiton-dd left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

		if c.HostMetadata.ReporterPeriod <= 0 {
		return errors.New("reporter_period must be a positive duration")

Conversation

NassimBtk commented Nov 19, 2024

Description

Link to tracking issue

Testing

Documentation

Uh oh!

Uh oh!

Uh oh!

jade-guiton-dd left a comment

Choose a reason for hiding this comment

Uh oh!

jade-guiton-dd Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

NassimBtk Dec 2, 2024

Choose a reason for hiding this comment

Uh oh!

jade-guiton-dd left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants