Replace logger config template with strings #34346
Conversation
pgimalac
added
changelog/no-changelog
qa/done
github-actions
bot
added
the
short review
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 47fe5de Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | +1.26 | [+0.31, +2.20] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.09 | [-0.69, +0.88] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.02 | [-0.77, +0.81] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency_linear_load | egress throughput | +0.01 | [-0.46, +0.48] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.01 | [-0.29, +0.32] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.01, +0.02] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency_http1 | egress throughput | -0.00 | [-0.81, +0.81] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency_http2 | egress throughput | -0.00 | [-0.82, +0.82] | 1 | Logs |
| ➖ | file_to_blackhole_300ms_latency | egress throughput | -0.01 | [-0.64, +0.62] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.01 | [-0.67, +0.65] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.04 | [-0.86, +0.78] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.20 | [-0.25, -0.15] | 1 | Logs bounds checks dashboard |
| ➖ | file_tree | memory utilization | -0.23 | [-0.29, -0.17] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -0.33 | [-3.28, +2.62] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.37 | [-0.42, -0.32] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.64 | [-0.70, -0.59] | 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 | 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:
-
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_logs, bounds check intake_connections: 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.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate 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_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
|
That's a very fair comment, they should do the same but it's probably more correct to use the one from XML 😄 |
Test changes on VMUse this command from test-infra-definitions to manually test this PR changes on a VM: inv aws.create-vm --pipeline-id=57046881 --os-family=ubuntuNote: This applies to commit 6915272 |
Uncompressed package size comparisonComparison with ancestor Diff per package
Decision |
Static quality checks ✅Please find below the results from static quality gates Successful checksInfo
|
github-actions
bot
added
medium review
| if *generate { | ||
| err := os.WriteFile(expectedFileName, []byte(cfg), 0644) | ||
| require.NoError(t, err) | ||
| return | ||
| } |
There was a problem hiding this comment.
🥜 nitpick: Do we want to keep this and the generate flag since its purpose is to help writing test cases if I understand correctly ? Maybe having it commented
There was a problem hiding this comment.
Basically you can run go test ./setup/internal/... -generate to regenerate the fixtures if you updated the test cases
By default it just checks that the generated output is the one in the fixtures
I've seen this pattern in https://github.com/uber-go/dig/blob/master/visualize_golden_test.go#L34 and it seems pretty nice to me
You also don't have to change the code to generate the fixtures
I'll add a comment to make that clearer
What does this PR do?
Refactor seelog config string generation to avoid using a template.
Motivation
Using templates disables some dead code elimination, making binaries around 30% bigger.
We have other uses in the agent so this wouldn't improve existing binaries, but some POC of small processes would be impacted, eg. #34085.
Describe how you validated your changes
Added tests comparing the previously expected config strings with the ones currently generated.
The test cases were generated on the previous implementation, then run on the new one, the output was the same except for a single difference:
The special characters in
data-uriare encoded differently, this is because they were previously encoded for HTML but are now encoded for XML.https://docs.oracle.com/cd/A97335_02/apps.102/bc4j/developing_bc_projects/obcCustomXml.htm lists the special characters in XML.
Possible Drawbacks / Trade-offs
Additional Notes