datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

dyninst: create norms around setting up logging

Open ajwerner opened this issue 5 months ago • 2 comments

The primary thing here is to set up a utility function to set up logging consistently. The intention is to call this setup function in a TestMain.

Example of the default format:

d 16:03:28.177952641 @actuator.go:171| event: eventProgramAttached{programID: 1, processID: {PID:113694}}
d 16:03:28.179447592 @actuator.go:144| sending update: {[] [{PID:113694}]}
d 16:03:28.179522307 @actuator.go:171| event: eventProcessesUpdated{updated: 0, removed: 1}
d 16:03:28.179627972 @actuator.go:168| Received shutdown event

Json format:

{"time":1750953833754972794,"level":"Debug","msg":"event: eventProgramAttached{programID: 1, processID: {PID:113932}}","path":"actuator/actuator.go","func":"github.com/DataDog/datadog-agent/pkg/dyninst/actuator.(*Actuator).runEventProcessor","line":171}
{"time":1750953833757064633,"level":"Debug","msg":"sending update: {[] [{PID:113932}]}","path":"actuator/actuator.go","func":"github.com/DataDog/datadog-agent/pkg/dyninst/actuator.(*Actuator).HandleUpdate","line":144}
{"time":1750953833757162786,"level":"Debug","msg":"event: eventProcessesUpdated{updated: 0, removed: 1}","path":"actuator/actuator.go","func":"github.com/DataDog/datadog-agent/pkg/dyninst/actuator.(*Actuator).runEventProcessor","line":171}
{"time":1750953833757195137,"level":"Debug","msg":"Received shutdown event","path":"actuator/actuator.go","func":"github.com/DataDog/datadog-agent/pkg/dyninst/actuator.(*Actuator).runEventProcessor","line":168}

Relates to https://datadoghq.atlassian.net/browse/DEBUG-4107

ajwerner avatar Jun 26 '25 16:06 ajwerner

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: adf13add-c6d9-471d-9511-924b1aabe843

Baseline: aa571a04cdd93f79446665c988bf49f8957946aa Comparison: 931ee04613521ffc0c73a37c2ea2911176965c3a Diff

Optimization Goals: ✅ Improvement(s) detected

perf experiment goal Δ mean % Δ mean % CI trials links
file_tree memory utilization -5.03 [-5.15, -4.90] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
otlp_ingest_logs memory utilization +0.59 [+0.45, +0.72] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.19 [+0.12, +0.27] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.10 [-0.52, +0.71] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.07 [-0.49, +0.63] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.04 [-0.57, +0.66] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.03 [-0.57, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.28, +0.26] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.02 [-0.25, +0.22] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.58, +0.52] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.04 [-0.65, +0.58] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.10 [-0.70, +0.50] 1 Logs
ddot_logs memory utilization -0.13 [-0.22, -0.04] 1 Logs
ddot_metrics memory utilization -0.26 [-0.38, -0.15] 1 Logs
otlp_ingest_metrics memory utilization -0.47 [-0.64, -0.30] 1 Logs
quality_gate_idle memory utilization -1.12 [-1.17, -1.06] 1 Logs bounds checks dashboard
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -1.13 [-1.19, -1.07] 1 Logs
docker_containers_memory memory utilization -1.59 [-1.66, -1.51] 1 Logs
quality_gate_logs % cpu utilization -1.75 [-4.56, +1.05] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -1.87 [-2.72, -1.01] 1 Logs
quality_gate_idle_all_features memory utilization -2.24 [-2.33, -2.16] 1 Logs bounds checks dashboard
docker_containers_cpu % cpu utilization -2.91 [-6.00, +0.18] 1 Logs
file_tree memory utilization -5.03 [-5.15, -4.90] 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_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_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.

cit-pr-commenter[bot] avatar Jun 26 '25 16:06 cit-pr-commenter[bot]

