From cc773e95f66f16a00c9e53fcf824d22b9e438d3a Mon Sep 17 00:00:00 2001 From: Laurin Quast Date: Fri, 27 Dec 2024 11:11:08 +0100 Subject: [PATCH] docs: audit log changeset + documentation (#6222) --- .changeset/fair-donuts-cough.md | 2 ++ .../web/docs/src/pages/docs/management/_meta.ts | 1 + .../src/pages/docs/management/audit-logs.mdx | 15 +++++++++++++++ .../2024-12-27-audit-logs/index.mdx | 17 +++++++++++++++++ 4 files changed, 35 insertions(+) create mode 100644 packages/web/docs/src/pages/docs/management/audit-logs.mdx create mode 100644 packages/web/docs/src/pages/product-updates/2024-12-27-audit-logs/index.mdx diff --git a/.changeset/fair-donuts-cough.md b/.changeset/fair-donuts-cough.md index f7d09cb31..8d42eaaa6 100644 --- a/.changeset/fair-donuts-cough.md +++ b/.changeset/fair-donuts-cough.md @@ -8,3 +8,5 @@ Each organization now has an audit log of all user actions that can be exported Exported audit logs are stored on the pre-configured S3 storage. In case you want to store exported audit logs on a separate S3 bucket, you can use the `S3_AUDIT_LOG` prefixed environment variables for the configuration. + +[Learn more.](https://graphql-hive.com/product-updates/2024-12-27-audit-logs) diff --git a/packages/web/docs/src/pages/docs/management/_meta.ts b/packages/web/docs/src/pages/docs/management/_meta.ts index f2cd9c420..79a60fc30 100644 --- a/packages/web/docs/src/pages/docs/management/_meta.ts +++ b/packages/web/docs/src/pages/docs/management/_meta.ts @@ -3,4 +3,5 @@ export default { 'sso-oidc-provider': 'SSO with OIDC', projects: 'Projects & Alerts', targets: 'Targets & Tokens', + 'audit-logs': 'Audit Logs', }; diff --git a/packages/web/docs/src/pages/docs/management/audit-logs.mdx b/packages/web/docs/src/pages/docs/management/audit-logs.mdx new file mode 100644 index 000000000..9e654d3cf --- /dev/null +++ b/packages/web/docs/src/pages/docs/management/audit-logs.mdx @@ -0,0 +1,15 @@ +# Audit Logs + +Each organization has an audit log in which user actions are recorded. Actions recorded by the audit +log are retained for one year. + +The audit logs provides a detailed record of activities and transactions for accountability, +security, compliance and troubleshooting. + +## Export the Audit Log + +Within the organization settings, users with sufficient permissions can perform an audit log export. +Exporting the audit log requires select a start and end date. + +After the audit log export is completed and email with a link to the CSV document is sent to the +users email address. diff --git a/packages/web/docs/src/pages/product-updates/2024-12-27-audit-logs/index.mdx b/packages/web/docs/src/pages/product-updates/2024-12-27-audit-logs/index.mdx new file mode 100644 index 000000000..50fef48b4 --- /dev/null +++ b/packages/web/docs/src/pages/product-updates/2024-12-27-audit-logs/index.mdx @@ -0,0 +1,17 @@ +--- +title: Audit Logs +description: Track actions within your organization. +date: 2024-12-27 +authors: [laurin] +--- + +We've added audit logs to Hive! + +Audit logs help you understand the occurrence of an event (e.g. configuration change) caused by user +actions. This helps having a detailed record of activities and transactions for accountability, +security, compliance and troubleshooting. + +Organization admins can perform an audit log export within the organization settings. Once the +export is completed, it will be sent to the admins email address. + +[Read the Audit Log documentation.](https://graphql-hive.com/docs/management/audit-logs)