Skip to content

Document auto_multi_line_detection in config template #37473

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 5 commits into from
Jun 11, 2025
Merged

Document auto_multi_line_detection in config template #37473

merged 5 commits into from
Jun 11, 2025

Conversation

jszwedko
Copy link
Contributor

What does this PR do?

Documents the logs_config.auto_multi_line_detection setting in the config template.

Motivation

This is an option we'd like to encourage use of and is commonly enabled by customers so we'd like to add it to the template.

Describe how you validated your changes

Will rely on CI to flag failures.

Possible Drawbacks / Trade-offs

More users will use this feature. If there are bugs, more users will be exposed to them. We don't anticipate this, though, and the value of the feature outweighs the risk.

Additional Notes

@jszwedko
Document auto_multi_line_detection in config template
5d491d0 
This is an option we'd like to encourage use of and is commonly enabled by customers.
@jszwedko jszwedko added the qa/done QA done before merge and regressions are covered by tests label May 28, 2025
@jszwedko jszwedko requested review from a team as code owners May 28, 2025 21:39
@jszwedko jszwedko requested a review from dustmop May 28, 2025 21:39
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label May 28, 2025
drichards-87
drichards-87 approved these changes May 28, 2025
View reviewed changes
Copy link
Contributor

@drichards-87 drichards-87 left a comment

Choose a reason for hiding this comment

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

Left a small suggestion from Docs and approved the PR.

@jszwedko @drichards-87
Update pkg/config/config_template.yaml
c66b1ec 
Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
@cit-pr-commenter cit-pr-commenter
Copy link

cit-pr-commenter bot commented May 28, 2025 •
edited
Loading

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 6169c7b9-8fa9-40c2-b1bd-af1b6bf577f1

