Capturing SQL Query Parameter Values With Database Monitoring

이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.
This feature is in preview. To enable collection of raw SQL query text and execution plans with parameter values, please contact your Datadog representative or support.

The Database Monitoring integrations collect aggregated query metrics, in-flight query executions, and query explain plans across your database. By default, query SQL texts and explain plans are obfuscated and normalized in the Agent before being sent to Datadog in order to protect sensitive data, which may be exposed in query parameters.

However, exposing query statements with actual parameter values provides enhanced observability and debugging capabilities. Database Monitoring currently supports query capture with parameter values on the PostgreSQL and SQL Server integrations.

Having access to query parameters enables:

  • Performance analysis: Map explain plans to specific parameter values to understand why certain execution plans are chosen
  • Root cause identification: Identify which parameter values or query patterns cause performance regressions
  • Hotspot detection: Discover problematic parameters (for example, 90% of slow queries caused by org_id:12345)
  • Query optimization: Investigate actual execution plans with real parameters to obtain execution statistics and identify optimization opportunities
  • Index tuning: Fine-tune indexes, rewrite queries, or adjust query hints based on real parameter values

Before you begin

Query statements and execution plans with parameterized values may contain sensitive information (for example, passwords in query parameters) or personally identifiable information. Enabling this option allows Datadog to collect and ingest raw query statements and execution plans that appear in query samples or explain plans. This option is disabled by default.

You must configure Database Monitoring for your SQL Server instance before continuing with this guide.

Supported databases
PostgreSQL, SQL Server
Supported deployments
All deployment types.

Setup

To capture SQL query text and execution plans with parameter values, update the appropriate integration conf.yaml file based on your database type:

  • For PostgreSQL: edit postgres.d/conf.yaml
  • For SQL Server: edit sqlserver.d/conf.yaml
  collect_raw_query_statement:
    enabled: true

For SQL Server, capturing parameter values from prepared statements requires enabling query completion capture via Extended Events. See configure your SQL Server instance and integration to capture query completions in order to complete the database set up.

  xe_collection:
    query_completions:
      enabled: true
    query_errors:
      enabled: true

Prepared statement support is currently available only for SQL Server. For more details, see Why prepared statement parameter values are limited.

Query parameter value capture by DBMS type

PostgreSQL

Query Execution MethodSupportDescriptionExampleSupported Agent Version
Direct ExecutionsAd-hoc SQL statements executed directly, including literal values in the query text.SELECT * FROM users WHERE id = 1237.64.0+
FunctionsScalar or table-valued functions invoked with SELECT.SELECT get_user_name(123);7.64.0+
Stored ProceduresProcedures invoked with CALL.CALL procname(123)7.64.0+
Prepared StatementsNot currently supported. See Why prepared statement parameter values are limited. Parameterized queries executed through prepared statements. Can be created explicitly or through drivers.PREPARE stmt AS SELECT * FROM users WHERE id = $1; EXECUTE stmt(123);

SQL Server

Query Execution MethodSupportDescriptionExampleAgent Version
Direct ExecutionsAd-hoc SQL statements executed directly, including literal values in the query text.SELECT * FROM users WHERE id = 1237.64.0+
FunctionsScalar or table-valued functions invoked with SELECT.SELECT dbo.GetUserName(123);7.64.0+
Stored ProceduresProcedures invoked with EXEC.EXEC GetUser @id = 123;7.64.0+
Prepared StatementsSupport requires query completions configuration. Parameterized queries executed through prepared statements. Can be created explicitly or through drivers.sp_prepare @handle, N'SELECT * FROM users WHERE id = @id'; sp_execute @handle, @id = 123;7.67.0+

Why prepared statement parameter values are limited

Datadog uses activity sampling to capture currently running SQL queries. However, for prepared statements, the Database Management System replaces parameter values with placeholders at execution time. As a result, activity sampling cannot observe the actual values.

To capture prepared statements with parameter values in SQL Server, you must configure your SQL Server instance and integration to capture query completions, which provides the Datadog Agent rich visibility into prepared statement execution.

Support for PostgreSQL prepared statement parameter value capture is not available at this time.