[NCM] Add conf.yaml.example

[zoedt]

What does this PR do?

First pass on a conf.yaml.example to supplement public documentation for examples on how to configure the NCM integration

Motivation

Describe how you validated your changes

Additional Notes

[agent-platform-auto-pr]

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 3babb04

Successful checks

Info

	Quality gate	Delta	On disk size (MiB)	Delta	On wire size (MiB)
✅	agent_deb_amd64	$${+0.01}$$	$${705.22}$$ < $${706.32}$$	$${+0.03}$$	$${172.95}$$ < $${173.81}$$
✅	agent_deb_amd64_fips	$${+0.01}$$	$${700.06}$$ < $${701.16}$$	$${+0.01}$$	$${171.71}$$ < $${172.71}$$
✅	agent_heroku_amd64	$${+0.01}$$	$${326.42}$$ < $${327.69}$$	$${-0}$$	$${87.34}$$ < $${88.19}$$
✅	agent_msi	$${+0.01}$$	$${969.43}$$ < $${982.08}$$	$${-0.01}$$	$${141.41}$$ < $${143.01}$$
✅	agent_rpm_amd64	$${+0.01}$$	$${705.2}$$ < $${706.31}$$	$${+0.03}$$	$${176.0}$$ < $${176.86}$$
✅	agent_rpm_amd64_fips	$${+0.01}$$	$${700.05}$$ < $${701.15}$$	$${+0.02}$$	$${174.02}$$ < $${174.95}$$
✅	agent_rpm_arm64	$${+0.01}$$	$${690.87}$$ < $${691.67}$$	$${+0.05}$$	$${159.79}$$ < $${160.7}$$
✅	agent_rpm_arm64_fips	$${+0.01}$$	$${686.68}$$ < $${687.54}$$	$${+0.01}$$	$${159.13}$$ < $${160.1}$$
✅	agent_suse_amd64	$${+0.01}$$	$${705.2}$$ < $${706.31}$$	$${+0.03}$$	$${176.0}$$ < $${176.86}$$
✅	agent_suse_amd64_fips	$${+0.01}$$	$${700.05}$$ < $${701.15}$$	$${+0.02}$$	$${174.02}$$ < $${174.95}$$
✅	agent_suse_arm64	$${+0.01}$$	$${690.87}$$ < $${691.67}$$	$${+0.05}$$	$${159.79}$$ < $${160.7}$$
✅	agent_suse_arm64_fips	$${+0.01}$$	$${686.68}$$ < $${687.54}$$	$${+0.01}$$	$${159.13}$$ < $${160.1}$$
✅	docker_agent_amd64	$${+0.01}$$	$${767.54}$$ < $${768.66}$$	$${+0}$$	$${260.63}$$ < $${261.52}$$
✅	docker_agent_arm64	$${+0.01}$$	$${777.49}$$ < $${778.35}$$	$${-0}$$	$${250.81}$$ < $${251.72}$$
✅	docker_agent_jmx_amd64	$${+0.01}$$	$${958.42}$$ < $${959.54}$$	$${+0.01}$$	$${329.26}$$ < $${330.15}$$
✅	docker_agent_jmx_arm64	$${+0.01}$$	$${957.08}$$ < $${957.95}$$	$${-0}$$	$${315.43}$$ < $${316.35}$$
✅	docker_cluster_agent_amd64	$${+0}$$	$${178.88}$$ < $${179.28}$$	$${+0.01}$$	$${63.17}$$ < $${63.96}$$
✅	docker_cluster_agent_arm64	$${+0}$$	$${196.39}$$ < $${196.79}$$	$${+0}$$	$${59.89}$$ < $${60.69}$$
✅	docker_cws_instrumentation_amd64	$${0}$$	$${7.07}$$ < $${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.6}$$ < $${39.3}$$	$${-0}$$	$${14.91}$$ < $${15.76}$$
✅	docker_dogstatsd_arm64	$${+0.06}$$	$${37.3}$$ < $${37.94}$$	$${+0.01}$$	$${14.36}$$ < $${14.83}$$
✅	dogstatsd_deb_amd64	$${+0}$$	$${29.82}$$ < $${30.53}$$	$${+0}$$	$${7.87}$$ < $${8.75}$$
✅	dogstatsd_deb_arm64	$${+0}$$	$${28.33}$$ < $${29.11}$$	$${+0}$$	$${6.8}$$ < $${7.71}$$
✅	dogstatsd_rpm_amd64	$${+0}$$	$${29.82}$$ < $${30.53}$$	$${+0}$$	$${7.88}$$ < $${8.76}$$
✅	dogstatsd_suse_amd64	$${+0}$$	$${29.82}$$ < $${30.53}$$	$${+0}$$	$${7.88}$$ < $${8.76}$$
✅	iot_agent_deb_amd64	$${+0}$$	$${42.59}$$ < $${43.19}$$	$${+0}$$	$${11.12}$$ < $${11.98}$$
✅	iot_agent_deb_arm64	$${+0}$$	$${40.33}$$ < $${40.92}$$	$${+0}$$	$${9.58}$$ < $${10.45}$$
✅	iot_agent_deb_armhf	$${+0}$$	$${40.23}$$ < $${40.86}$$	$${-0}$$	$${9.69}$$ < $${10.56}$$
✅	iot_agent_rpm_amd64	$${+0}$$	$${42.59}$$ < $${43.19}$$	$${+0}$$	$${11.14}$$ < $${12.0}$$
✅	iot_agent_suse_amd64	$${+0}$$	$${42.59}$$ < $${43.19}$$	$${+0}$$	$${11.14}$$ < $${12.0}$$

