Skip to content

Commit 417527f

Browse files
DBM schema collection config updates (#31321)
* (DOCS-11601) Updated config on schema explorer page * (DOCS-11601) Updated MySQL config info * (DOCS-11601) change alert box to warning box * (DOCS-11601) SQL Server updates
1 parent 93e2ce3 commit 417527f

File tree

3 files changed

+24
-5
lines changed

3 files changed

+24
-5
lines changed

content/en/database_monitoring/schema_explorer.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ instances:
2121
port: 5432
2222
username: datadog
2323
password: 'ENC[datadog_user_database_password]'
24-
collect_schemas: true
24+
collect_schemas:
25+
enabled: true
2526
## Optional: Connect to a different database if needed for `custom_queries`
2627
# dbname: '<DB_NAME>'
2728
```

layouts/shortcodes/dbm-mysql-agent-config-examples.en.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,22 @@ instances:
6767
6868
### Collecting schemas
6969
70-
Starting from Agent v7.65, the Datadog Agent can collect schema information from MySQL databases. To enable this feature, use the `schemas_collection` option.
70+
<div class="alert alert-warning">Datadog Agent v7.65+ is required for MySQL schema collection.</div>
71+
72+
To enable this feature, use the `collect_schemas` option. See the sample [mysql.d/conf.yaml](https://github.com/DataDog/integrations-core/blob/master/mysql/datadog_checks/mysql/data/conf.yaml.example) for more details.
73+
74+
```yaml
75+
init_config:
76+
instances:
77+
- dbm: true
78+
host: localhost
79+
port: 3306
80+
username: datadog
81+
password: 'ENC[datadog_user_database_password]'
82+
collect_schemas:
83+
enabled: true
84+
```
85+
**Note**: For Agent v7.68 and below, use `schemas_collection` instead of `collect_schemas`.
7186

7287
**Note**: To collect schemas for a table, MySQL requires that the Datadog Agent has SELECT access for it. This is a [MySQL-enforced restriction](https://dev.mysql.com/doc/refman/8.4/en/information-schema-introduction.html#information-schema-privileges). Without SELECT access, the table will not appear in metadata queries.
7388

layouts/shortcodes/dbm-sqlserver-agent-config-examples.en.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ instances:
8080
```
8181
8282
### Collecting schemas
83-
Starting from Agent v7.56, the Datadog Agent can collect schema information from SQLServer databases running SQLServer 2017 or higher. To enable this feature, use the `schemas_collection` option. Schemas are collected on databases for which the Agent has `CONNECT` access.
83+
<div class="alert alert-warning">Datadog Agent v7.56+ and SQL Server 2017 or higher are required for SQL Server schema collection.</div>
84+
85+
To enable this feature, use the `collect_schemas` option. Schemas are collected on databases for which the Agent has `CONNECT` access.
8486

8587
<div class="alert alert-info">To collect schema information from RDS instances, you must grant the <code>datadog</code> user explicit <code>CONNECT</code> access to each database on the instance. For more information, see <a href="/database_monitoring/setup_sql_server/rds/?tab=windowshost#grant-the-agent-access">Grant the Agent access</a>.</div>
8688

@@ -97,7 +99,7 @@ instances:
9799
connector: adodbapi
98100
adoprovider: MSOLEDBSQL
99101
database_autodiscovery: true
100-
schemas_collection:
102+
collect_schemas:
101103
enabled: true
102104
database_metrics:
103105
# Optional: enable metric collection for indexes
@@ -111,13 +113,14 @@ instances:
111113
connector: adodbapi
112114
adoprovider: MSOLEDBSQL
113115
database: users
114-
schemas_collection:
116+
collect_schemas:
115117
enabled: true
116118
database_metrics:
117119
# Optional: enable metric collection for indexes
118120
index_usage_metrics:
119121
enabled: true
120122
```
123+
**Note**: For Agent v7.68 and below, use `schemas_collection` instead of `collect_schemas`.
121124

122125
### One Agent connecting to multiple hosts
123126
It is common to configure a single Agent host to connect to multiple remote database instances (see [Agent installation architectures][1006] for DBM). To connect to multiple hosts, create an entry for each host in the SQL Server integration config.

0 commit comments

Comments
 (0)