add common generic Get for system-probe checks #31254

brycekahle · 2024-11-19T23:11:20Z

What does this PR do?

Adds a GetCheck function to the system-probe client that handles the common use case for checks, which is requesting and unmarshaling JSON data.

Motivation

Split PR from #30936

Describe how to test/QA your changes

Tested manually and on staging.

Possible Drawbacks / Trade-offs

Additional Notes

Stacked PR on top of #31211

cit-pr-commenter · 2024-11-19T23:11:39Z

Go Package Import Differences

Baseline: 4b26774
Comparison: 4ebf049

binary	os	arch	change
process-agent	linux	amd64	+0, -4 -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/ebpfcheck/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/oomkill/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/tcpqueuelength/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/gpu/model
process-agent	linux	arm64	+0, -4 -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/ebpfcheck/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/oomkill/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/tcpqueuelength/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/gpu/model
process-agent	windows	amd64	+0, -1 -github.com/DataDog/datadog-agent/pkg/collector/corechecks/system/wincrashdetect/probe
heroku-process-agent	linux	amd64	+0, -4 -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/ebpfcheck/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/oomkill/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/ebpf/probe/tcpqueuelength/model -github.com/DataDog/datadog-agent/pkg/collector/corechecks/gpu/model

agent-platform-auto-pr · 2024-11-20T00:44:58Z

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=49668349 --os-family=ubuntu

Note: This applies to commit 4ebf049

cit-pr-commenter · 2024-11-20T01:18:38Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 401a86ee-e108-4bf8-8ec4-00de9dae6974

Baseline: 4b26774
Comparison: 4ebf049
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	file_tree	memory utilization	+0.77	[+0.64, +0.90]	1	Logs
➖	quality_gate_idle	memory utilization	+0.61	[+0.56, +0.66]	1	Logs bounds checks dashboard
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.52	[-0.21, +1.26]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	+0.52	[+0.40, +0.63]	1	Logs bounds checks dashboard
➖	tcp_syslog_to_blackhole	ingress throughput	+0.28	[+0.21, +0.36]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.24	[-0.23, +0.70]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	+0.03	[-0.72, +0.79]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.01, +0.01]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	-0.01	[-0.10, +0.09]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	-0.03	[-0.74, +0.68]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.04	[-0.82, +0.74]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.05	[-0.91, +0.80]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	-0.11	[-0.74, +0.52]	1	Logs
➖	pycheck_lots_of_tags	% cpu utilization	-0.64	[-4.08, +2.80]	1	Logs
➖	otel_to_otel_logs	ingress throughput	-0.68	[-1.33, -0.02]	1	Logs
➖	basic_py_check	% cpu utilization	-1.75	[-5.53, +2.02]	1	Logs

Bounds Checks: ❌ Failed

perf	experiment	bounds_check_name	replicates_passed	links
❌	file_to_blackhole_1000ms_latency	lost_bytes	0/10
✅	file_to_blackhole_0ms_latency	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency	memory_usage	10/10
✅	file_to_blackhole_1000ms_latency_linear_load	memory_usage	10/10
✅	file_to_blackhole_100ms_latency	lost_bytes	10/10
✅	file_to_blackhole_100ms_latency	memory_usage	10/10
✅	file_to_blackhole_300ms_latency	lost_bytes	10/10
✅	file_to_blackhole_300ms_latency	memory_usage	10/10
✅	file_to_blackhole_500ms_latency	lost_bytes	10/10
✅	file_to_blackhole_500ms_latency	memory_usage	10/10
✅	quality_gate_idle	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	memory_usage	10/10	bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

✅ = significantly better comparison variant performance
❌ = significantly worse comparison variant performance
➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.
Its configuration does not mark it "erratic".

CI Pass/Fail Decision

✅ Passed. All Quality Gates passed.

quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

guyarb · 2024-11-20T06:33:52Z

cmd/system-probe/api/client/client.go

+}
+
+func constructURL(module string, endpoint string) string {
+	u, _ := url.Parse("http://sysprobe")


since the operation is constant and it won't change if module and endpoint will be different, there is no need to preform the redundant parsing, and instead let's create a simple object that contains whatever you need

cmd/system-probe/api/client/client.go

guyarb · 2024-11-20T06:46:38Z

cmd/system-probe/api/client/client.go

+	return data, err
+}
+
+func constructURL(module string, endpoint string) string {


why do we need that function?
isn't url.JoinPath("http://sysprobe", module, endpoint) sufficient?

url.JoinPath doesn't support query parameters, while this function does. It isn't important for the generic checks, but there are other endpoints which use query parameters. Thus this property becomes important for some of the follow up PRs.

it does support query params
https://go.dev/play/p/fKevIj3hvh6

I'm not sure we actually need unescape, I'm assuming http client knows how to handle it

L3n41c

👍🏻 LGTM for files owned by @DataDog/container-integrations.

derekwbrown

approved for wkit file

derekwbrown

actually approved for 1 wkit file

brycekahle · 2024-11-21T21:43:39Z

/merge

dd-devflow · 2024-11-21T21:43:46Z

Devflow running: `/merge`

View all feedbacks in Devflow UI.

2024-11-21 21:43:46 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 24m.

brycekahle added changelog/no-changelog team/ebpf-platform qa/done QA done before merge and regressions are covered by tests labels Nov 19, 2024

brycekahle added this to the 7.61.0 milestone Nov 19, 2024

brycekahle requested review from a team as code owners November 19, 2024 23:11

brycekahle requested review from AmitaiBl and removed request for a team November 19, 2024 23:11

guyarb reviewed Nov 20, 2024

View reviewed changes

github-actions bot added the long review PR is complex, plan time to review it label Nov 20, 2024

guyarb reviewed Nov 20, 2024

View reviewed changes

cmd/system-probe/api/client/client.go Show resolved Hide resolved

guyarb reviewed Nov 20, 2024

View reviewed changes

guyarb approved these changes Nov 20, 2024

View reviewed changes

gjulianm approved these changes Nov 20, 2024

View reviewed changes

L3n41c approved these changes Nov 20, 2024

View reviewed changes

hmahmood approved these changes Nov 20, 2024

View reviewed changes

brycekahle force-pushed the bryce.kahle/sysprobe-listener branch from 8878e6f to 7a3925c Compare November 20, 2024 20:29

brycekahle requested review from a team as code owners November 20, 2024 20:29

brycekahle requested review from jeremy-hanna and removed request for AmitaiBl November 20, 2024 20:29

brycekahle force-pushed the bryce.kahle/check-sysprobe-client branch from e5464c0 to 00b2bf2 Compare November 20, 2024 22:30

brycekahle removed the request for review from a team November 20, 2024 22:30

brycekahle removed request for a team and jeremy-hanna November 20, 2024 22:30

brycekahle mentioned this pull request Nov 20, 2024

simplify flare requests for system-probe #31293

Merged

derekwbrown reviewed Nov 21, 2024

View reviewed changes

Base automatically changed from bryce.kahle/sysprobe-listener to main November 21, 2024 19:53

brycekahle added 4 commits November 21, 2024 12:23

add common generic Get for system-probe checks

cf82d89

add package comments

1d89e61

add missing comments

d49b9a7

ignore arguments

4ebf049

brycekahle force-pushed the bryce.kahle/check-sysprobe-client branch from 00b2bf2 to 4ebf049 Compare November 21, 2024 20:23

github-actions bot added the component/system-probe label Nov 21, 2024

derekwbrown approved these changes Nov 21, 2024

View reviewed changes

dd-mergequeue bot merged commit 0fdbad2 into main Nov 21, 2024
293 of 295 checks passed

dd-mergequeue bot deleted the bryce.kahle/check-sysprobe-client branch November 21, 2024 22:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add common generic Get for system-probe checks #31254

add common generic Get for system-probe checks #31254

brycekahle commented Nov 19, 2024

cit-pr-commenter bot commented Nov 19, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Nov 20, 2024 •

edited

Loading

cit-pr-commenter bot commented Nov 20, 2024 •

edited

Loading

Fine details of change detection per experiment

Explanation

guyarb Nov 20, 2024

guyarb Nov 20, 2024

brycekahle Nov 20, 2024

guyarb Nov 21, 2024

guyarb Nov 21, 2024

L3n41c left a comment

derekwbrown left a comment

derekwbrown left a comment

brycekahle commented Nov 21, 2024

dd-devflow bot commented Nov 21, 2024 •

edited

Loading

add common generic Get for system-probe checks #31254

add common generic Get for system-probe checks #31254

Conversation

brycekahle commented Nov 19, 2024

What does this PR do?

Motivation

Describe how to test/QA your changes

Possible Drawbacks / Trade-offs

Additional Notes

cit-pr-commenter bot commented Nov 19, 2024 • edited Loading

Go Package Import Differences

agent-platform-auto-pr bot commented Nov 20, 2024 • edited Loading

Test changes on VM

cit-pr-commenter bot commented Nov 20, 2024 • edited Loading

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

Bounds Checks: ❌ Failed

Explanation

CI Pass/Fail Decision

guyarb Nov 20, 2024

Choose a reason for hiding this comment

guyarb Nov 20, 2024

Choose a reason for hiding this comment

brycekahle Nov 20, 2024

Choose a reason for hiding this comment

guyarb Nov 21, 2024

Choose a reason for hiding this comment

guyarb Nov 21, 2024

Choose a reason for hiding this comment

L3n41c left a comment

Choose a reason for hiding this comment

derekwbrown left a comment

Choose a reason for hiding this comment

derekwbrown left a comment

Choose a reason for hiding this comment

brycekahle commented Nov 21, 2024

dd-devflow bot commented Nov 21, 2024 • edited Loading

Devflow running: /merge

cit-pr-commenter bot commented Nov 19, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Nov 20, 2024 •

edited

Loading

cit-pr-commenter bot commented Nov 20, 2024 •

edited

Loading

dd-devflow bot commented Nov 21, 2024 •

edited

Loading

Devflow running: `/merge`