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

Fix the setting of host field in contlcycle, contimage and sbom events #20074

Merged
merged 1 commit into from
Oct 12, 2023

Conversation

L3n41c
Copy link
Member

@L3n41c L3n41c commented Oct 11, 2023

What does this PR do?

Fix the setting of the host field in containerlifecyclevents, containerimage and sbom messages.

Motivation

Prior to #16084, this host field was set inside “specific” serializers:

Now that those “specific” serializers have been superseded by the generic Event Platform pipeline, the host field needs to be set elsewhere.
It needs to be set before being marshaled and the marshaling in now happening in the checks themselves.

#20025 was using "github.com/DataDog/datadog-agent/pkg/security/utils".GetHostname().

// GetHostname attempts to acquire a hostname by connecting to the core agent's
// gRPC endpoints
func GetHostname() (string, error) {
var hostname string
err := retry.Do(func() error {
ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
defer cancel()
client, err := grpc.GetDDAgentClient(ctx)
if err != nil {
return err
}
reply, err := client.GetHostname(ctx, &pbgo.HostnameRequest{})
if err != nil {
return err
}
log.Debugf("Acquired hostname from gRPC: %s", reply.Hostname)

But this function is doing a gRPC call to the core agent to get the hostname. It’s useless as this piece of code is already in the core agent. So, no need to do a gRPC call.

Additional Notes

Followup of #20025.

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Look for the host field in the output of agent stream-event-platform.

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.

@pr-commenter
Copy link

pr-commenter bot commented Oct 11, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: abd2df59-ae64-44e4-a5f8-baeacb1ec596
Baseline: 915f5e1
Comparison: 09d4535
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
uds_dogstatsd_to_api ingress throughput +2.32 [+0.16, +4.47] 92.28%
otel_to_otel_logs ingress throughput +0.39 [-1.22, +1.99] 30.97%
file_to_blackhole egress throughput +0.12 [-1.27, +1.51] 11.35%
trace_agent_msgpack ingress throughput +0.05 [-0.06, +0.16] 52.06%
trace_agent_json ingress throughput +0.02 [-0.11, +0.14] 18.09%
uds_dogstatsd_to_api_nodist_64MiB ingress throughput +0.00 [-0.13, +0.13] 0.56%
uds_dogstatsd_to_api_nodist_100MiB ingress throughput +0.00 [-0.13, +0.13] 0.44%
uds_dogstatsd_to_api_nodist_16MiB ingress throughput +0.00 [-0.12, +0.12] 0.17%
uds_dogstatsd_to_api_nodist_32MiB ingress throughput -0.00 [-0.13, +0.13] 0.91%
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.07, +0.06] 5.60%
uds_dogstatsd_to_api_nodist_1MiB ingress throughput -0.01 [-0.03, +0.00] 81.25%
uds_dogstatsd_to_api_nodist_200MiB ingress throughput -0.32 [-0.43, -0.21] 100.00%
tcp_syslog_to_blackhole ingress throughput -0.52 [-0.66, -0.37] 100.00%
file_tree egress throughput -2.96 [-5.16, -0.77] 97.36%

@lebauce
Copy link
Contributor

lebauce commented Oct 11, 2023

diff --git a/pkg/collector/corechecks/containerimage/processor_test.go b/pkg/collector/corechecks/containerimage/processor_test.go
index 21567e5d42..9f45e8cbe4 100644
--- a/pkg/collector/corechecks/containerimage/processor_test.go
+++ b/pkg/collector/corechecks/containerimage/processor_test.go
@@ -6,6 +6,7 @@
 package containerimage
 
 import (
+       "context"
        "testing"
        "time"
 
@@ -19,6 +20,7 @@ import (
 
        "github.com/DataDog/datadog-agent/pkg/aggregator/mocksender"
        "github.com/DataDog/datadog-agent/pkg/epforwarder"
+       "github.com/DataDog/datadog-agent/pkg/util/hostname"
        "github.com/DataDog/datadog-agent/pkg/util/pointer"
        "github.com/DataDog/datadog-agent/pkg/workloadmeta"
 )
@@ -435,8 +437,10 @@ func TestProcessEvents(t *testing.T) {
                                return imagesSent.Load() == int32(len(test.expectedImages))
                        }, 1*time.Second, 5*time.Millisecond)
 
+                       hname, _ := hostname.Get(context.TODO())
                        for _, expectedImage := range test.expectedImages {
                                encoded, err := proto.Marshal(&model.ContainerImagePayload{
+                                       Host:    hname,
                                        Version: "v1",
                                        Source:  &sourceAgent,
                                        Images:  []*model.ContainerImage{expectedImage},
diff --git a/pkg/collector/corechecks/containerlifecycle/processor_test.go b/pkg/collector/corechecks/containerlifecycle/processor_test.go
index aa5542def0..0ec8e1ff0b 100644
--- a/pkg/collector/corechecks/containerlifecycle/processor_test.go
+++ b/pkg/collector/corechecks/containerlifecycle/processor_test.go
@@ -14,11 +14,13 @@ import (
 
        "github.com/DataDog/datadog-agent/pkg/aggregator/mocksender"
        checkid "github.com/DataDog/datadog-agent/pkg/collector/check/id"
+       "github.com/DataDog/datadog-agent/pkg/util/hostname"
 
        "github.com/stretchr/testify/mock"
 )
 
 func TestProcessQueues(t *testing.T) {
+       hostname, _ := hostname.Get(context.TODO())
        tests := []struct {
                name            string
                containersQueue *queue
@@ -34,7 +36,7 @@ func TestProcessQueues(t *testing.T) {
                {
                        name: "one container",
                        containersQueue: &queue{data: []*model.EventsPayload{
-                               {Version: "v1", Events: modelEvents("cont1")},
+                               {Version: "v1", Events: modelEvents("cont1"), Host: hostname},
                        }},
                        podsQueue: &queue{},
                        wantFunc: func(t *testing.T, s *mocksender.MockSender) {
@@ -44,12 +46,12 @@ func TestProcessQueues(t *testing.T) {
                {
                        name: "multiple chunks per types",
                        containersQueue: &queue{data: []*model.EventsPayload{
-                               {Version: "v1", Events: modelEvents("cont1", "cont2")},
-                               {Version: "v1", Events: modelEvents("cont3")},
+                               {Version: "v1", Events: modelEvents("cont1", "cont2"), Host: hostname},
+                               {Version: "v1", Events: modelEvents("cont3"), Host: hostname},
                        }},
                        podsQueue: &queue{data: []*model.EventsPayload{
-                               {Version: "v1", Events: modelEvents("pod1", "pod2")},
-                               {Version: "v1", Events: modelEvents("pod3")},
+                               {Version: "v1", Events: modelEvents("pod1", "pod2"), Host: hostname},
+                               {Version: "v1", Events: modelEvents("pod3"), Host: hostname},
commit 0f9ef05df2b9be0c5da2776a680eb4e0bdc7c993 (HEAD -> lenaic/send_host)
Author: Sylvain Baubeau <[email protected]>
Date:   Wed Oct 11 23:03:06 2023 +0200

    Fix unit tests

diff --git a/pkg/collector/corechecks/containerimage/processor_test.go b/pkg/collector/corechecks/containerimage/processor_test.go
index 21567e5d42..9f45e8cbe4 100644
--- a/pkg/collector/corechecks/containerimage/processor_test.go
+++ b/pkg/collector/corechecks/containerimage/processor_test.go
@@ -6,6 +6,7 @@
 package containerimage
 
 import (
+       "context"
        "testing"
        "time"
 
@@ -19,6 +20,7 @@ import (
 
        "github.com/DataDog/datadog-agent/pkg/aggregator/mocksender"
        "github.com/DataDog/datadog-agent/pkg/epforwarder"
+       "github.com/DataDog/datadog-agent/pkg/util/hostname"
        "github.com/DataDog/datadog-agent/pkg/util/pointer"
        "github.com/DataDog/datadog-agent/pkg/workloadmeta"
 )
@@ -435,8 +437,10 @@ func TestProcessEvents(t *testing.T) {
                                return imagesSent.Load() == int32(len(test.expectedImages))
                        }, 1*time.Second, 5*time.Millisecond)
 
+                       hname, _ := hostname.Get(context.TODO())
                        for _, expectedImage := range test.expectedImages {
                                encoded, err := proto.Marshal(&model.ContainerImagePayload{
+                                       Host:    hname,
                                        Version: "v1",
                                        Source:  &sourceAgent,
                                        Images:  []*model.ContainerImage{expectedImage},
diff --git a/pkg/collector/corechecks/containerlifecycle/processor_test.go b/pkg/collector/corechecks/containerlifecycle/processor_test.go
index aa5542def0..0ec8e1ff0b 100644
--- a/pkg/collector/corechecks/containerlifecycle/processor_test.go
+++ b/pkg/collector/corechecks/containerlifecycle/processor_test.go
@@ -14,11 +14,13 @@ import (
 
        "github.com/DataDog/datadog-agent/pkg/aggregator/mocksender"
        checkid "github.com/DataDog/datadog-agent/pkg/collector/check/id"
+       "github.com/DataDog/datadog-agent/pkg/util/hostname"
 
        "github.com/stretchr/testify/mock"
 )
 
 func TestProcessQueues(t *testing.T) {
+       hostname, _ := hostname.Get(context.TODO())

@cit-pr-commenter
Copy link

Go Package Import Differences

Baseline: 915f5e1
Comparison: 09d4535

binaryosarchchange
agentlinuxamd64
+0, -2
-github.com/DataDog/datadog-agent/pkg/security/common/containerutils
-github.com/DataDog/datadog-agent/pkg/security/utils
agentlinuxarm64
+0, -2
-github.com/DataDog/datadog-agent/pkg/security/common/containerutils
-github.com/DataDog/datadog-agent/pkg/security/utils

@L3n41c L3n41c merged commit ad11347 into main Oct 12, 2023
7 checks passed
@L3n41c L3n41c deleted the lenaic/send_host branch October 12, 2023 10:26
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.

3 participants