DOC-11808 Docs for Audit Logs Page for Customers #19428
Open
Conversation
This file contains 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
In cloud-deployments.json, added link to organization-audit-logs-in-cloud-console.md.
…ts suggested by Docs Reviewer GPT.
Files changed:
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify site configuration. |
kteehan
reviewed
Mar 26, 2025
src/current/cockroachcloud/organization-audit-logs-in-cloud-console.md
Outdated
Show resolved
Hide resolved
kteehan
approved these changes
Apr 8, 2025
jaiayu
reviewed
Apr 8, 2025
src/current/cockroachcloud/organization-audit-logs-in-cloud-console.md
Outdated
Show resolved
Hide resolved
jaiayu
approved these changes
Apr 8, 2025
mikeCRL
approved these changes
Apr 16, 2025
| ## View audit logs | ||
|
|
||
| 1. Navigate to the [CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/) and log in as a user with the [Organization Admin role]({% link cockroachcloud/authorization.md %}#org-administrator). | ||
| 1. In the top navigation bar, select **Organization**, then choose **Audit Logs** from the dropdown menu. This will bring you to the **Audit Logs** page, which shows a (possibly empty) list of audit logs. |
There was a problem hiding this comment.
Suggested change
| 1. In the top navigation bar, select **Organization**, then choose **Audit Logs** from the dropdown menu. This will bring you to the **Audit Logs** page, which shows a (possibly empty) list of audit logs. | |
| 1. In the top navigation bar, open the **Organization** menu and select **Audit Logs**. |
- There are many possible ways to say this. Here's one concise style that I like. (I prefer to avoid drop-down in the context of describing the UI of the menu. Just my 2c.) If you were matching common patterns in the docs, feel free to leave as-is for consistency.
- I lean toward dropping the mention that the list may be empty. On a very new org, perhaps this is the case, but the Org Admin would presumably know that they haven't yet had any of the 'loggable' events we mention above.
| CockroachDB {{ site.data.products.cloud }} captures audit logs when many types of events occur, such as when a cluster is created or when a user is added to or removed from an organization. | ||
|
|
||
| ## View audit logs | ||
|
|
There was a problem hiding this comment.
Suggested change
| To access the **Audit Logs** page: | |
Sets the stage/goal and lets us avoid adding it to the last step.
| 1. In the top navigation bar, select **Organization**, then choose **Audit Logs** from the dropdown menu. This will bring you to the **Audit Logs** page, which shows a (possibly empty) list of audit logs. | ||
|
|
||
| ## Filter audit logs | ||
| Filter the audit logs by the following fields: |
There was a problem hiding this comment.
Suggested change
| Filter the audit logs by the following fields: | |
| You can filter audit logs by the following fields: |
|
|
||
| - **Time Range (UTC)**: | ||
| - Default: Last 48 hours. | ||
| - To set the time range, select **Start date** or **End date**. Select your desired time range in the calendar dropdown or type in your desired dates and times. |
There was a problem hiding this comment.
Suggested change
| - To set the time range, select **Start date** or **End date**. Select your desired time range in the calendar dropdown or type in your desired dates and times. | |
| - To set the time range, click the **Time Range (UTC)** field. You can select a **Start date** and **End date** from the displayed calendar or manually enter dates and times for the range. |
| - Default: Last 48 hours. | ||
| - To set the time range, select **Start date** or **End date**. Select your desired time range in the calendar dropdown or type in your desired dates and times. | ||
| - **User email**: Select one or more email addresses from the list of [organization members]({% link cockroachcloud/managing-access.md %}#manage-an-organizations-users) (optional). | ||
| - **Action name**: Select one or more predefined auditable actions (optional). |
There was a problem hiding this comment.
I'm going to create a follow up issue for us to define these. (I found them here.)
|
|
||
| Click on a log row in the audit logs table to open an **Action details** right sidebar displaying event information, including the full payload in the **Details** section. | ||
|
|
||
| ## URL Query Parameters |
There was a problem hiding this comment.
Suggested change
| ## URL Query Parameters | |
| ## URL query parameters |
| https://cockroachlabs.cloud/audit-logs?startingFrom=2025-03-04T19%3A51%3A36.590Z&endingAt=2025-03-07T19%3A51%3A36.000-05%3A00&logId=78d55b3c-424e-45fa-bbce-03f2ed738897 | ||
| ``` | ||
|
|
||
| ## Examples |
There was a problem hiding this comment.
Suggested change
| ## Examples | |
| ## Example use cases |
| - Verifying cluster deletions | ||
| - Example: To ensure cluster deletions were intentional, filter by the action `DELETE_CLUSTER`. | ||
| - Diagnosing performance issues | ||
| - Example: To track configuration changes affecting performance, filter by the action `UPDATE_CLUSTER` |
There was a problem hiding this comment.
Suggested change
| - Example: To track configuration changes affecting performance, filter by the action `UPDATE_CLUSTER` | |
| - Example: To track configuration changes affecting performance, filter by the action `UPDATE_CLUSTER`. |
| - Reviewing maintenance schedule changes | ||
| - Example: To track modifications to maintenance windows, filter by the actions `SET_CLUSTER_MAINTENANCE_WINDOW` and `DELETE_CLUSTER_MAINTENANCE_WINDOW`. | ||
|
|
||
| ## See also |
There was a problem hiding this comment.
Suggested change
| ## See also | |
| ## See also | |
I like having the line break. More common, and helps markdown readability. However, I don't think we have a defined style, and this format is supported as-is.
| @@ -38,6 +38,10 @@ CockroachDB v25.1 is now generally available for select CockroachDB Cloud {{ sit | |||
| - [CockroachDB (pay-as-you-go)](https://console.cloud.google.com/marketplace/product/cockroachlabs/cockroachdb-pay-as-you-go) on the Google Cloud Marketplace. | |||
| - [Subscribe through the Google Cloud Marketplace]({% link cockroachcloud/billing-management.md %}?filters=gcp#subscribe-through-aws-marketplace) in the CockroachDB {{ site.data.products.cloud }} documentation. | |||
|
|
|||
| ## December 3, 2024 | |||
|
|
|||
| You can now use the CockroachDB {{ site.data.products.cloud }} Console to [view and filter organization-level audit logs]({% link cockroachcloud/organization-audit-logs-in-cloud-console.md %}), providing greater visibility into user activity across your organization. | |||
There was a problem hiding this comment.
Suggested change
| You can now use the CockroachDB {{ site.data.products.cloud }} Console to [view and filter organization-level audit logs]({% link cockroachcloud/organization-audit-logs-in-cloud-console.md %}), providing greater visibility into user activity across your organization. | |
| You can now use the CockroachDB {{ site.data.products.cloud }} Console to [view and filter audit logs]({% link cockroachcloud/organization-audit-logs-in-cloud-console.md %}), providing greater visibility into user activity across your CockroachDB {{ site.data.products.cloud }} organization. |
Could've been misinterpreted to mean activity affecting the whole org. This edit may be sufficient.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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-11808
Added organization-audit-logs-in-cloud-console.md.
In cloud-deployments.json, added link to organization-audit-logs-in-cloud-console.md.
In cloud.md, added release note for feature.
Rendered preview