Skip to content

Commit 0379f42

Browse files
azhou-datadogestherk15cswatt
authored
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>
1 parent 572d858 commit 0379f42

File tree

12 files changed

+46
-12
lines changed

12 files changed

+46
-12
lines changed

content/en/database_monitoring/guide/parameterized_queries.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: Capturing SQL Query Parameter Values With Database Monitoring
3-
private: true
43
further_reading:
54
- link: "/database_monitoring/"
65
tag: "Documentation"
@@ -13,10 +12,6 @@ further_reading:
1312
text: "Troubleshooting Database Monitoring"
1413
---
1514

16-
<div class="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-
2015
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.
2116

2217
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:
3126

3227
## Before you begin
3328

34-
<div class="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+
<div class="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>
3530

3631
You must configure Database Monitoring for your [SQL Server][1] instance before continuing with this guide.
3732

@@ -41,6 +36,10 @@ Supported databases
4136
Supported deployments
4237
: All deployment types.
4338

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+
4443
## Setup
4544
To capture SQL query text and execution plans with parameter values, update the appropriate integration `conf.yaml` file based on your database type:
4645
- For PostgreSQL: edit `postgres.d/conf.yaml`
@@ -51,7 +50,8 @@ To capture SQL query text and execution plans with parameter values, update the
5150
enabled: true
5251
```
5352
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>
5555
5656
```yaml
5757
xe_collection:
@@ -92,3 +92,5 @@ To capture prepared statements with parameter values in SQL Server, you must [co
9292
Support for PostgreSQL prepared statement parameter value capture is not available at this time.
9393

9494
[1]: /database_monitoring/guide/sql_extended_events/
95+
[2]: /account_management/rbac/permissions/
96+
[3]: /account_management/rbac/

content/en/database_monitoring/setup_postgres/alloydb.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ further_reading:
55
- link: "/integrations/postgres/"
66
tag: "Documentation"
77
text: "Basic Postgres Integration"
8+
- link: "/database_monitoring/guide/parameterized_queries/"
9+
tag: "Documentation"
10+
text: "Capturing SQL Query Parameter Values"
811
---
912

1013
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
274277
```shell
275278
kubectl apply -f datadog-agent.yaml
276279
```
277-
280+
278281
### Helm
279282

280283
Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration:

content/en/database_monitoring/setup_postgres/aurora.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ further_reading:
55
- link: "/integrations/postgres/"
66
tag: "Documentation"
77
text: "Basic Postgres Integration"
8+
- link: "/database_monitoring/guide/parameterized_queries/"
9+
tag: "Documentation"
10+
text: "Capturing SQL Query Parameter Values"
811
---
912

1013
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.

content/en/database_monitoring/setup_postgres/azure.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ further_reading:
55
- link: "/integrations/postgres/"
66
tag: "Documentation"
77
text: "Basic Postgres Integration"
8+
- link: "/database_monitoring/guide/parameterized_queries/"
9+
tag: "Documentation"
10+
text: "Capturing SQL Query Parameter Values"
811
---
912

1013
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.

content/en/database_monitoring/setup_postgres/gcsql.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ further_reading:
55
- link: "/integrations/postgres/"
66
tag: "Documentation"
77
text: "Basic Postgres Integration"
8+
- link: "/database_monitoring/guide/parameterized_queries/"
9+
tag: "Documentation"
10+
text: "Capturing SQL Query Parameter Values"
811
---
912

1013
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
273276
```shell
274277
kubectl apply -f datadog-agent.yaml
275278
```
276-
279+
277280
### Helm
278281

279282
Using the [Helm instructions in Kubernetes and Integrations][4] as a reference, follow the steps below to set up the Postgres integration:

content/en/database_monitoring/setup_postgres/heroku.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ further_reading:
77
- link: "/agent/basic_agent_usage/heroku/"
88
tag: "Documentation"
99
text: "Datadog Heroku Buildpack"
10+
- link: "/database_monitoring/guide/parameterized_queries/"
11+
tag: "Documentation"
12+
text: "Capturing SQL Query Parameter Values"
1013
---
1114

1215
This guide assumes that you have configured the [Datadog Heroku buildpack][1] in your application dynos.
@@ -89,7 +92,7 @@ heroku config:set DD_ENABLE_HEROKU_POSTGRES=true
8992
git commit --allow-empty -m "enabled postgres integration"
9093
git push heroku main
9194
```
92-
95+
9396
To enable both the Postgres integration and Database Monitoring, set `DD_ENABLE_HEROKU_POSTGRES` and `DD_ENABLE_DBM` to true:
9497

9598
``` shell
@@ -140,7 +143,7 @@ In the root of the project, create a directory for the Postgres configuration ca
140143
mkdir -p datadog/conf.d/postgres.d
141144
touch datadog/conf.d/postgres.d/conf.yaml
142145
```
143-
146+
144147
Add the following to `conf.yaml`:
145148

146149
``` yaml
@@ -217,4 +220,3 @@ The database connection is now configured. To enable additional features, such a
217220
[4]: https://devcenter.heroku.com/articles/heroku-postgres-plans
218221
[6]: /database_monitoring/schema_explorer
219222
[7]: https://github.com/DataDog/integrations-core/blob/master/postgres/datadog_checks/postgres/data/conf.yaml.example
220-

content/en/database_monitoring/setup_postgres/rds/_index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ further_reading:
88
- link: "/database_monitoring/guide/rds_autodiscovery"
99
tag: "Documenation"
1010
text: "Autodiscovery for RDS"
11+
- link: "/database_monitoring/guide/parameterized_queries/"
12+
tag: "Documentation"
13+
text: "Capturing SQL Query Parameter Values"
1114
---
1215

1316
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.

content/en/database_monitoring/setup_postgres/selfhosted.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ further_reading:
55
- link: "/integrations/postgres/"
66
tag: "Documentation"
77
text: "Basic Postgres Integration"
8+
- link: "/database_monitoring/guide/parameterized_queries/"
9+
tag: "Documentation"
10+
text: "Capturing SQL Query Parameter Values"
811
---
912

1013
Database Monitoring provides deep visibility into your Postgres databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.

content/en/database_monitoring/setup_sql_server/azure.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ further_reading:
1414
- link: "/database_monitoring/guide/sql_extended_events/"
1515
tag: "Documentation"
1616
text: "Configure Query Completion and Query Error Collection"
17+
- link: "/database_monitoring/guide/parameterized_queries/"
18+
tag: "Documentation"
19+
text: "Capturing SQL Query Parameter Values"
1720
---
1821

1922
Database Monitoring provides deep visibility into your Microsoft SQL Server databases by exposing query metrics, query samples, explain plans, database states, failovers, and events.

content/en/database_monitoring/setup_sql_server/gcsql.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ further_reading:
1111
- link: "/database_monitoring/guide/sql_extended_events/"
1212
tag: "Documentation"
1313
text: "Configure Query Completion and Query Error Collection"
14+
- link: "/database_monitoring/guide/parameterized_queries/"
15+
tag: "Documentation"
16+
text: "Capturing SQL Query Parameter Values"
1417
---
1518

1619
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

Comments
 (0)