Make SQL Server database_metrics.instance_metrics.enabled gate collection

[jasonmp85]

What does this PR do?

Makes database_metrics.instance_metrics.enabled actually gate instance metric collection, and marks the legacy include_instance_metrics option as deprecated in favor of it.

Measured effect

Three configurations against the same bench instance, expected fan-out 1,400 samples:

configuration	master samples	this PR
instance_metrics.enabled: true	1,477	878
instance_metrics.enabled: false	1,477 (no effect)	0
legacy include_instance_metrics: false	1,400	0

The documented option goes from inert to working. On master, setting it to false produced byte-identical output to setting it to true; on this branch it emits zero samples and zero residual metric names. The legacy option continues to work, so nobody's existing configuration changes meaning.

Motivation

The documented switch is currently inert. A user following the current documentation to turn instance metrics off gets no effect and no warning — the check keeps collecting and they keep paying for it, with nothing in the logs to suggest the option was ignored.

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]

 

✅ All CI checks and tests passed.

🎉 All green!

🧪 All tests passed
❄️ No new flaky tests detected

🎯 Code Coverage (details)
• Patch Coverage: 100.00%
• Overall Coverage: 91.10%

_{This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 872cd40 | Docs | View more details | Give us feedback!}

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3588c7500a

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

[cit-pr-commenter-54b7da]

evalya-impact-summary

evalya impact analysis

Impact analysis: RUN-ALL — every test task will run
Trigger:         empty diff (default branch, scheduled run, or shallow-clone fallback)
Test tasks:      0 (all selected)
Publish tasks:   2 (always emitted)
Diff:            empty (no diff information)

Learn more about CI impact filtering

Review from azhou-datadog is dismissed. Related teams and files:

• database-monitoring-agent
  • sqlserver/assets/configuration/spec.yaml
  • sqlserver/datadog_checks/sqlserver/config_models/deprecations.py
  • sqlserver/datadog_checks/sqlserver/data/conf.yaml.example
  • sqlserver/tests/test_unit.py

[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