Skip to content

Commit d959752

Browse files
nerda-codesnerda-codes
committed
docs(add): adt export
1 parent a11e440 commit d959752

File tree

4 files changed

+90
-37
lines changed

4 files changed

+90
-37
lines changed

‎pages/audit-trail/concepts.mdx‎

Lines changed: 20 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-11-05
6+
validation: 2025-11-10
77
---
88

99
## Audit Trail
@@ -20,17 +20,35 @@ An event is a record of any activity related to your Scaleway resources, encompa
2020

2121
## Export
2222

23-
Audit Trail exports allow you to upload your [event](#event) logs to any [Object Storage](/object-storage/) bucket as long as it is located in the same region as the events. This leverages Object Storage features and benefits which include:
23+
Audit Trail exports allow you to upload your [event](#event) logs from the past 90 days to any [Object Storage](/object-storage/) bucket located in the same region as the events.
24+
25+
This feature leverages Object Storage benefits which include:
2426

2527
- Fine-grained access management with [bucket policies](/object-storage/api-cli/bucket-policy/)
2628
- Versioning of events for traceability and recovery
2729
- Lifecycle rules to automate data archiving or deletion
2830
- Flexible backup options through integration with third-party tools
2931
- Object lock to protect data from accidental deletion
3032

33+
Exporting Audit Trail events to Object Storage 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+
3139
## Prefix
3240

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:
3348

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`
3452

3553
## Project
3654

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

Lines changed: 0 additions & 35 deletions
This file was deleted.

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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-10
7+
posted: 2025-11-10
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+
<Requirements />
15+
16+
- A Scaleway account logged into the [console](https://console.scaleway.com)
17+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
18+
- Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail
19+
- [Created](/object-storage/how-to/create-a-bucket/) an Object Storage bucket in the same region as your Audit Trail events and with [object lock](/object-storage/api-cli/object-lock/#how-to-configure-bucket-lock) set update
20+
21+
<Message type="note">
22+
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.
23+
</Message>
24+
25+
## How to create an export
26+
27+
1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu.
28+
2. Click the **Region** drop-down and select a region in which you have Audit Trail events.
29+
3. Click **Create export**. You are prompted to create an event export.
30+
4. Fill out the required information to configure your **destination bucket**:
31+
1. In the **Bucket region** drop-down, select the region in which you have created your bucket.
32+
2. In the **Bucket project** drop-down, select the Scaleway project in which you have created your bucket.
33+
3. In the **Destination bucket** drop-down, select your bucket.
34+
4. In the **Prefix** field, enter a [prefix](/audit-trail/concepts/#prefix) to define the folder path where your event logs will be stored.
35+
5. Click **Next** to move on to the Audit Trail export creation step.
36+
5. Enter a name and optional tags for the Audit Trail export, then click **Next**.
37+
6. Review your export configuration and click **Create export** to confirm. Your export displays in the **Exports** tab.
38+
<Message type="note">
39+
The first Audit Trail export includes data from the past 90 days and may take a few minutes to complete.
40+
</Message>
41+
42+
## How to retrieve and manage an export
43+
44+
1. Click **Object Storage** in the **Storage** section of the [Scaleway console](https://console.scaleway.com/) side menu.
45+
2. Click the **Region** drop-down and select the region in which you have created your destination bucket.
46+
3. Click your destination bucket.
47+
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.
48+
4. Access the `YYYY` folder, the desired `MM` folder, and the `DD` folder. Your export should display as follows: `logs_xxxxxxxxx.json`.
49+
5. Click the <Icon name="download" /> icon to download your export.
50+
6. Optionnally, click the <Icon name="seeMore" /> icon and click:
51+
1. **More info** to display object information
52+
2. **Visibility** to change your [object visibility](/object-storage/concepts/#visibility)
53+
3. **Object metadata** to add information.
54+
4. **Object tags** to add tags
55+
5. **Edit name** to update the name of your file
56+
6. **Get public link** to publicly share your file
57+
7. **Delete** to delete your export **from the bucket**
58+
59+
60+
## How to delete an export
61+
62+
1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu.
63+
2. Click the **Region** drop-down and select the region in which you have created your Audit Trail export.
64+
3. Click the **Exports** tab. Your export displays.
65+
4. Click the <Icon name="delete" /> icon to delete your export.
66+
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)