Baseline: 7a0a040
Comparison: 3e9ae66
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
➖ uds_dogstatsd_to_api_cpu % cpu utilization +4.19 [+3.34, +5.05] 1 Logs
➖ docker_containers_cpu % cpu utilization +1.83 [-1.25, +4.92] 1 Logs
➖ quality_gate_logs % cpu utilization +1.59 [-1.20, +4.39] 1 Logs bounds checks dashboard
➖ otlp_ingest_metrics memory utilization +0.58 [+0.42, +0.75] 1 Logs
➖ uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.52 [+0.46, +0.59] 1 Logs
➖ file_tree memory utilization +0.16 [+0.02, +0.31] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput +0.05 [-0.51, +0.61] 1 Logs
➖ file_to_blackhole_0ms_latency_http1 egress throughput +0.03 [-0.57, +0.64] 1 Logs
➖ ddot_logs memory utilization +0.02 [-0.12, +0.16] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput +0.02 [-0.27, +0.30] 1 Logs
➖ file_to_blackhole_500ms_latency egress throughput +0.02 [-0.61, +0.64] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput +0.01 [-0.55, +0.58] 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.02 [-0.59, +0.56] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput -0.02 [-0.26, +0.21] 1 Logs
➖ file_to_blackhole_0ms_latency_http2 egress throughput -0.07 [-0.68, +0.54] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput -0.08 [-0.66, +0.51] 1 Logs
➖ otlp_ingest_logs memory utilization -0.15 [-0.28, -0.02] 1 Logs
➖ ddot_metrics memory utilization -0.16 [-0.28, -0.04] 1 Logs
➖ quality_gate_idle memory utilization -0.28 [-0.33, -0.22] 1 Logs bounds checks dashboard
➖ docker_containers_memory memory utilization -0.33 [-0.41, -0.25] 1 Logs
➖ quality_gate_idle_all_features memory utilization -0.92 [-1.01, -0.83] 1 Logs bounds checks dashboard
➖ tcp_syslog_to_blackhole ingress throughput -1.72 [-1.80, -1.64] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
✅ docker_containers_cpu simple_check_run 10/10
✅ docker_containers_memory memory_usage 10/10
✅ docker_containers_memory simple_check_run 10/10
✅ 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 bounds checks dashboard
✅ quality_gate_logs lost_bytes 10/10 bounds checks dashboard
✅ quality_gate_logs memory_usage 10/10 bounds checks dashboard

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

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 28, 2025 •
edited
Loading

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 7a0a040

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
✅ agent_deb_amd64 $${+0}$$ $${695.39}$$ < $${752.99}$$ $${+0.02}$$ $${175.93}$$ < $${187.44}$$
✅ agent_deb_amd64_fips $${+0}$$ $${693.61}$$ < $${751.36}$$ $${-0.04}$$ $${175.53}$$ < $${187.06}$$
✅ agent_heroku_amd64 $${+0}$$ $${358.19}$$ < $${369.68}$$ $${-0}$$ $${96.43}$$ < $${99.55}$$
✅ agent_msi $${0}$$ $${957.7}$$ < $${987.01}$$ $${-0.01}$$ $${146.1}$$ < $${150.72}$$
✅ agent_rpm_amd64 $${+0}$$ $${695.38}$$ < $${752.98}$$ $${+0.04}$$ $${177.46}$$ < $${190.03}$$
✅ agent_rpm_amd64_fips $${+0}$$ $${693.6}$$ < $${751.35}$$ $${+0.03}$$ $${177.34}$$ < $${189.81}$$
✅ agent_rpm_arm64 $${+0}$$ $${685.4}$$ < $${739.42}$$ $${-0.02}$$ $${160.81}$$ < $${171.23}$$
✅ agent_rpm_arm64_fips $${+0}$$ $${683.75}$$ < $${737.91}$$ $${+0.08}$$ $${160.05}$$ < $${170.22}$$
✅ agent_suse_amd64 $${+0}$$ $${695.38}$$ < $${752.98}$$ $${+0.04}$$ $${177.46}$$ < $${190.03}$$
✅ agent_suse_amd64_fips $${+0}$$ $${693.6}$$ < $${751.35}$$ $${+0.03}$$ $${177.34}$$ < $${189.81}$$
✅ agent_suse_arm64 $${+0}$$ $${685.4}$$ < $${739.42}$$ $${-0.02}$$ $${160.81}$$ < $${171.23}$$
✅ agent_suse_arm64_fips $${+0}$$ $${683.75}$$ < $${737.91}$$ $${+0.08}$$ $${160.05}$$ < $${170.22}$$
✅ docker_agent_amd64 $${+0}$$ $${779.18}$$ < $${849.39}$$ $${+0}$$ $${268.37}$$ < $${288.34}$$
✅ docker_agent_arm64 $${+0}$$ $${792.65}$$ < $${858.97}$$ $${-0}$$ $${255.78}$$ < $${274.36}$$
✅ docker_agent_jmx_amd64 $${+0}$$ $${970.38}$$ < $${1040.59}$$ $${+0}$$ $${337.36}$$ < $${357.3}$$
✅ docker_agent_jmx_arm64 $${+0}$$ $${972.44}$$ < $${1038.77}$$ $${+0}$$ $${320.72}$$ < $${339.32}$$
✅ docker_agent_windows1809 $${-0}$$ $${1485.79}$$ < $${1557.19}$$ $${-0.06}$$ $${487.59}$$ < $${507.33}$$
✅ docker_agent_windows1809_core $${+0}$$ $${6215.75}$$ < $${6287.46}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows1809_core_jmx $${+0}$$ $${6337.52}$$ < $${6409.04}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows1809_jmx $${-0}$$ $${1607.42}$$ < $${1679.14}$$ $${-0.05}$$ $${529.88}$$ < $${550.27}$$
✅ docker_agent_windows2022 $${+0.17}$$ $${1505.08}$$ < $${1576.85}$$ $${-0}$$ $${500.34}$$ < $${520.76}$$
✅ docker_agent_windows2022_core $${-0.02}$$ $${6189.03}$$ < $${6260.53}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows2022_core_jmx $${-0.03}$$ $${6310.64}$$ < $${6382.17}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows2022_jmx $${-0.14}$$ $${1626.68}$$ < $${1698.2}$$ $${+0.03}$$ $${542.65}$$ < $${562.99}$$
✅ docker_cluster_agent_amd64 $${-0}$$ $${259.21}$$ < $${259.73}$$ $${-0}$$ $${102.9}$$ < $${103.68}$$
✅ docker_cluster_agent_arm64 $${0}$$ $${273.64}$$ < $${274.24}$$ $${-0}$$ $${97.59}$$ < $${98.45}$$
✅ docker_cws_instrumentation_amd64 $${0}$$ $${7.08}$$ < $${7.12}$$ $${-0}$$ $${2.95}$$ < $${3.29}$$
✅ docker_cws_instrumentation_arm64 $${0}$$ $${6.69}$$ < $${6.92}$$ $${-0}$$ $${2.7}$$ < $${3.07}$$
✅ docker_dogstatsd_amd64 $${0}$$ $${38.76}$$ < $${39.57}$$ $${-0}$$ $${14.9}$$ < $${15.76}$$
✅ docker_dogstatsd_arm64 $${0}$$ $${37.4}$$ < $${38.2}$$ $${+0}$$ $${13.91}$$ < $${14.83}$$
✅ dogstatsd_deb_amd64 $${0}$$ $${30.44}$$ < $${31.52}$$ $${+0}$$ $${8.0}$$ < $${8.97}$$
✅ dogstatsd_deb_arm64 $${0}$$ $${29.01}$$ < $${30.08}$$ $${-0}$$ $${6.94}$$ < $${7.92}$$
✅ dogstatsd_rpm_amd64 $${0}$$ $${30.44}$$ < $${31.52}$$ $${-0}$$ $${8.0}$$ < $${8.98}$$
✅ dogstatsd_suse_amd64 $${0}$$ $${30.44}$$ < $${31.52}$$ $${-0}$$ $${8.0}$$ < $${8.98}$$
✅ iot_agent_deb_amd64 $${+0}$$ $${50.31}$$ < $${60.17}$$ $${-0}$$ $${12.8}$$ < $${15.82}$$
✅ iot_agent_deb_arm64 $${+0}$$ $${47.78}$$ < $${56.94}$$ $${-0}$$ $${11.11}$$ < $${13.86}$$
✅ iot_agent_deb_armhf $${+0}$$ $${47.35}$$ < $${56.41}$$ $${+0}$$ $${11.17}$$ < $${13.86}$$
✅ iot_agent_rpm_amd64 $${+0}$$ $${50.31}$$ < $${60.18}$$ $${-0}$$ $${12.82}$$ < $${15.84}$$
✅ iot_agent_rpm_arm64 $${+0}$$ $${47.78}$$ < $${56.94}$$ $${-0}$$ $${11.13}$$ < $${13.76}$$
✅ iot_agent_suse_amd64 $${+0}$$ $${50.31}$$ < $${60.18}$$ $${-0}$$ $${12.82}$$ < $${15.84}$$

