Elgato_dark/console
1
0
Fork 0
mirror of https://github.com/graphql-hive/console synced 2026-05-23 09:08:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: audit log changeset + documentation (#6222)

Browse source
This commit is contained in:
Laurin Quast 2024-12-27 11:11:08 +01:00 committed by GitHub
parent e0eb3bdb28
commit cc773e95f6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 35 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.changeset/fair-donuts-cough.md
View file

@ -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)

1
packages/web/docs/src/pages/docs/management/_meta.ts
View file

@ -3,4 +3,5 @@ export default {
'sso-oidc-provider': 'SSO with OIDC',
projects: 'Projects & Alerts',
targets: 'Targets & Tokens',
'audit-logs': 'Audit Logs',
};

15
packages/web/docs/src/pages/docs/management/audit-logs.mdx Normal file
View file

@ -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.

17
packages/web/docs/src/pages/product-updates/2024-12-27-audit-logs/index.mdx Normal file
View file

@ -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)