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

usm: config: Default USM configuration should not warn about using network_config.enable_https_monitoring #31639

Merged
merged 4 commits into from
Dec 2, 2024

Conversation

guyarb
Copy link
Contributor

@guyarb guyarb commented Dec 2, 2024

What does this PR do?

This PR addresses a warning message generated when using the default configuration to enable USM.
The warning indicates that the configuration key network_config.enable_https_monitoring is deprecated and recommends using service_monitoring_config.tls.native.enabled instead.
The change ensures that the warning is not generated for the default configuration.

Motivation

Customers using the default configuration should not encounter warnings about deprecated configuration keys. This behavior may lead to confusion and unnecessary concerns, especially when no action is required for the default setup. The change improves the user experience and aligns with expected behavior.

Describe how to test/QA your changes

Covered by UTs TestUSMTLSNativeEnabled

Manual QA:

  1. Use the default configuration to enable USM.
    service_monitoring_config:
      enabled: true 
  2. Verify that no warnings about the deprecated key is generated in the logs.
    SYS-PROBE | WARN | (pkg/util/log/log.go:881 in func1) | configuration key `network_config.enable_https_monitoring` is deprecated, use `service_monitoring_config.tls.native.enabled` instead
    
  3. Confirm that HTTP monitoring is enabled
    SYS-PROBE | INFO | (pkg/network/usm/ebpf_main.go:596 in initProtocols) | openssl monitoring enabled
    

Possible Drawbacks / Trade-offs

Additional Notes

The issue was identified due to the following code snippet generating a warning:

if cfg.GetBool(smNS("enabled")) {
    applyDefault(cfg, netNS("enable_https_monitoring"), true)
    ...
}

...
deprecateBool(cfg, netNS("enable_https_monitoring"), smNS("tls", "native", "enabled"))
    if cfg.GetBool(smNS("enabled")) {
        applyDefault(cfg, spNS("enable_runtime_compiler"), true)
        applyDefault(cfg, spNS("enable_kernel_header_download"), true)

        applyDefault(cfg, discoveryNS("enabled"), true)
    }

...
    deprecateBool(cfg, netNS("enable_https_monitoring"), smNS("tls", "native", "enabled"))
    applyDefault(cfg, smNS("tls", "native", "enabled"), true)

This ensures default settings align with the new configuration key without generating unnecessary warnings.

@guyarb guyarb added changelog/no-changelog team/usm The USM team qa/done QA done before merge and regressions are covered by tests labels Dec 2, 2024
@guyarb guyarb requested review from a team as code owners December 2, 2024 07:07
@guyarb guyarb requested review from akarpz and Kaderinho and removed request for a team December 2, 2024 07:07
@guyarb guyarb changed the title Guy.arbitman/usmon 1369 usm: config: Default USM configuration should not warn about using network_config.enable_https_monitoring Dec 2, 2024
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Dec 2, 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=50217550 --os-family=ubuntu

Note: This applies to commit 582afdf

Copy link

cit-pr-commenter bot commented Dec 2, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: a6c8e540-6fe1-4683-a33b-b8773def8f48

Baseline: 0200b9d
Comparison: 582afdf
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.77 [-1.26, +4.79] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.80 [+0.06, +1.55] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.81, +0.83] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.11, +0.11] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.66, +0.63] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.08 [-0.85, +0.70] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.15 [-0.79, +0.48] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.15 [-0.63, +0.32] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.22 [-0.98, +0.55] 1 Logs
quality_gate_idle memory utilization -0.30 [-0.35, -0.25] 1 Logs bounds checks dashboard
otel_to_otel_logs ingress throughput -0.39 [-1.05, +0.27] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.40 [-0.45, -0.34] 1 Logs
file_tree memory utilization -0.53 [-0.68, -0.37] 1 Logs
quality_gate_idle_all_features memory utilization -1.74 [-1.88, -1.60] 1 Logs bounds checks dashboard
pycheck_lots_of_tags % cpu utilization -2.37 [-5.72, +0.99] 1 Logs
basic_py_check % cpu utilization -3.34 [-7.26, +0.58] 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_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_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 lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.

Base automatically changed from guy.arbitman/USMON-1368 to main December 2, 2024 09:50
…twork_config.enable_https_monitoring

Customers using the default configuration to enable USM will see a warning message indicating that a configuration key is deprecated.
Enabling USM enables the old configuration for https monitoring, which later generates a warning, although the customer didn't explicitly
use the deprecated configuration.

The change enables by default the new configuration option, without changing the behavior for backward compatibility
@guyarb
Copy link
Contributor Author

guyarb commented Dec 2, 2024

Blocked on #31567

@github-actions github-actions bot added the medium review PR review might take time label Dec 2, 2024
@github-actions github-actions bot added short review PR is simple enough to be reviewed quickly and removed medium review PR review might take time labels Dec 2, 2024
@guyarb
Copy link
Contributor Author

guyarb commented Dec 2, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 2, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-02 17:25:38 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 24m.

@dd-mergequeue dd-mergequeue bot merged commit 066618a into main Dec 2, 2024
300 checks passed
@dd-mergequeue dd-mergequeue bot deleted the guy.arbitman/USMON-1369 branch December 2, 2024 17:43
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/usm The USM team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants