[DOCS] Improve clarity of DBM self-hosted Postgres setup page#35912
Open
michaelperalta wants to merge 4 commits intomasterfrom
Open
[DOCS] Improve clarity of DBM self-hosted Postgres setup page#35912michaelperalta wants to merge 4 commits intomasterfrom
michaelperalta wants to merge 4 commits intomasterfrom
Conversation
- Split config parameters table into Required/Optional sections - Add explicit heading for explain plan function (was orphaned after version tabs) - Fix 9.6 Verify tab to use function form (was identical to ≥10 tab) - Rename sections for consistency: "Verify database permissions" and "Verify Agent setup" - Simplify dense Grant intro paragraph - Fix passive voice and remove style violations - Consolidate duplicate reference links - Fix title hyphenation: "Self-Hosted" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Preview links (active after the
|
Contributor
This was referenced Apr 10, 2026
jeff-morgan-dd
approved these changes
Apr 13, 2026
Contributor
jeff-morgan-dd
left a comment
jeff-morgan-dd
left a comment
There was a problem hiding this comment.
Thanks for this PR - just a couple of small style guide/grammar fixes here but approved otherwise!
| ### Collecting logs (optional) | ||
|
|
||
| PostgreSQL default logging is to `stderr`, and logs do not include detailed information. It is recommended to log into a file with additional details specified in the log line prefix. Refer to the PostgreSQL [documentation][11] on this topic for additional details. | ||
| PostgreSQL default logging is to `stderr`, and logs do not include detailed information. Log into a file with additional details specified in the log line prefix. See the PostgreSQL [documentation][11] for details. |
Contributor
There was a problem hiding this comment.
Suggested change
| PostgreSQL default logging is to `stderr`, and logs do not include detailed information. Log into a file with additional details specified in the log line prefix. See the PostgreSQL [documentation][11] for details. | |
| PostgreSQL default logging is to `stderr`, and logs do not include detailed information. Log in to a file with additional details specified in the log line prefix. See the PostgreSQL [documentation][11] for details. |
| To collect full `EXPLAIN ANALYZE` plans taken from all queries, you need to use [`auto_explain`][18], a first-party extension bundled with PostgreSQL available in all major providers. _Logging collection is a prerequisite to `auto_explain` collection_, so enable it before continuing. | ||
|
|
||
| <div class="alert alert-danger"> | ||
| <strong>Important:</strong> <code>auto_explain</code> produces logs lines that may contain sensitive information from your application, similar to the raw values that appear in non-obfuscated SQL. You can use the <a href="/account_management/rbac/permissions/#database-monitoring"><code>dbm_parameterized_queries_read</code></a> permission to control who can see the resulting plans, but the log lines themselves <i>are</i> visible to all users within your Datadog org. Using <a href="/logs/guide/logs-rbac">RBAC for Logs</a> helps ensure these logs are only visible to the right users. |
Contributor
There was a problem hiding this comment.
Suggested change
| <strong>Important:</strong> <code>auto_explain</code> produces logs lines that may contain sensitive information from your application, similar to the raw values that appear in non-obfuscated SQL. You can use the <a href="/account_management/rbac/permissions/#database-monitoring"><code>dbm_parameterized_queries_read</code></a> permission to control who can see the resulting plans, but the log lines themselves <i>are</i> visible to all users within your Datadog org. Using <a href="/logs/guide/logs-rbac">RBAC for Logs</a> helps ensure these logs are only visible to the right users. | |
| <strong>Important:</strong> <code>auto_explain</code> produces log lines that may contain sensitive information from your application, similar to the raw values that appear in non-obfuscated SQL. You can use the <a href="/account_management/rbac/permissions/#database-monitoring"><code>dbm_parameterized_queries_read</code></a> permission to control who can see the resulting plans, but the log lines themselves <i>are</i> visible to all users within your Datadog org. Using <a href="/logs/guide/logs-rbac">RBAC for Logs</a> helps ensure these logs are only visible to the right users. |
Contributor
There was a problem hiding this comment.
Not part of the PR, but small fix since this is a cleanup effort.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Clarity improvements to the Database Monitoring setup page for self-hosted Postgres.
postgresql.confparameters table into Required and Optional sections### Create the explain plan functionheading (it was orphaned after version tabs, making it easy to miss)datadog.pg_stat_activity()anddatadog.pg_stat_statements()function forms required for that versionMerge instructions
Merge readiness:
Additional notes