[NouhaManai96]

are these the only possible values for algorithms or do we accept others ?

[zoedt]

i think there are more but i can be more explicit these are just some examples?

i can also just add the whole list of eligible stuff in this example yaml?

[NouhaManai96]

I thought that we were not introducing profiles at this time ?

[zoedt]

we have profiles they're just default only (no custom allowed) and the list is very small atm 🤣 lemme follow up re: this async in case i misunderstood anything in the mix of all the changes happening rn !

[cit-pr-commenter]

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: adf88d94-aeca-409a-9e3c-eef1991d5080

Baseline: 7843536
Comparison: ad4dd24
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	docker_containers_cpu	% cpu utilization	-3.38	[-6.29, -0.48]	1	Logs

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	quality_gate_logs	% cpu utilization	+0.90	[-0.57, +2.36]	1	Logs bounds checks dashboard
➖	otlp_ingest_metrics	memory utilization	+0.86	[+0.72, +1.00]	1	Logs
➖	otlp_ingest_logs	memory utilization	+0.71	[+0.61, +0.80]	1	Logs
➖	ddot_metrics	memory utilization	+0.26	[+0.04, +0.47]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	+0.07	[-0.34, +0.49]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.02	[-0.11, +0.15]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.01	[-0.03, +0.06]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.00	[-0.40, +0.40]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	-0.00	[-0.08, +0.07]	1	Logs
➖	uds_dogstatsd_20mb_12k_contexts_20_senders	memory utilization	-0.00	[-0.06, +0.05]	1	Logs
➖	uds_dogstatsd_to_api_v3	ingress throughput	-0.01	[-0.13, +0.12]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.05	[-0.42, +0.33]	1	Logs
➖	ddot_metrics_sum_delta	memory utilization	-0.07	[-0.28, +0.14]	1	Logs
➖	ddot_metrics_sum_cumulativetodelta_exporter	memory utilization	-0.09	[-0.32, +0.15]	1	Logs
➖	docker_containers_memory	memory utilization	-0.20	[-0.28, -0.12]	1	Logs
➖	ddot_logs	memory utilization	-0.22	[-0.29, -0.15]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	-0.25	[-0.33, -0.17]	1	Logs
➖	file_tree	memory utilization	-0.30	[-0.35, -0.25]	1	Logs
➖	ddot_metrics_sum_cumulative	memory utilization	-0.30	[-0.46, -0.15]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.40	[-0.45, -0.35]	1	Logs bounds checks dashboard
➖	quality_gate_metrics_logs	memory utilization	-0.41	[-0.63, -0.20]	1	Logs bounds checks dashboard
➖	quality_gate_idle	memory utilization	-0.53	[-0.58, -0.48]	1	Logs bounds checks dashboard
➖	docker_containers_cpu	% cpu utilization	-3.38	[-6.29, -0.48]	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_1000ms_latency	lost_bytes	10/10
✅	file_to_blackhole_1000ms_latency	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_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
✅	quality_gate_metrics_logs	cpu_usage	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	intake_connections	10/10	bounds checks dashboard
✅	quality_gate_metrics_logs	lost_bytes	10/10	bounds checks dashboard
✅	quality_gate_metrics_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_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.
• quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
• quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
• quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
• quality_gate_metrics_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_logs, bounds check memory_usage: 10/10 replicas passed. Gate 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.