You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Link to parameterized queries from set-up docs (#32528)
* link to parameterized queries from set up docs
* add permission call-out
* Update content/en/database_monitoring/guide/parameterized_queries.md
Co-authored-by: Esther Kim <esther.kim@datadoghq.com>
* change color and fix embedded link
---------
Co-authored-by: Esther Kim <esther.kim@datadoghq.com>
Co-authored-by: cecilia saixue wat-kim <cecilia.watt@datadoghq.com>
Copy file name to clipboardExpand all lines: content/en/database_monitoring/guide/parameterized_queries.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
---
2
2
title: Capturing SQL Query Parameter Values With Database Monitoring
3
-
private: true
4
3
further_reading:
5
4
- link: "/database_monitoring/"
6
5
tag: "Documentation"
@@ -13,10 +12,6 @@ further_reading:
13
12
text: "Troubleshooting Database Monitoring"
14
13
---
15
14
16
-
<divclass="alert alert-info">
17
-
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.
18
-
</div>
19
-
20
15
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.
21
16
22
17
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.
@@ -31,7 +26,7 @@ Having access to query parameters enables:
31
26
32
27
## Before you begin
33
28
34
-
<divclass="alert alert-info">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.</div>
29
+
<divclass="alert alert-danger">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.</div>
35
30
36
31
You must configure Database Monitoring for your [SQL Server][1] instance before continuing with this guide.
37
32
@@ -41,6 +36,10 @@ Supported databases
41
36
Supported deployments
42
37
: All deployment types.
43
38
39
+
## Permissions
40
+
41
+
To view query parameter values in the Database Monitoring UI, users need the **Database Monitoring Parameterized Queries Read** permission. This permission is located under the **Database Monitoring** section in the [Roles page][2]. This permission is enabled by default in the Datadog Admin Role, Datadog Standard Role, and Datadog Read Only Role. If your organization uses custom roles, add this permission to the appropriate role. For more information on managing permissions, see the [RBAC documentation][3].
42
+
44
43
## Setup
45
44
To capture SQL query text and execution plans with parameter values, update the appropriate integration `conf.yaml` file based on your database type:
46
45
- For PostgreSQL: edit `postgres.d/conf.yaml`
@@ -51,7 +50,8 @@ To capture SQL query text and execution plans with parameter values, update the
51
50
enabled: true
52
51
```
53
52
54
-
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][1] in order to complete the database set up.
53
+
<div class="alert alert-info">
54
+
For SQL Server, capturing parameter values from prepared statements requires enabling query completion capture through Extended Events. See <a href="/database_monitoring/guide/sql_extended_events/">configure your SQL Server instance and integration to capture query completions</a> in order to complete the database set up. </div>
55
55
56
56
```yaml
57
57
xe_collection:
@@ -92,3 +92,5 @@ To capture prepared statements with parameter values in SQL Server, you must [co
92
92
Support for PostgreSQL prepared statement parameter value capture is not available at this time.
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
@@ -274,7 +277,7 @@ Using the [Operator instructions in Kubernetes and Integrations][3] as a referen
274
277
```shell
275
278
kubectl apply -f datadog-agent.yaml
276
279
```
277
-
280
+
278
281
### Helm
279
282
280
283
Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration:
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
@@ -273,7 +276,7 @@ Using the [Operator instructions in Kubernetes and Integrations][3] as a referen
273
276
```shell
274
277
kubectl apply -f datadog-agent.yaml
275
278
```
276
-
279
+
277
280
### Helm
278
281
279
282
Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration:
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.
0 commit comments