Skip to content

Commit 451e28d

Browse files
nerda-codesnerda-codes
authored
docs(add): audit trail export to bucket feature (#5782)
1 parent 04dad20 commit 451e28d

File tree

4 files changed

+111
-3
lines changed

4 files changed

+111
-3
lines changed

‎pages/audit-trail/concepts.mdx‎

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Audit Trail - Concepts
33
description: Learn fundamental concepts of Scaleway's Audit Trail.
44
tags: audit-trail log events access
55
dates:
6-
validation: 2025-06-03
6+
validation: 2025-11-10
77
---
88

99
## Audit Trail
@@ -18,6 +18,38 @@ Audit Trail allows you to view the metadata of the API method used, allowing you
1818

1919
An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway.
2020

21+
## Export
22+
23+
Audit Trail exports allow you to upload your [event](#event) logs from the past 90 days to any [Object Storage](/object-storage/) bucket. By default, your event logs are exported to the `Standard` [storage class](/object-storage/concepts/#storage-class) or to the storage class you have selected upon bucket creation.
24+
25+
This feature leverages Object Storage benefits which include:
26+
27+
- Fine-grained access management with [bucket policies](/object-storage/api-cli/bucket-policy/)
28+
- Versioning of events for traceability and recovery
29+
- Lifecycle rules to automate data archiving or deletion
30+
- Flexible backup options through integration with third-party tools
31+
- Object lock to protect data from accidental deletion
32+
33+
Once configured, your export runs automatically. Every day, the previous day’s Audit Trail events are exported to your chosen bucket. This provides a secure, durable, and centralized location for long-term retention, analysis, and compliance.
34+
35+
<Message type="note">
36+
At this stage, an export includes all Audit Trail events by default, allowing only one active export configuration per region. Future updates will let you select specific events for export.
37+
</Message>
38+
39+
## Prefix
40+
41+
A prefix is a string of characters at the beginning of the [object key name](/object-storage/concepts/#object). They are often used to organize your data similarly to directories.
42+
43+
In the context of Scaleway Object Storage, prefixes are used to display folders in the Scaleway console for practical reasons. The `/` character in a prefix is used as a delimiter to allow you to organize your objects hierarchically.
44+
45+
Your Audit Trail export's event logs are stored in your Object Storage according to the following structure: `prefix/YYYY/MM/DD/logs_xxxxxxxxx.json`.
46+
47+
Below is an example of what your export might look like:
48+
49+
- `audit-trail-export/2025/09/15/logs_xxxxxxxxx.json`
50+
- `audit-trail-export/2025/10/20/logs_xxxxxxxxx.json`
51+
- `audit-trail-export/2025/11/11/logs_xxxxxxxxx.json`
52+
2153
## Project
2254

2355
In the context of Audit Trail, a Project refers to the place where the Scaleway resources being monitored are located. They can be located in different Scaleway Projects, of different Scaleway Organizations.
@@ -28,7 +60,7 @@ A method in the context of Audit Trail is the API call sent to the Audit Trail A
2860

2961
## Region
3062

31-
A region is the geographical area in which your resources are located (Paris, Amsterdam, Warsaw).
63+
A region is the geographical area in which your resources are located (Paris, Amsterdam, Warsaw).
3264

3365
Audit Trail allows you to select and filter your resources by region and Scaleway Project. This allows you to better sort through your resources.
3466

‎pages/audit-trail/faq.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Audit Trail FAQ
33
description: Get answers on using Scaleway's Audit Trail to monitor events, enhance security, and track activities across your resources
44
productIcon: AuditTrailProductIcon
55
dates:
6-
validation: 2025-08-18
6+
validation: 2025-11-10
77
---
88

99
## Overview
@@ -29,6 +29,10 @@ Find out more about product availability in the [dedicated documentation](/accou
2929
### How am I billed for using Audit Trail?
3030
Audit Trail is free of charge.
3131

32+
### How am I billed for Audit Trail exports to an Object Storage bucket?
33+
34+
Audit Trail exports are free of charge, but using Object Storage may incur additional charges. Refer to the [Object Storage FAQ](/object-storage/faq/#how-am-i-billed-for-object-storage) for more information on pricing.
35+
3236
## Compatibility and integration
3337

3438
### Which Scaleway products are integrated with Audit Trail?

‎pages/audit-trail/how-to/manage-adt-export.mdx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: How to create and manage Audit Trail exports
3+
description: Learn how to export your Audit Trail event logs to your Object Storage bucket, retrieve your export, and securely manage your data
4+
tags: audit-trail events track filter export-to-bucket
5+
dates:
6+
validation: 2025-11-13
7+
posted: 2025-11-13
8+
---
9+
10+
import Requirements from '@macros/iam/requirements.mdx'
11+
12+
This page shows you how to export your Audit Trail event logs to an Object Storage bucket, and retrieve an export using the [Scaleway console](https://console.scaleway.com/).
13+
14+
By default, your event logs are exported to the `Standard` [storage class](/object-storage/concepts/#storage-class) or to the storage class you have selected upon bucket creation.
15+
16+
<Requirements />
17+
18+
- A Scaleway account logged into the [console](https://console.scaleway.com)
19+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
20+
- Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail
21+
- [Created](/object-storage/how-to/create-a-bucket/) an Object Storage bucket with [object lock](/object-storage/api-cli/object-lock/#how-to-configure-bucket-lock) set up
22+
23+
<Message type="note">
24+
At this stage, an export includes all Audit Trail events by default, allowing only one active export configuration per region. Future updates will let you select specific events for export.
25+
</Message>
26+
27+
## How to create an export
28+
29+
1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu.
30+
2. Click the **Region** drop-down and select a region in which you have Audit Trail events.
31+
3. Click **Create export**. You are prompted to create an event export.
32+
4. Fill out the required information to configure your **destination bucket**:
33+
1. In the **Bucket region** drop-down, select the region in which you have created your bucket.
34+
2. In the **Bucket project** drop-down, select the Scaleway project in which you have created your bucket.
35+
3. In the **Destination bucket** drop-down, select your bucket.
36+
4. In the **Prefix** field, enter a [prefix](/audit-trail/concepts/#prefix) to define the folder path where your event logs will be stored.
37+
5. Click **Next** to move on to the Audit Trail export creation step.
38+
5. Enter a name and optional tags for the Audit Trail export, then click **Next**.
39+
6. Review your export configuration and click **Create export** to confirm. Your export displays in the **Exports** tab.
40+
<Message type="note">
41+
The first Audit Trail export includes data from the past 90 days and may take a few minutes to complete.
42+
</Message>
43+
44+
## How to retrieve and manage an export
45+
46+
1. Click **Object Storage** in the **Storage** section of the [Scaleway console](https://console.scaleway.com/) side menu.
47+
2. Click the **Region** drop-down and select the region in which you have created your destination bucket.
48+
3. Click your destination bucket.
49+
Your Audit Trail export folder displays. Inside this folder, you will find a `2025` folder (corresponding to the year), in which you will find three other folders, for example, `09`, `10`, and `11` (corresponding to the last 3 months). Each of these folders contains a `DD` folder corresponding to the day the event logs happened. Your Audit Trail export is located inside the `DD` folder, as a JSON file.
50+
4. Access the `YYYY` folder, the desired `MM` folder, and the `DD` folder. Your export should display as follows: `logs_xxxxxxxxx.json`.
51+
5. Click the <Icon name="download" /> icon to download your export.
52+
6. Optionally, click the <Icon name="seeMore" /> icon and click:
53+
1. **More info** to display object information
54+
2. **Visibility** to change your [object visibility](/object-storage/concepts/#visibility)
55+
3. **Object metadata** to add information.
56+
4. **Object tags** to add tags
57+
5. **Edit name** to update the name of your file
58+
6. **Get public link** to publicly share your file
59+
7. **Delete** to delete your export **from the bucket**
60+
61+
62+
## How to delete an export
63+
64+
1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu.
65+
2. Click the **Region** drop-down and select the region in which you have created your Audit Trail export.
66+
3. Click the **Exports** tab. Your export displays.
67+
4. Click the <Icon name="delete" /> icon to delete your export.
68+
5. Type **DELETE** and click **Delete export** to confirm.

‎pages/audit-trail/menu.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ export const auditTrailMenu = {
2626
label: 'Use Audit Trail',
2727
slug: 'use-audit-trail',
2828
},
29+
{
30+
label: 'Create and manage Audit Trail exports',
31+
slug: 'manage-adt-export',
32+
},
2933
],
3034
label: 'How to',
3135
slug: 'how-to',

0 commit comments

Comments
 (0)