[SDBM-2648] Add collect_execution_plans option to SQL Server DBM

[na-ji]

What does this PR do?

Adds a new collect_execution_plans configuration block to the SQL Server DBM integration. When collect_execution_plans.enabled is set to false, the query-metrics job continues to collect and emit query metrics and FQT events, but skips execution plan collection entirely.

dbm: true
query_metrics:
  enabled: true
collect_execution_plans:
  enabled: false  # skip plan collection, keep metrics

Motivation

Some users want query metrics without execution plan collection — for example to reduce load from sys.dm_exec_query_plan lookups, or for policy/privacy reasons around plan XML. Previously the only way to disable plans was query_metrics.enabled: false, which also stopped metric collection.

The new option follows the existing collect_* block pattern used by collect_settings, collect_schemas, collect_deadlocks, etc.

Review checklist (to be filled by reviewers)

• Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
• Add qa/required if this PR needs QA validation, or qa/skip-qa if it does not. Exactly one of the two is required.
• If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

[datadog-datadog-prod-us1-2]

✨ Fix all issues with BitsAI

⚠️ Warnings

🚦 47 Pipeline jobs failed

PR | test / check     

PR | test / test (linux, ubuntu-22.04, sqlserver, SQL Server on Linux (py3.13-linux-2022-newyork), py3.13-lin... / SQL Server on Linux (py3.13-linux-2022-newyork)-py3.13-linux-2022-newyork     

PR | test / test (linux, ubuntu-22.04, sqlserver, SQL Server on Linux (py3.13-linux-2022-tokyo), py3.13-linux... / SQL Server on Linux (py3.13-linux-2022-tokyo)-py3.13-linux-2022-tokyo     

View all 47 failed jobs.

Useful? React with 👍 / 👎

_{This comment will be updated automatically if new data arrives.
🔗 Commit SHA: a03aba8 | Docs | Datadog PR Page | Give us feedback!}

[na-ji]

I hesitated to add this config under query_metrics, since it's the query_metrics job that is collecting the plans.
Also, I believe this config should be hidden. What do you think?

[eric-weaver]

Does this option have any affect if query_metrics is disabled?

[na-ji]

Huh, that's probably the question I should have asked myself before hesitating 😅. So to answer your question: yes, if query_metrics job is disabled, then no plans are collected. It means that I should probably move the config over there

[dd-octo-sts]

Validation Report

All 21 validations passed.

Show details

Validation	Description	Status
agent-reqs	Verify check versions match the Agent requirements file	✅
ci	Validate CI configuration and code coverage settings	✅
codeowners	Validate every integration has a CODEOWNERS entry	✅
config	Validate default configuration files against spec.yaml	✅
dep	Verify dependency pins are consistent and Agent-compatible	✅
http	Validate integrations use the HTTP wrapper correctly	✅
imports	Validate check imports do not use deprecated modules	✅
integration-style	Validate check code style conventions	✅
jmx-metrics	Validate JMX metrics definition files and config	✅
labeler	Validate PR labeler config matches integration directories	✅
legacy-signature	Validate no integration uses the legacy Agent check signature	✅
license-headers	Validate Python files have proper license headers	✅
licenses	Validate third-party license attribution list	✅
metadata	Validate metadata.csv metric definitions	✅
models	Validate configuration data models match spec.yaml	✅
openmetrics	Validate OpenMetrics integrations disable the metric limit	✅
package	Validate Python package metadata and naming	✅
qa-label	Validate the pull request declares whether it needs QA for the next Agent release	✅
readmes	Validate README files have required sections	✅
saved-views	Validate saved view JSON file structure and fields	✅
version	Validate version consistency between package and changelog	✅

View full run