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-2691] Change wording on FIPS Mode status indication #33507

Merged
merged 9 commits into from
Jan 29, 2025

Conversation

jeremy-hanna
Copy link
Contributor

What does this PR do?

This PR modifies the wording added in #33287 and supports a status indicator for the normal datadog-agent build re: FIPS Mode and if it is running in proxy status.

datadog-agent without the fips-proxy configured:
regular agent

datadog-agent with the fips-proxy configured:
regular agent fips-proxy

datadog-fips-agent without GOFIPS set:
fips agent GOFIPS=0

datadog-fips-agent with GOFIPS set:
datadog-fips-agent

Motivation

Describe how you validated your changes

  • added e2e tests around status display in the datadog-agent configurations
  • tested locally

Possible Drawbacks / Trade-offs

Additional Notes

@jeremy-hanna jeremy-hanna added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Jan 28, 2025
@jeremy-hanna jeremy-hanna requested a review from a team as a code owner January 28, 2025 22:21
@github-actions github-actions bot added the medium review PR review might take time label Jan 28, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 28, 2025

Uncompressed package size comparison

Comparison with ancestor d51bfeb4ee92686197d1a0ce731609d54e061297

Diff per package
package diff status size ancestor threshold
datadog-iot-agent-arm64-deb 0.00MB 89.87MB 89.87MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 89.94MB 89.94MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 93.87MB 93.87MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 93.87MB 93.87MB 0.50MB
datadog-agent-amd64-deb 0.00MB 911.86MB 911.86MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 921.60MB 921.60MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 921.60MB 921.60MB 0.50MB
datadog-agent-arm64-deb 0.00MB 899.26MB 899.26MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 908.98MB 908.98MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.01MB 59.01MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.09MB 59.09MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.09MB 59.09MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.50MB 56.50MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 477.81MB 477.81MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 93.80MB 93.80MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 28, 2025

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

Note: This applies to commit 698c4db

Copy link

cit-pr-commenter bot commented Jan 28, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 1f0191af-a632-4926-a6fd-f366b1b1f841

Baseline: d51bfeb
Comparison: 698c4db
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +1.78 [-1.30, +4.86] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.76 [+0.69, +0.82] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.71 [-0.08, +1.50] 1 Logs
file_tree memory utilization +0.34 [+0.27, +0.41] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.15 [-0.32, +0.62] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.03 [-0.25, +0.31] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.01 [-0.83, +0.86] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.87, +0.89] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.02] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.00 [-0.64, +0.63] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.78, +0.75] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.04 [-0.82, +0.74] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.07 [-0.99, +0.85] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.26 [-1.15, +0.64] 1 Logs
quality_gate_idle_all_features memory utilization -0.28 [-0.34, -0.22] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization -0.32 [-0.38, -0.26] 1 Logs bounds checks dashboard

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

)

// Status returns a displayable string or error of FIPS compliance state of the agent build and runtime
// Status returns a displayable string or error of FIPS Mode of the agent build and runtime
func Status() string {
enabled, _ := Enabled()
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ question: ‏Why do Enabled function returned error if we don't checks it ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The windows "FIPS Mode" has more error modes due to the OS registry look up but they did not want to log it or display that to the user at this point. It is _ in case we want to log it in the future or other users of the fips.Enabled() interface need to surface it.

func populateFIPSStatus(config config.Component) string {
fipsStatus := fips.Status()
if fipsStatus == "not available" && config.GetString("fips.enabled") == "true" {
return "proxy"
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ question: Does the Agent use necessarily FIPS proxy if fips.enabled: true? Can it be bypass by anything else ?

@jeremy-hanna
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 29, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-29 16:54:37 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 27m.


2025-01-29 17:23:17 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 517df3f into main Jan 29, 2025
228 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jeremy.hanna/change-wording-on-fips-status branch January 29, 2025 17:23
@github-actions github-actions bot added this to the 7.64.0 milestone Jan 29, 2025
@jeremy-hanna jeremy-hanna added the backport/7.63.x Automatically create a backport PR to 7.63.x label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/7.63.x Automatically create a backport PR to 7.63.x changelog/no-changelog medium review PR review might take time qa/done QA done before merge and regressions are covered by tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants