configfilesdiscovery: collect postgres env vars - #55048
configfilesdiscovery: collect postgres env vars#55048martavicentenavarro wants to merge 3 commits into
Conversation
Add a PostgreSQL collector for Config Files Discovery that forwards a small allow-listed set of non-secret environment variables (PGDATA, POSTGRES_DB, POSTGRES_USER, POSTGRES_HOST_AUTH_METHOD, POSTGRES_INITDB_WALDIR), matching the scope of DSCVR-664. This mirrors how Redis (#54375) and Kafka (#54217) added env-var collection as collector-only changes; postgresql.conf collection is a separate, not-yet-started ticket (DSCVR-665) and is out of scope here. Environment: Datadog workspace Co-Authored-By: Claude Sonnet 5 <[email protected]>
|
@codex review |
dd-octo-sts
Bot
added
internal
|
Codex Review: Didn't find any major issues. 🎉 Reviewed commit: ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
|
🎯 Code Coverage (details) 🔗 Commit SHA: fdf85e0 | Docs | View more details | Give us feedback! |
martavicentenavarro
added
changelog/no-changelog
Files inventory check summaryFile checks results against ancestor 6e12aadd: Results for datadog-agent_7.84.0~devel.git.268.fdf85e0.pipeline.131672124-1_amd64.deb:No change detected Results for datadog-iot-agent_7.84.0~devel.git.268.fdf85e0.pipeline.131672124-1_amd64.deb:No change detected |
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 6e12aad Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_metrics_logs | memory utilization | +0.40 | [+0.16, +0.65] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_private_action_runner | memory utilization | +0.19 | [+0.07, +0.31] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | +0.14 | [+0.02, +0.26] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_idle | memory utilization | -0.14 | [-0.25, -0.03] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.15 | [-0.19, -0.11] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_mean_fs_load | memory utilization | -0.27 | [-0.34, -0.19] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_security_no_fs_load | memory utilization | -0.45 | [-0.59, -0.30] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_logs | % cpu utilization | -1.24 | [-2.10, -0.38] | 1 | Logs bounds checks dashboard |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | observed_value | links |
|---|---|---|---|---|---|
| ✅ | quality_gate_idle | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | 173.00MiB ≤ 178MiB | bounds checks dashboard |
| ✅ | quality_gate_idle | total_bytes_received | 10/10 | 745.06KiB ≤ 819.20KiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | 4 = 4 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | 510.72MiB ≤ 538MiB | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | total_bytes_received | 10/10 | 1.13MiB ≤ 1.25MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | 17 ≤ 40 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | 204.22MiB ≤ 229MiB | bounds checks dashboard |
| ✅ | quality_gate_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_logs | total_bytes_received | 10/10 | 264.18MiB ≤ 292MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | 355.85 ≤ 2000 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | 19 ≤ 40 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | 405.26MiB ≤ 439MiB | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | missed_bytes | 10/10 | 0B = 0B | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | total_bytes_received | 10/10 | 0.94GiB ≤ 1.04GiB | bounds checks dashboard |
| ✅ | quality_gate_private_action_runner | memory_usage | 10/10 | 71.40MiB ≤ 76MiB | bounds checks dashboard |
| ✅ | quality_gate_security_idle | cpu_usage | 10/10 | 26.86 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_idle | memory_usage | 10/10 | 331.94MiB ≤ 335MiB | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | cpu_usage | 10/10 | 61.37 ≤ 200 | bounds checks dashboard |
| ✅ | quality_gate_security_mean_fs_load | memory_usage | 10/10 | 303.97MiB ≤ 314MiB | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | cpu_usage | 10/10 | 20.37 ≤ 100 | bounds checks dashboard |
| ✅ | quality_gate_security_no_fs_load | memory_usage | 10/10 | 312.05MiB ≤ 343MiB | 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:
-
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_security_mean_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_mean_fs_load, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_private_action_runner, bounds check memory_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 intake_connections: 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 cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check total_bytes_received: 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_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check total_bytes_received: 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.
- quality_gate_security_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_idle, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_security_no_fs_load, bounds check cpu_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.
- quality_gate_idle_all_features, bounds check total_bytes_received: 10/10 replicas passed. Gate passed.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
21 successful checks with minimal change (< 2 KiB)
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7c99a997d8
ℹ️ 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".
| "PGDATA": {}, | ||
| "POSTGRES_DB": {}, | ||
| "POSTGRES_USER": {}, | ||
| "POSTGRES_HOST_AUTH_METHOD": {}, |
There was a problem hiding this comment.
When POSTGRES_HOST_AUTH_METHOD contains PostgreSQL HBA options—for example, ldap ... ldapbindpasswd=secret or radius ... radiussecret=secret—the official Postgres image appends the entire value to pg_hba.conf. Allowlisting this variable forwards that entire credential-bearing value; IsSecretEnvVarName cannot protect it because it examines only the variable name. Omit this variable or sanitize it to a known-safe authentication method before collection.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Pull request overview
Adds PostgreSQL environment-variable collection to the Config Files Discovery (configfilesdiscovery) component, mirroring the existing Redis/Kafka env-var collectors while keeping collection restricted to an allow-list and applying the shared secret-name filter for defense in depth.
Changes:
- Introduces a new Postgres configfilesdiscovery collector that forwards a small allow-listed set of non-secret env vars.
- Registers the Postgres collector in the configfilesdiscovery Fx wiring so it can be scheduled via Autodiscovery (
postgresintegration). - Adds unit tests for the collector and extends the Docker E2E suite with a Postgres compose fixture + env-var discovery assertions.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| test/new-e2e/tests/discovery/testdata/compose/docker-compose.configfilesdiscovery-postgres.yaml | Adds a Postgres compose fixture used by the Docker E2E discovery suite. |
| test/new-e2e/tests/discovery/configfilesdiscovery_docker_test.go | Adds an E2E test that validates Postgres env-var discovery payloads reach fakeintake. |
| comp/core/configfilesdiscovery/impl/collectors/postgres.go | Implements the Postgres env-var collector with allow/deny lists and secret-name filtering. |
| comp/core/configfilesdiscovery/impl/collectors/postgres_test.go | Adds unit tests for allow/deny logic and collector behavior. |
| comp/core/configfilesdiscovery/impl/collectors/BUILD.bazel | Wires the new collector + tests into Bazel targets. |
| comp/core/configfilesdiscovery/fx/fx.go | Registers the Postgres collector in the component’s collector map. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| environment: | ||
| POSTGRES_DB: configfilesdiscovery | ||
| POSTGRES_USER: configfilesdiscovery | ||
| POSTGRES_PASSWORD: must-not-be-forwarded |
| assert.Equal(c, postgresDBName, envVars["POSTGRES_DB"]) | ||
| assert.Equal(c, postgresUser, envVars["POSTGRES_USER"]) | ||
| assert.NotContains(c, envVars, "POSTGRES_PASSWORD") |
| // NewPostgres returns a collector that reads selected, non-secret PostgreSQL | ||
| // environment variables. It does not read postgresql.conf; config-file | ||
| // collection is a separate collector. |
What does this PR do?
Adds a PostgreSQL collector for Config Files Discovery that forwards a small allow-listed set of non-secret PostgreSQL environment variables:
PGDATAPOSTGRES_DBPOSTGRES_USERPOSTGRES_INITDB_WALDIRThis mirrors how env-var collection was added for Redis (#54375) and Kafka (#54217): a focused collector limited to environment variables, with the shared
configfilesdiscoveryimpl.IsSecretEnvVarNamefilter applied as defense in depth on top of the allow-list.Motivation
DSCVR-664
Describe how to test/QA your changes
dda inv test --targets=./comp/core/configfilesdiscovery/...TestPostgresEnvVarsDiscoveredintest/new-e2e/tests/discovery/configfilesdiscovery_docker_test.go, using apostgres:16compose fixture, asserting the allowed env vars are forwarded andPOSTGRES_PASSWORD(and any*PASSWORD*name) is never forwarded.