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

[CTK-4175] Add token authentication to Process Agent endpoints #31940

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

daniel-taf
Copy link
Contributor

@daniel-taf daniel-taf commented Dec 9, 2024

What does this PR do?

This PR updates the process agent API server to require an auth token for any request.

Motivation

Describe how you validated your changes

Added unit tests and there are many existing tests that use the subcommands.

Possible Drawbacks / Trade-offs

Additional Notes

@github-actions github-actions bot added team/processes short review PR is simple enough to be reviewed quickly labels Dec 9, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 9, 2024

Test changes on VM

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

inv aws.create-vm --pipeline-id=51505862 --os-family=ubuntu

Note: This applies to commit 71cd2e2

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 9, 2024

Package size comparison

Comparison with ancestor b2fbed91df80d72c08950b8433e6981c3bc660b0

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb -0.02MB 1270.94MB 1270.96MB 140.00MB
datadog-iot-agent-amd64-deb 0.00MB ⚠️ 113.20MB 113.20MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.32MB 78.32MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB ⚠️ 526.45MB 526.45MB 70.00MB
datadog-agent-x86_64-rpm -0.02MB 1280.18MB 1280.20MB 140.00MB
datadog-agent-x86_64-suse -0.02MB 1280.18MB 1280.20MB 140.00MB
datadog-iot-agent-x86_64-rpm 0.00MB ⚠️ 113.26MB 113.26MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB ⚠️ 113.26MB 113.26MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.40MB 78.40MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.40MB 78.40MB 10.00MB
datadog-agent-arm64-deb 0.00MB ⚠️ 1005.13MB 1005.13MB 140.00MB
datadog-iot-agent-arm64-deb 0.00MB ⚠️ 108.67MB 108.67MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.59MB 55.59MB 10.00MB
datadog-agent-aarch64-rpm 0.00MB ⚠️ 1014.35MB 1014.35MB 140.00MB
datadog-iot-agent-aarch64-rpm 0.00MB ⚠️ 108.74MB 108.74MB 10.00MB

Decision

⚠️ Warning

@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Dec 13, 2024
@daniel-taf daniel-taf changed the title Add validation to process agent config endpoint Add token authentication to process agent API server Dec 13, 2024
@daniel-taf daniel-taf changed the title Add token authentication to process agent API server [CTK-4175] Add token authentication to process agent API server Dec 13, 2024
@daniel-taf daniel-taf added the qa/done QA done before merge and regressions are covered by tests label Dec 13, 2024
Copy link

cit-pr-commenter bot commented Dec 13, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 2b4d8cb2-79b5-4143-b753-8dcaed60bb2d

Baseline: 26052f9
Comparison: 71cd2e2
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +1.44 [+1.35, +1.52] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +1.11 [+0.39, +1.83] 1 Logs
file_tree memory utilization +0.55 [+0.41, +0.69] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.36 [-0.10, +0.83] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.34 [-0.42, +1.10] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.74, +0.77] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.10, +0.10] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.00 [-0.84, +0.84] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.85, +0.84] 1 Logs
otel_to_otel_logs ingress throughput -0.03 [-0.72, +0.67] 1 Logs
quality_gate_idle memory utilization -0.04 [-0.08, -0.00] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http2 egress throughput -0.07 [-0.89, +0.74] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.10 [-0.73, +0.53] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.33 [-1.11, +0.45] 1 Logs
quality_gate_idle_all_features memory utilization -0.81 [-0.95, -0.68] 1 Logs bounds checks dashboard
quality_gate_logs % cpu utilization -1.32 [-4.20, +1.56] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 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
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

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:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. 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.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, 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.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@daniel-taf daniel-taf force-pushed the daniel.tafoya/process-agent-configuration-endpoints-authentication branch from 2689611 to 13af369 Compare December 13, 2024 19:48
@daniel-taf daniel-taf marked this pull request as ready for review December 13, 2024 19:49
@daniel-taf daniel-taf requested a review from a team as a code owner December 13, 2024 19:49
@daniel-taf daniel-taf changed the title [CTK-4175] Add token authentication to process agent API server [CTK-4175] Add token authentication to Process Agent config endpoint Dec 13, 2024
@daniel-taf daniel-taf requested a review from a team as a code owner December 13, 2024 19:53
@daniel-taf daniel-taf force-pushed the daniel.tafoya/process-agent-configuration-endpoints-authentication branch from 6aeed13 to ea6130a Compare December 13, 2024 21:35
@daniel-taf daniel-taf added this to the 7.62.0 milestone Dec 13, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 13, 2024