Static quality checks

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

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${0}$$ $${700.51}$$ < $${700.55}$$ $${-0.04}$$ $${176.68}$$ < $${177.62}$$
agent_deb_amd64_fips $${0}$$ $${698.77}$$ < $${699.75}$$ $${-0.04}$$ $${176.14}$$ < $${177.04}$$
agent_heroku_amd64 $${0}$$ $${352.23}$$ < $${362.84}$$ $${+0}$$ $${95.1}$$ < $${98.91}$$
agent_msi $${0}$$ $${973.18}$$ < $${973.9}$$ $${0}$$ $${147.09}$$ < $${148.11}$$
agent_rpm_amd64 $${0}$$ $${700.5}$$ < $${700.53}$$ $${-0.02}$$ $${178.35}$$ < $${179.2}$$
agent_rpm_amd64_fips $${0}$$ $${698.76}$$ < $${699.74}$$ $${+0.03}$$ $${177.89}$$ < $${178.75}$$
agent_rpm_arm64 $${0}$$ $${690.4}$$ < $${690.5}$$ $${-0.02}$$ $${161.72}$$ < $${162.56}$$
agent_rpm_arm64_fips $${0}$$ $${688.78}$$ < $${689.8}$$ $${+0.03}$$ $${160.86}$$ < $${161.61}$$
agent_suse_amd64 $${0}$$ $${700.5}$$ < $${700.54}$$ $${-0.02}$$ $${178.35}$$ < $${179.2}$$
agent_suse_amd64_fips $${0}$$ $${698.76}$$ < $${699.74}$$ $${+0.03}$$ $${177.89}$$ < $${178.93}$$
agent_suse_arm64 $${0}$$ $${690.4}$$ < $${690.43}$$ $${-0.02}$$ $${161.72}$$ < $${162.57}$$
agent_suse_arm64_fips $${0}$$ $${688.78}$$ < $${689.78}$$ $${+0.03}$$ $${160.86}$$ < $${161.61}$$
docker_agent_amd64 $${+0}$$ $${784.31}$$ < $${784.33}$$ $${-0}$$ $${269.77}$$ < $${270.56}$$
docker_agent_arm64 $${+0}$$ $${797.66}$$ < $${797.68}$$ $${-0.01}$$ $${257.04}$$ < $${257.84}$$
docker_agent_jmx_amd64 $${+0}$$ $${975.5}$$ < $${975.52}$$ $${-0}$$ $${338.75}$$ < $${339.53}$$
docker_agent_jmx_arm64 $${+0}$$ $${977.45}$$ < $${977.47}$$ $${+0}$$ $${321.99}$$ < $${322.81}$$
docker_agent_windows1809 $${-0.07}$$ $${1184.77}$$ < $${1190.0}$$ $${+0.03}$$ $${417.38}$$ < $${422.66}$$
docker_agent_windows1809_core $${+0.24}$$ $${5914.8}$$ < $${5919.41}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_core_jmx $${+0}$$ $${6036.37}$$ < $${6063.56}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_jmx $${+0}$$ $${1306.47}$$ < $${1311.1}$$ $${+0}$$ $${459.65}$$ < $${464.35}$$
docker_agent_windows2022 $${-0.19}$$ $${1203.94}$$ < $${1208.75}$$ $${-0.02}$$ $${430.09}$$ < $${434.91}$$
docker_agent_windows2022_core $${+0}$$ $${5887.86}$$ < $${5892.66}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_core_jmx $${-0.02}$$ $${6009.54}$$ < $${6014.08}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_jmx $${-0}$$ $${1325.53}$$ < $${1330.39}$$ $${-0.02}$$ $${472.41}$$ < $${477.17}$$
docker_cluster_agent_amd64 $${+0}$$ $${213.62}$$ < $${214.5}$$ $${-0}$$ $${72.59}$$ < $${73.51}$$
docker_cluster_agent_arm64 $${+0}$$ $${229.45}$$ < $${230.33}$$ $${+0}$$ $${68.86}$$ < $${69.77}$$
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}$$ $${39.23}$$ < $${39.57}$$ $${+0}$$ $${15.12}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${+0}$$ $${37.88}$$ < $${38.2}$$ $${-0}$$ $${14.54}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${30.46}$$ < $${31.4}$$ $${+0}$$ $${8.0}$$ < $${8.95}$$
dogstatsd_deb_arm64 $${0}$$ $${29.03}$$ < $${29.97}$$ $${-0}$$ $${6.94}$$ < $${7.89}$$
dogstatsd_rpm_amd64 $${0}$$ $${30.46}$$ < $${31.4}$$ $${-0}$$ $${8.01}$$ < $${8.96}$$
dogstatsd_suse_amd64 $${0}$$ $${30.46}$$ < $${31.4}$$ $${-0}$$ $${8.01}$$ < $${8.96}$$
iot_agent_deb_amd64 $${0}$$ $${53.65}$$ < $${54.55}$$ $${-0}$$ $${13.51}$$ < $${14.45}$$
iot_agent_deb_arm64 $${0}$$ $${51.0}$$ < $${51.9}$$ $${+0}$$ $${11.7}$$ < $${12.63}$$
iot_agent_deb_armhf $${0}$$ $${50.51}$$ < $${51.42}$$ $${-0.02}$$ $${11.77}$$ < $${12.74}$$
iot_agent_rpm_amd64 $${0}$$ $${53.65}$$ < $${54.55}$$ $${-0}$$ $${13.53}$$ < $${14.47}$$
iot_agent_rpm_arm64 $${0}$$ $${51.0}$$ < $${51.91}$$ $${-0}$$ $${11.71}$$ < $${12.65}$$
iot_agent_suse_amd64 $${0}$$ $${53.65}$$ < $${54.55}$$ $${-0}$$ $${13.53}$$ < $${14.47}$$

/merge

ajwerner avatar Jun 30 '25 13:06 ajwerner

View all feedbacks in Devflow UI.

2025-06-30 13:02:46 UTC :information_source: Start processing command /merge


2025-06-30 13:02:53 UTC :information_source: 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-30 15:09:21 UTC :information_source: MergeQueue: merge request added to the queue

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


2025-06-30 15:49:54 UTC :information_source: MergeQueue: This merge request was merged

dd-devflow[bot] avatar Jun 30 '25 13:06 dd-devflow[bot]