@jszwedko
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 29, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-05-29 16:52:03 UTC ℹ️ Start processing command /merge

2025-05-29 16:52:13 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.

2025-05-29 20:53:08 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

@jszwedko
Copy link
Contributor Author

jszwedko commented Jun 6, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 6, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-06-06 23:35:38 UTC ℹ️ Start processing command /merge

2025-06-06 23:35:44 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.

2025-06-07 03:36:02 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

@jszwedko
Copy link
Contributor Author

jszwedko commented Jun 9, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 9, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-06-09 18:11:41 UTC ℹ️ Start processing command /merge

2025-06-09 18:11:48 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.

2025-06-09 22:12:02 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

@jszwedko
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 10, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-06-10 21:45:10 UTC ℹ️ Start processing command /merge

2025-06-10 21:46:15 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.

2025-06-10 23:38:04 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in main is approximately 47m (p90).

2025-06-11 00:16:44 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit f5ad55a into main Jun 11, 2025
237 checks passed
@dd-mergequeue dd-mergequeue bot deleted the jszwedko/document-auto_multi_line_detection branch June 11, 2025 00:16
@github-actions github-actions bot added this to the 7.68.0 milestone Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dustmop dustmop dustmop approved these changes

@drichards-87 drichards-87 drichards-87 approved these changes

Assignees
No one assigned
Labels
changelog/no-changelog qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly
Projects
None yet
Milestone
7.68.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jszwedko @dustmop @drichards-87