Uncompressed package size comparison

Comparison with ancestor 26052f9b0fdb75103002f7090cab64a7c9a12aa2

Diff per package
package diff status size ancestor threshold
datadog-heroku-agent-amd64-deb 0.01MB ⚠️ 505.05MB 505.04MB 70.00MB
datadog-iot-agent-amd64-deb 0.01MB ⚠️ 113.31MB 113.30MB 10.00MB
datadog-iot-agent-arm64-deb 0.01MB ⚠️ 108.78MB 108.77MB 10.00MB
datadog-iot-agent-aarch64-rpm 0.01MB ⚠️ 108.84MB 108.84MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.01MB ⚠️ 113.38MB 113.37MB 10.00MB
datadog-iot-agent-x86_64-suse 0.01MB ⚠️ 113.38MB 113.37MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.58MB 78.58MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.78MB 55.78MB 10.00MB
datadog-agent-aarch64-rpm -0.00MB 942.98MB 942.98MB 140.00MB
datadog-agent-arm64-deb -0.00MB 933.77MB 933.77MB 140.00MB
datadog-agent-amd64-deb -0.01MB 1187.75MB 1187.76MB 140.00MB
datadog-agent-x86_64-rpm -0.01MB 1196.98MB 1197.00MB 140.00MB
datadog-agent-x86_64-suse -0.01MB 1196.98MB 1197.00MB 140.00MB

Decision

⚠️ Warning

@daniel-taf daniel-taf force-pushed the daniel.tafoya/process-agent-configuration-endpoints-authentication branch from ea6130a to d29bba9 Compare December 16, 2024 16:15
@daniel-taf daniel-taf force-pushed the daniel.tafoya/process-agent-configuration-endpoints-authentication branch from d29bba9 to d701e90 Compare December 18, 2024 17:36
@daniel-taf daniel-taf requested a review from a team as a code owner December 18, 2024 17:36
@daniel-taf daniel-taf changed the title [CTK-4175] Add token authentication to Process Agent config endpoint [CTK-4175] Add token authentication to Process Agent endpoints Dec 18, 2024
@misteriaud misteriaud self-requested a review December 18, 2024 20:35
Copy link
Contributor

@misteriaud misteriaud left a comment

Choose a reason for hiding this comment

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

Thanks a lot for the work you've done on it !
I left a few comments on details in unit tests.
The implementation part looks good to me 🎉

comp/process/apiserver/apiserver_test.go Outdated Show resolved Hide resolved
comp/process/apiserver/apiserver_test.go Outdated Show resolved Hide resolved
comp/process/apiserver/apiserver_test.go Outdated Show resolved Hide resolved
comp/process/apiserver/apiserver_test.go Outdated Show resolved Hide resolved
comp/process/apiserver/apiserver_test.go Outdated Show resolved Hide resolved
@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Dec 18, 2024
@daniel-taf
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 18, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-18 22:32:42 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2024-12-18 22:32:50 UTC ⚠️ MergeQueue: This merge request was unqueued

This merge request was unqueued

@daniel-taf
Copy link
Contributor Author

/remove

@dd-devflow
Copy link

dd-devflow bot commented Dec 18, 2024

Devflow running: /remove

View all feedbacks in Devflow UI.


2024-12-18 22:32:49 UTC ℹ️ Devflow: /remove

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants