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

Add auth token requirement for trace-agent set log_level (APMSP-1204) #31448

Merged
merged 17 commits into from
Dec 3, 2024

Conversation

ajgajg1134
Copy link
Contributor

@ajgajg1134 ajgajg1134 commented Nov 25, 2024

What does this PR do?

Requires the agent's auth token to modify the trace-agent's log level.

Motivation

It's important that changes to log level are only done by authenticated users

Describe how to test/QA your changes

I tested this change using a local agent where I used Fleet Management to request a remote flare, this then triggered remote config to update the log level to debug mode which it did correctly and with a valid authentication token.

Possible Drawbacks / Trade-offs

I don't love needing to pass this GetAuthToken function into the agent config but it was the most reasonable way I could determine to do this while avoiding importing pkg/config (which is very large and we don't want it in pkg/trace)

Additional Notes

@github-actions github-actions bot added team/agent-apm trace-agent long review PR is complex, plan time to review it labels Nov 25, 2024
Copy link
Contributor

@ichinaski ichinaski left a comment

Choose a reason for hiding this comment

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

LGTM, just small question about a function whose use I cannot really spot

cmd/trace-agent/test/runner.go Outdated Show resolved Hide resolved
@ajgajg1134 ajgajg1134 requested a review from ichinaski November 26, 2024 19:23
Copy link

cit-pr-commenter bot commented Nov 26, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 6d82191e-6c6f-4719-a9cd-e443d9811099

Baseline: 1c2acb4
Comparison: f47ffbe
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
pycheck_lots_of_tags % cpu utilization +2.83 [-0.68, +6.35] 1 Logs
quality_gate_idle_all_features memory utilization +2.53 [+2.41, +2.65] 1 Logs bounds checks dashboard
otel_to_otel_logs ingress throughput +1.23 [+0.55, +1.92] 1 Logs
quality_gate_idle memory utilization +0.45 [+0.41, +0.49] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput +0.37 [+0.31, +0.44] 1 Logs
quality_gate_logs % cpu utilization +0.29 [-2.65, +3.23] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.09 [-0.68, +0.85] 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.00 [-0.88, +0.88] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.10, +0.09] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.01 [-0.64, +0.63] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.03 [-0.81, +0.74] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.08 [-0.82, +0.67] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.10 [-0.57, +0.36] 1 Logs
file_tree memory utilization -0.14 [-0.29, +0.00] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.40 [-1.13, +0.32] 1 Logs
basic_py_check % cpu utilization -2.85 [-6.59, +0.90] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_500ms_latency lost_bytes 9/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 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_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.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.

@ajgajg1134 ajgajg1134 changed the title Add auth token requirement for trace-agent set log_level Add auth token requirement for trace-agent set log_level (APMSP-1204) Nov 26, 2024
@ajgajg1134 ajgajg1134 marked this pull request as ready for review November 26, 2024 21:02
@ajgajg1134 ajgajg1134 requested review from a team as code owners November 26, 2024 21:02
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 26, 2024

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=50295805 --os-family=ubuntu

Note: This applies to commit f47ffbe

Copy link
Contributor

@jhgilbert jhgilbert left a comment

Choose a reason for hiding this comment

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

Approved with a minor suggestion, thanks!

comp/trace/config/config.go Outdated Show resolved Hide resolved
@ajgajg1134 ajgajg1134 added the qa/done QA done before merge and regressions are covered by tests label Dec 2, 2024
@ajgajg1134 ajgajg1134 requested a review from ogaca-dd December 2, 2024 20:04
@ajgajg1134 ajgajg1134 requested a review from a team as a code owner December 3, 2024 18:37
Copy link
Member

@gh123man gh123man left a comment

Choose a reason for hiding this comment

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

AML owned files LGTM

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 3, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-03 21:13:07 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-03 22:42:48 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 22m.

@dd-mergequeue dd-mergequeue bot merged commit e6017fd into main Dec 3, 2024
383 of 385 checks passed
@dd-mergequeue dd-mergequeue bot deleted the andrew.glaude/authLogLevel branch December 3, 2024 23:11
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 3, 2024
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/agent-apm trace-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants