Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ASCII-931][component] Create orchestrator forwarder component #21058

Merged
merged 21 commits into from
Dec 1, 2023

Conversation

ogaca-dd
Copy link
Contributor

@ogaca-dd ogaca-dd commented Nov 23, 2023

What does this PR do?

This PR extracts the orchestrator forwarder from the aggregator and create a new component.
Reviewing commit per commit is strongly recommended.

Motivation

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Perform sanity checks on the orchestrator forwarder.

Reviewer's Checklist

  • If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
  • Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
  • A release note has been added or the changelog/no-changelog label has been applied.
  • Changed code has automated tests for its functionality.
  • Adequate QA/testing plan information is provided if the qa/skip-qa label is not applied.
  • At least one team/.. label has been applied, indicating the team(s) that should QA this change.
  • If applicable, docs team has been notified or an issue has been opened on the documentation repo.
  • If applicable, the need-change/operator and need-change/helm labels have been applied.
  • If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
  • If applicable, the config template has been updated.

Copy link

cit-pr-commenter bot commented Nov 23, 2023

Go Package Import Differences

Baseline: 28bf6fd
Comparison: c3e47ca

binaryosarchchange
agentlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
agentlinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
agentwindowsamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
agentwindows386
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
agentdarwinamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
agentdarwinarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
iot-agentlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
iot-agentlinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
heroku-agentlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
cluster-agentlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
cluster-agentlinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
cluster-agent-cloudfoundrylinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
cluster-agent-cloudfoundrylinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
dogstatsdlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
dogstatsdlinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
process-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
process-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
process-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
process-agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
process-agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
heroku-process-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
security-agentlinuxamd64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
security-agentlinuxarm64
+2, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator/orchestratorimpl
serverlesslinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
serverlesslinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
system-probelinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
system-probelinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
system-probewindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentlinuxarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentwindowsamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentwindows386
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentdarwinamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
trace-agentdarwinarm64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator
heroku-trace-agentlinuxamd64
+1, -0
+github.com/DataDog/datadog-agent/comp/forwarder/orchestrator

@ogaca-dd ogaca-dd changed the title [component] Create orchestrator forwarder component [ASCII-931][component] Create orchestrator forwarder component Nov 23, 2023
@ogaca-dd ogaca-dd marked this pull request as ready for review November 23, 2023 14:57
@ogaca-dd ogaca-dd requested review from a team as code owners November 23, 2023 14:57
fx.Provide(func() demultiplexer.Params {
opts := aggregator.DefaultAgentDemultiplexerOptions()
opts.UseEventPlatformForwarder = false
opts.UseOrchestratorForwarder = false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As can be seen here, I believe the security agent does not need the orchestrator forwarder

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indeed, it doesn't and this is the reason why it is not enabled. See fx.Supply(orchestratorForwarderImpl.Params{UseOrchestratorForwarder: false}) few lines upper.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok indeed, what would happen if we did not provide the module and the params supply ? Wouldn't it default to disabled as well ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the demultiplexer uses the orchestrator forwarder, orchestrator forwarder is always mandatory when using the demultiplexer (Fx refuses to start the application if the module and the params are missing).
Note: There are units tests that check subcommands provides all the require modules and params. There is a linter to make sure all subcommand are tested (I also have a card to check there is no missing tests for other cases).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok understood

@paulcacheux
Copy link
Contributor

paulcacheux commented Nov 23, 2023

I think we have learned now that big-bang PRs like this one are difficult to test, and will probably lead to broken code paths. I would like to see this PR refactored and the migration done package by package, or at least team by team

@ogaca-dd
Copy link
Contributor Author

I think we have learned now that big-bang PRs like this one are difficult to test, and will probably lead to broken code paths. I would like to see this PR refactored and the migration done package by package, or at least team by team

@paulcacheux I understand your concern. Unlike many other PRs, I spent a fair amount of time to create small atomic commits to the better catch behaviour changes during review.
Note: Doing team by team changes is usually not possible because when you have to update a function is it usually used in many team code.

@pr-commenter
Copy link

pr-commenter bot commented Nov 23, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: e0ccbafb-c08a-4ec8-b176-d2e093136dfa
Baseline: 28bf6fd
Comparison: c3e47ca
Total datadog-agent CPUs: 7

Explanation

A regression test is an integrated performance test for datadog-agent in a repeatable rig, with varying configuration for datadog-agent. What follows is a statistical summary of a brief datadog-agent run for each configuration across SHAs given above. The goal of these tests are to determine quickly if datadog-agent performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

  1. The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.

  2. Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean % Δ mean % CI confidence
otel_to_otel_logs ingress throughput +0.30 [-1.28, +1.89] 24.63%
idle egress throughput +0.18 [-2.20, +2.56] 9.87%
uds_dogstatsd_to_api ingress throughput +0.04 [-0.14, +0.21] 27.21%
trace_agent_json ingress throughput +0.02 [-0.10, +0.14] 19.34%
file_to_blackhole egress throughput +0.02 [-1.00, +1.04] 2.19%
tcp_dd_logs_filter_exclude ingress throughput +0.02 [-0.14, +0.17] 12.71%
dogstatsd_string_interner_8MiB_100k ingress throughput +0.00 [-0.06, +0.06] 2.83%
dogstatsd_string_interner_8MiB_1k ingress throughput +0.00 [-0.11, +0.11] 0.52%
dogstatsd_string_interner_8MiB_50k ingress throughput +0.00 [-0.03, +0.03] 0.00%
dogstatsd_string_interner_128MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.08%
dogstatsd_string_interner_64MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.46%
dogstatsd_string_interner_64MiB_1k ingress throughput -0.00 [-0.13, +0.13] 0.82%
dogstatsd_string_interner_8MiB_10k ingress throughput -0.00 [-0.04, +0.04] 7.57%
dogstatsd_string_interner_8MiB_100 ingress throughput -0.00 [-0.13, +0.13] 2.45%
dogstatsd_string_interner_128MiB_1k ingress throughput -0.00 [-0.14, +0.14] 2.56%
trace_agent_msgpack ingress throughput -0.05 [-0.17, +0.08] 46.68%
file_tree egress throughput -0.42 [-2.23, +1.40] 29.59%
tcp_syslog_to_blackhole ingress throughput -0.83 [-0.96, -0.70] 100.00%

@@ -72,6 +73,8 @@ func main() {
),
fx.Provide(newForwarderParams),
demultiplexer.Module,
orchestratorForwarderImpl.Module,
fx.Supply(orchestratorForwarderImpl.NewDefaultParams()),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it should be disabled in the otel agent (like the security agent)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was previously enabled by calling aggregator.DefaultAgentDemultiplexerOptions() which set UseOrchestratorForwarder: true

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have got the confirmation from open telemetry team and it should not be enabled.

Copy link
Contributor

@clamoriniere clamoriniere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm for @DataDog/container-integrations files

@ogaca-dd ogaca-dd requested a review from mfpierre November 27, 2023 09:33
Copy link
Contributor

@mfpierre mfpierre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM overall, a few nits

ogaca-dd and others added 2 commits November 27, 2023 17:42
@ogaca-dd ogaca-dd requested a review from hush-hush November 29, 2023 10:01
@ogaca-dd ogaca-dd merged commit 04eeda4 into main Dec 1, 2023
143 checks passed
@ogaca-dd ogaca-dd deleted the olivierg/create-orchestrator-fwd branch December 1, 2023 10:29
wdhif pushed a commit that referenced this pull request Dec 4, 2023
* Move NewOrchestratorForwarder into a new component

* Reduce the number of calls to `InitAndStartAgentDemultiplexerForTest`
Goal: Make next commit easier
Note: DemultiplexerMock cannot be used in pkg/aggregator because comp/aggregator depends on  pkg/aggregator

* Use orchestrator forwarder component.

* Make orchestrator component optional

* Fix TestDemuxForwardersCreated

* Update CODEOWNERS (aggregator is owned by agent-metrics-logs)

* Fix linters

* Move the component to comp/forwarder/orchestrator

* Fix lint-components

* Fix Windows compilation issue

* Disable Orchestrator Forwarder for open telemetry

* Update .github/CODEOWNERS

Co-authored-by: Pierre Margueritte <[email protected]>

* Remove empty lines

* Improve comment for Component.Reset

* Use constructor for Params

* Fix windows linter

* Improve comments

* Fix code owner

---------

Co-authored-by: Pierre Margueritte <[email protected]>
wdhif pushed a commit that referenced this pull request Dec 4, 2023
* Move NewOrchestratorForwarder into a new component

* Reduce the number of calls to `InitAndStartAgentDemultiplexerForTest`
Goal: Make next commit easier
Note: DemultiplexerMock cannot be used in pkg/aggregator because comp/aggregator depends on  pkg/aggregator

* Use orchestrator forwarder component.

* Make orchestrator component optional

* Fix TestDemuxForwardersCreated

* Update CODEOWNERS (aggregator is owned by agent-metrics-logs)

* Fix linters

* Move the component to comp/forwarder/orchestrator

* Fix lint-components

* Fix Windows compilation issue

* Disable Orchestrator Forwarder for open telemetry

* Update .github/CODEOWNERS

Co-authored-by: Pierre Margueritte <[email protected]>

* Remove empty lines

* Improve comment for Component.Reset

* Use constructor for Params

* Fix windows linter

* Improve comments

* Fix code owner

---------

Co-authored-by: Pierre Margueritte <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants