Skip to content

[AMCC-177][metric filterlist] Fix various bugs in filterlist component#47825

Open
olivielpeau wants to merge 7 commits intomainfrom
olivielpeau/filter-list-fixes
Open

[AMCC-177][metric filterlist] Fix various bugs in filterlist component#47825
olivielpeau wants to merge 7 commits intomainfrom
olivielpeau/filter-list-fixes

Conversation

@olivielpeau
Copy link
Member

@olivielpeau olivielpeau commented Mar 13, 2026

What does this PR do?

This PR fixes several bugs in the comp/filterlist component that handles metric and tag filter lists (used by the metric_filterlist feature), and adds an e2e test for metric filtering (in order to prevent any re-occurence of the regression fixed in #47604)

Reviewer tips

  • the PR has been split into small commits that can be reviewed separately
  • Leaving aside test files, only agent-metric-pipelines-owned files are actually modified

Fixes

  • (mid/high impact) Data race in GetTagFilterList and tag filter callbacks: GetTagFilterList previously returned &fl.tagFilterList without holding a lock; callbacks passed the same pointer to long-running workers, causing a race when setTagFilterList overwrote the value concurrently. Fixed by changing ShouldStripTags to a value receiver and making GetTagFilterList return a copy under RLock.

  • (low impact) Incorrect filter list used during DogStatsD worker initialization: Workers were initialized with GetMetricFilterList() (the full filter list) but subsequently updated via SetSamplersFilterList with the histogram-specific subset. This caused over-filtering between startup and the first OnUpdateMetricFilterList callback. Fixed by adding GetHistoFilterList() to the interface and using it at worker initialization. Low impact because in practice this "over-filtering" should never actually impact which metrics are actually filtered or not (it only impacts performance slightly because a larger filter list is unnecessarily used).

  • (low impact) Immediate callback invocation on registration (OnUpdate*): Registration callbacks now only register; callers initialize via Get*() methods directly. Initial filter list values are passed to NewBufferedAggregator at construction time, eliminating the post-constructor assignment pattern. Added nil-guard for TagMatcher in trackContext.

  • (low impact) Wrong logger used in tagfilterlist.go: The file imported the trace agent logger instead of the correct one.

  • (low impact) Warning log format in tagfilterlist: Fixed format string.

E2E Test

Added a new E2E test suite under test/new-e2e/tests/agent-metric-pipelines/metric-filterlist/ that verifies:

  • Metrics listed in metric_filterlist are not forwarded to the intake.
  • Unlisted metrics are forwarded normally.

Uses the awshost provisioner with DogStatsD UDP delivery and fakeintake for assertions.

Describe how you validated your changes

All changes should be covered by unit tests. No additional manual testing was performed.

Additional Notes

olivielpeau and others added 7 commits March 13, 2026 17:22
DogStatsD workers use `flushFilterList` (a post-aggregation filter) only
for histogram metrics, whose expanded names (`.count`, `.avg`, etc.) are
only known after aggregation. Regular DogStatsD metrics are pre-filtered
in the listeners before reaching workers.

The workers were initialized with `GetMetricFilterList()` (the full filter
list) but updated via `SetSamplersFilterList` with the histogram-specific
subset. This mismatch caused workers to over-filter during the brief window
between startup and the first `OnUpdateMetricFilterList` callback.

Fix by adding `GetHistoFilterList()` to the `filterlist.Component` interface
and using it during worker initialization, making it consistent with the
value sent on every subsequent update.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…or consistency

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
GetTagFilterList returned &fl.tagFilterList without a lock; callbacks in
setTagFilterList and OnUpdateTagFilterList passed the same pointer to
long-running workers. A concurrent setTagFilterList overwrite raced with
any reader holding that pointer.

Fix by changing ShouldStripTags to a value receiver, so tagMatcher
satisfies filterlist.TagMatcher directly. GetTagFilterList now holds
RLock and returns a value copy; callbacks receive a value copy too.

BenchmarkTimeSampler (5 runs, -race): no statistically significant
change (~76 ns/op, 0 allocs/op before and after).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…stration methods

Registration callbacks now only register; callers initialize themselves directly
via Get*() methods. Pass initial filter list values to NewBufferedAggregator so
the aggregator is fully initialized at construction time, eliminating the
post-constructor assignment pattern. Add nil-guard for TagMatcher in
trackContext so nil is a valid no-op value for test callers.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add a new test suite under test/new-e2e/tests/agent-metric-pipelines/metric-filterlist/
that verifies metrics listed in metric_filterlist are not forwarded to the intake,
while unlisted metrics are forwarded normally.

Uses the awshost provisioner with DogStatsD UDP delivery via /dev/udp on the remote
host, and fakeintake for assertion.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Various var renames/comments, all no-ops *except* the change of
import in comp/filterlist/impl/tagfilterlist.go so that the correct
logger is used (instead of the trace agent's logger)
@agent-platform-auto-pr
Copy link
Contributor

Go Package Import Differences

Baseline: 9ebd458
Comparison: 3354120

binaryosarchchange
dogstatsdlinuxamd64
+0, -1
-github.com/DataDog/datadog-agent/pkg/trace/log
dogstatsdlinuxarm64
+0, -1
-github.com/DataDog/datadog-agent/pkg/trace/log

@olivielpeau olivielpeau added qa/done QA done before merge and regressions are covered by tests changelog/no-changelog No changelog entry needed and removed team/agent-integrations labels Mar 13, 2026
Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 335412017e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment on lines 324 to 326
fl.updateMetricMtx.Lock()
fl.metricFilterListUpdate = append(fl.metricFilterListUpdate, onUpdate)
fl.updateMetricMtx.Unlock()

Choose a reason for hiding this comment

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

P2 Badge Replay current metric filter list on callback registration

OnUpdateMetricFilterList now only stores the callback, so it no longer delivers the current matcher when a consumer subscribes. Both the DogStatsD server and demultiplexer subscribe after worker startup (comp/dogstatsd/server/server.go handleMessages, pkg/aggregator/demultiplexer_agent.go:303), so if an RC/local metric-filter update lands between worker construction and subscription, that update is never forwarded and workers can keep a stale filter list until a later update arrives.

Useful? React with 👍 / 👎.

Copy link
Member Author

Choose a reason for hiding this comment

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

Because of the order in which components are initialized and started, RC only starts pulling updates once the components that depend on it (e.g. dogstatsd, demultiplexer) have finished initialization + starting.
This explains why the scenario described above cannot happen, and therefore why delivering the current matcher in the callback is not necessary anymore.

Comment on lines +331 to 334
func (fl *FilterList) OnUpdateTagFilterList(onUpdate func(filterlistdef.TagMatcher)) {
fl.updateTagMtx.Lock()
fl.tagFilterListUpdate = append(fl.tagFilterListUpdate, onUpdate)
fl.updateTagMtx.Unlock()

Choose a reason for hiding this comment

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

P2 Badge Replay current tag filter list on callback registration

OnUpdateTagFilterList also became registration-only, which creates the same startup gap for tag filters: the demultiplexer subscribes in run (pkg/aggregator/demultiplexer_agent.go:304) after creating aggregator/sampler workers, so a tag-filter update that occurs before this subscription is dropped and tag stripping can remain stale for the process lifetime unless another update is pushed.

Useful? React with 👍 / 👎.

Copy link
Member Author

Choose a reason for hiding this comment

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

(same explanation as above)

@agent-platform-auto-pr
Copy link
Contributor

Files inventory check summary

File checks results against ancestor f833cb1c:

Results for datadog-agent_7.78.0~devel.git.589.3354120.pipeline.102422554-1_amd64.deb:

No change detected

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 9ebd458
📊 Static Quality Gates Dashboard
🔗 SQG Job

Successful checks

Info

Quality gate Change Size (prev → curr → max)
agent_rpm_arm64_fips +4.0 KiB (0.00% increase) 686.154 → 686.158 → 694.440
agent_suse_arm64_fips +4.0 KiB (0.00% increase) 686.154 → 686.158 → 694.440
docker_cluster_agent_amd64 +4.0 KiB (0.00% increase) 203.662 → 203.666 → 206.270
docker_dogstatsd_amd64 -4.06 KiB (0.01% reduction) 38.619 → 38.615 → 39.380
dogstatsd_deb_amd64 -8.09 KiB (0.03% reduction) 29.847 → 29.839 → 30.610
dogstatsd_deb_arm64 -8.09 KiB (0.03% reduction) 28.000 → 27.992 → 29.110
dogstatsd_rpm_amd64 -8.09 KiB (0.03% reduction) 29.847 → 29.839 → 30.610
dogstatsd_suse_amd64 -8.09 KiB (0.03% reduction) 29.847 → 29.839 → 30.610
iot_agent_deb_armhf +4.0 KiB (0.01% increase) 40.843 → 40.847 → 41.030
21 successful checks with minimal change (< 2 KiB)
Quality gate Current Size
agent_deb_amd64 746.935 MiB
agent_deb_amd64_fips 705.300 MiB
agent_heroku_amd64 311.743 MiB
agent_rpm_amd64 746.918 MiB
agent_rpm_amd64_fips 705.284 MiB
agent_rpm_arm64 724.842 MiB
agent_suse_amd64 746.918 MiB
agent_suse_amd64_fips 705.284 MiB
agent_suse_arm64 724.842 MiB
docker_agent_amd64 807.271 MiB
docker_agent_arm64 809.996 MiB
docker_agent_jmx_amd64 998.186 MiB
docker_agent_jmx_arm64 989.690 MiB
docker_cluster_agent_arm64 218.164 MiB
docker_cws_instrumentation_amd64 7.142 MiB
docker_cws_instrumentation_arm64 6.689 MiB
docker_dogstatsd_arm64 36.939 MiB
iot_agent_deb_amd64 43.048 MiB
iot_agent_deb_arm64 40.111 MiB
iot_agent_rpm_amd64 43.049 MiB
iot_agent_suse_amd64 43.049 MiB
On-wire sizes (compressed)
Quality gate Change Size (prev → curr → max)
agent_deb_amd64 -14.83 KiB (0.01% reduction) 174.446 → 174.432 → 177.700
agent_deb_amd64_fips -30.52 KiB (0.02% reduction) 165.363 → 165.333 → 172.230
agent_heroku_amd64 -4.7 KiB (0.01% reduction) 75.174 → 75.169 → 79.970
agent_rpm_amd64 -12.48 KiB (0.01% reduction) 176.452 → 176.439 → 180.780
agent_rpm_amd64_fips +9.22 KiB (0.01% increase) 168.068 → 168.077 → 173.370
agent_rpm_arm64 -40.66 KiB (0.02% reduction) 159.339 → 159.299 → 161.610
agent_rpm_arm64_fips -19.08 KiB (0.01% reduction) 151.390 → 151.372 → 155.910
agent_suse_amd64 -12.48 KiB (0.01% reduction) 176.452 → 176.439 → 180.780
agent_suse_amd64_fips +9.22 KiB (0.01% increase) 168.068 → 168.077 → 173.370
agent_suse_arm64 -40.66 KiB (0.02% reduction) 159.339 → 159.299 → 161.610
agent_suse_arm64_fips -19.08 KiB (0.01% reduction) 151.390 → 151.372 → 155.910
docker_agent_amd64 neutral 267.110 MiB → 271.240
docker_agent_arm64 +11.06 KiB (0.00% increase) 254.418 → 254.428 → 259.800
docker_agent_jmx_amd64 neutral 335.763 MiB → 339.870
docker_agent_jmx_arm64 +11.4 KiB (0.00% increase) 319.057 → 319.068 → 324.390
docker_cluster_agent_amd64 neutral 71.276 MiB → 72.920
docker_cluster_agent_arm64 +8.0 KiB (0.01% increase) 66.918 → 66.926 → 68.220
docker_cws_instrumentation_amd64 neutral 2.999 MiB → 3.330
docker_cws_instrumentation_arm64 neutral 2.729 MiB → 3.090
docker_dogstatsd_amd64 neutral 14.943 MiB → 15.820
docker_dogstatsd_arm64 -2.06 KiB (0.01% reduction) 14.274 → 14.272 → 14.830
dogstatsd_deb_amd64 neutral 7.886 MiB → 8.790
dogstatsd_deb_arm64 neutral 6.770 MiB → 7.710
dogstatsd_rpm_amd64 neutral 7.895 MiB → 8.800
dogstatsd_suse_amd64 neutral 7.895 MiB → 8.800
iot_agent_deb_amd64 neutral 11.348 MiB → 12.040
iot_agent_deb_arm64 neutral 9.662 MiB → 10.450
iot_agent_deb_armhf +2.21 KiB (0.02% increase) 9.889 → 9.892 → 10.620
iot_agent_rpm_amd64 neutral 11.368 MiB → 12.060
iot_agent_suse_amd64 neutral 11.368 MiB → 12.060

@olivielpeau olivielpeau changed the title [metric filterlist] Fix various bugs in filterlist component [AMCC-177][metric filterlist] Fix various bugs in filterlist component Mar 13, 2026
@cit-pr-commenter-54b7da
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: aaa46985-0448-4c5c-8010-e6e2bf09d0ef

Baseline: 9ebd458
Comparison: 3354120
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 +1.12 [-1.94, +4.18] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +1.12 [-1.94, +4.18] 1 Logs
quality_gate_idle memory utilization +0.55 [+0.50, +0.60] 1 Logs bounds checks dashboard
ddot_metrics memory utilization +0.55 [+0.37, +0.72] 1 Logs
quality_gate_idle_all_features memory utilization +0.28 [+0.25, +0.32] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.04 [-0.35, +0.43] 1 Logs
quality_gate_metrics_logs memory utilization +0.03 [-0.21, +0.26] 1 Logs bounds checks dashboard
otlp_ingest_metrics memory utilization +0.02 [-0.14, +0.19] 1 Logs
ddot_logs memory utilization +0.02 [-0.04, +0.08] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.02 [-0.17, +0.20] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.11, +0.10] 1 Logs
uds_dogstatsd_to_api_v3 ingress throughput -0.00 [-0.19, +0.18] 1 Logs
ddot_metrics_sum_delta memory utilization -0.03 [-0.21, +0.14] 1 Logs
ddot_metrics_sum_cumulativetodelta_exporter memory utilization -0.06 [-0.28, +0.17] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.06 [-0.14, +0.02] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.08 [-0.51, +0.35] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.10 [-0.60, +0.40] 1 Logs
file_tree memory utilization -0.14 [-0.19, -0.09] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.21 [-0.36, -0.05] 1 Logs
docker_containers_memory memory utilization -0.29 [-0.37, -0.21] 1 Logs
otlp_ingest_logs memory utilization -0.30 [-0.41, -0.20] 1 Logs
ddot_metrics_sum_cumulative memory utilization -0.42 [-0.56, -0.28] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.55 [-0.61, -0.49] 1 Logs
quality_gate_logs % cpu utilization -0.79 [-2.39, +0.80] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
docker_containers_cpu simple_check_run 10/10 705 ≥ 26
docker_containers_memory memory_usage 10/10 275.95MiB ≤ 370MiB
docker_containers_memory simple_check_run 10/10 670 ≥ 26
file_to_blackhole_0ms_latency memory_usage 10/10 0.19GiB ≤ 1.20GiB
file_to_blackhole_0ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_1000ms_latency memory_usage 10/10 0.23GiB ≤ 1.20GiB
file_to_blackhole_1000ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_100ms_latency memory_usage 10/10 0.19GiB ≤ 1.20GiB
file_to_blackhole_100ms_latency missed_bytes 10/10 0B = 0B
file_to_blackhole_500ms_latency memory_usage 10/10 0.21GiB ≤ 1.20GiB
file_to_blackhole_500ms_latency missed_bytes 10/10 0B = 0B
quality_gate_idle intake_connections 10/10 3 = 3 bounds checks dashboard
quality_gate_idle memory_usage 10/10 173.71MiB ≤ 175MiB bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 3 = 3 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 494.67MiB ≤ 550MiB bounds checks dashboard
quality_gate_logs intake_connections 10/10 3 ≤ 6 bounds checks dashboard
quality_gate_logs memory_usage 10/10 203.56MiB ≤ 220MiB bounds checks dashboard
quality_gate_logs missed_bytes 10/10 0B = 0B bounds checks dashboard
quality_gate_metrics_logs cpu_usage 10/10 346.30 ≤ 2000 bounds checks dashboard
quality_gate_metrics_logs intake_connections 10/10 3 ≤ 6 bounds checks dashboard
quality_gate_metrics_logs memory_usage 10/10 408.27MiB ≤ 475MiB bounds checks dashboard
quality_gate_metrics_logs missed_bytes 10/10 0B = 0B 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_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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, 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.
  • quality_gate_idle_all_features, 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 missed_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/no-changelog No changelog entry needed internal Identify a non-fork PR long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-metric-pipelines team/network-device-monitoring-core

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant