DOC-15312: For cloud, update that SQL Audit Logging goes to SENSITIVE_ACCESS channel and can be exported #20974
Conversation
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
… logging channel and links to export-logs.md and export-logs-advanced.md.
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
Files changed: |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
jhlodin
reviewed
Dec 1, 2025
| SQL audit logging gives you detailed information about queries being executed against a table in your cluster. This feature is especially useful when you want to log all queries that are run against a table that contains cardholder data, private health information (PHI), or other personally-identifiable information (PII). | ||
|
|
||
| After you enable SQL audit logging for a table, [contact Support](https://support.cockroachlabs.com/hc/) to request the audit logs. | ||
| After you enable SQL audit logging for a table, audit logs are sent to the [`SENSITIVE_ACCESS` logging channel]({% link {{site.current_cloud_version}}/logging-use-cases.md %}#sensitive_access). You can then export these logs depending on your deployment. For more information, refer to [Export Logs From a CockroachDB Standard Cluster]({% link cockroachcloud/export-logs.md %}) or [Export Logs From a CockroachDB Advanced Cluster]({% link cockroachcloud/export-logs-advanced.md %}). |
Contributor
There was a problem hiding this comment.
What does "depending on your deployment" mean in this context? Should be more specific.
Committer: Florence Morris <florence@cockroachlabs.com>
florence-crl
commented
Dec 1, 2025
Contributor
Author
florence-crl
left a comment
florence-crl
left a comment
There was a problem hiding this comment.
@jhlodin please review my updates.
jhlodin
reviewed
Dec 2, 2025
| SQL audit logging gives you detailed information about queries being executed against a table in your cluster. This feature is especially useful when you want to log all queries that are run against a table that contains cardholder data, private health information (PHI), or other personally-identifiable information (PII). | ||
|
|
||
| After you enable SQL audit logging for a table, [contact Support](https://support.cockroachlabs.com/hc/) to request the audit logs. | ||
| After you enable SQL audit logging for a table, audit logs are sent to the [`SENSITIVE_ACCESS` logging channel]({% link {{site.current_cloud_version}}/logging-use-cases.md %}#sensitive_access). You can then export these logs depending on whether your deployment uses CockroachDB {{ site.data.products.standard }} or {{ site.data.products.advanced }}. For details, refer to [Export Logs From a CockroachDB {{ site.data.products.standard }} Cluster]({% link cockroachcloud/export-logs.md %}) or [Export Logs From a CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/export-logs-advanced.md %}). |
Contributor
There was a problem hiding this comment.
"depending on whether" is still unclear about what deployments can do this. It reads like you need Standard or Advanced to do this, so it would be much clearer to say "You can export these logs if your deployment uses CockroachDB Standard or Advanced".
Contributor
Author
There was a problem hiding this comment.
@jhlodin Ah, ok. Updated with your suggestion. Much clearer. Please review again.
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.
Fixes DOC-15312
In cockroachcloud/sql-audit-logging.md, updated with SENSITIVE_ACCESS logging channel and links to export-logs.md and export-logs-advanced.md.
Rendered preview