From a11e44035eff7d43156f998b1b1f7df60c3da7cc Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 10 Nov 2025 14:27:24 +0100 Subject: [PATCH 1/6] docs(add): doc --- pages/audit-trail/concepts.mdx | 18 ++++++++-- .../audit-trail/how-to/create-adt-export.mdx | 35 +++++++++++++++++++ 2 files changed, 51 insertions(+), 2 deletions(-) create mode 100644 pages/audit-trail/how-to/create-adt-export.mdx diff --git a/pages/audit-trail/concepts.mdx b/pages/audit-trail/concepts.mdx index 6b945ab810..86e6f465e9 100644 --- a/pages/audit-trail/concepts.mdx +++ b/pages/audit-trail/concepts.mdx @@ -3,7 +3,7 @@ title: Audit Trail - Concepts description: Learn fundamental concepts of Scaleway's Audit Trail. tags: audit-trail log events access dates: - validation: 2025-06-03 + validation: 2025-11-05 --- ## Audit Trail @@ -18,6 +18,20 @@ Audit Trail allows you to view the metadata of the API method used, allowing you An event is a record of any activity related to your Scaleway resources, encompassing actions by users, applications, or Scaleway. +## Export + +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: + +- Fine-grained access management with [bucket policies](/object-storage/api-cli/bucket-policy/) +- Versioning of events for traceability and recovery +- Lifecycle rules to automate data archiving or deletion +- Flexible backup options through integration with third-party tools +- Object lock to protect data from accidental deletion + +## Prefix + + + ## Project 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 +42,7 @@ A method in the context of Audit Trail is the API call sent to the Audit Trail A ## Region -A region is the geographical area in which your resources are located (Paris, Amsterdam, Warsaw). +A region is the geographical area in which your resources are located (Paris, Amsterdam, Warsaw). Audit Trail allows you to select and filter your resources by region and Scaleway Project. This allows you to better sort through your resources. diff --git a/pages/audit-trail/how-to/create-adt-export.mdx b/pages/audit-trail/how-to/create-adt-export.mdx new file mode 100644 index 0000000000..dbd8706d14 --- /dev/null +++ b/pages/audit-trail/how-to/create-adt-export.mdx @@ -0,0 +1,35 @@ +--- +title: How to create an Audit Trail export +description: Learn how to export your Audit Trail event logs to your Object Storage bucket and securely manage your data +tags: audit-trail events track filter +dates: + validation: 2025-11-10 + posted: 2025-11-10 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +This page shows you how to export your Audit Trail event logs to an Object Storage bucket using the [Scaleway console](https://console.scaleway.com/). + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail +- [Created](/object-storage/how-to/create-a-bucket/) an Object Storage bucket located in the same region as your Audit Trail events + +1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Click the **Region** drop-down and select a region in which you have Audit Trail events. +3. Click **Create export**. You are prompted to create an event export. +4. Fill out the required information to configure your **destination bucket**: + 1. In the **Bucket region** drop-down, select the region in which you have created your bucket. + 2. In the **Bucket project** drop-down, select the Scaleway project in which you have created your bucket. + 3. In the **Destination bucket** drop-down, select your bucket. + 4. In the **Prefix** field, enter a prefix to define the folder path where your event logs will be stored. + 5. Click **Next** to move on to the Audit Trail export creation step. +5. Enter a name and optional tags for the Audit Trail export, then click **Next**. +6. Review your export and click **Create export** to confirm. + + + The first Audit Trail export includes data from the past 90 days and may take a few minutes to complete. + From d959752c6ae606be46ae104e10b8d654cfee71dc Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 10 Nov 2025 17:31:35 +0100 Subject: [PATCH 2/6] docs(add): adt export --- pages/audit-trail/concepts.mdx | 22 ++++++- .../audit-trail/how-to/create-adt-export.mdx | 35 ---------- .../audit-trail/how-to/manage-adt-export.mdx | 66 +++++++++++++++++++ pages/audit-trail/menu.ts | 4 ++ 4 files changed, 90 insertions(+), 37 deletions(-) delete mode 100644 pages/audit-trail/how-to/create-adt-export.mdx create mode 100644 pages/audit-trail/how-to/manage-adt-export.mdx diff --git a/pages/audit-trail/concepts.mdx b/pages/audit-trail/concepts.mdx index 86e6f465e9..99e662cd84 100644 --- a/pages/audit-trail/concepts.mdx +++ b/pages/audit-trail/concepts.mdx @@ -3,7 +3,7 @@ title: Audit Trail - Concepts description: Learn fundamental concepts of Scaleway's Audit Trail. tags: audit-trail log events access dates: - validation: 2025-11-05 + validation: 2025-11-10 --- ## Audit Trail @@ -20,7 +20,9 @@ An event is a record of any activity related to your Scaleway resources, encompa ## Export -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: +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. + +This feature leverages Object Storage benefits which include: - Fine-grained access management with [bucket policies](/object-storage/api-cli/bucket-policy/) - Versioning of events for traceability and recovery @@ -28,9 +30,25 @@ Audit Trail exports allow you to upload your [event](#event) logs to any [Object - Flexible backup options through integration with third-party tools - Object lock to protect data from accidental deletion +Exporting Audit Trail events to Object Storage provides a secure, durable, and centralized location for long-term retention, analysis, and compliance. + + + 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. + + ## Prefix +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. + +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. + +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`. + +Below is an example of what your export might look like: +- `audit-trail-export/2025/09/15/logs_xxxxxxxxx.json` +- `audit-trail-export/2025/10/20/logs_xxxxxxxxx.json` +- `audit-trail-export/2025/11/11/logs_xxxxxxxxx.json` ## Project diff --git a/pages/audit-trail/how-to/create-adt-export.mdx b/pages/audit-trail/how-to/create-adt-export.mdx deleted file mode 100644 index dbd8706d14..0000000000 --- a/pages/audit-trail/how-to/create-adt-export.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: How to create an Audit Trail export -description: Learn how to export your Audit Trail event logs to your Object Storage bucket and securely manage your data -tags: audit-trail events track filter -dates: - validation: 2025-11-10 - posted: 2025-11-10 ---- - -import Requirements from '@macros/iam/requirements.mdx' - -This page shows you how to export your Audit Trail event logs to an Object Storage bucket using the [Scaleway console](https://console.scaleway.com/). - - - -- A Scaleway account logged into the [console](https://console.scaleway.com) -- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization -- Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail -- [Created](/object-storage/how-to/create-a-bucket/) an Object Storage bucket located in the same region as your Audit Trail events - -1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu. -2. Click the **Region** drop-down and select a region in which you have Audit Trail events. -3. Click **Create export**. You are prompted to create an event export. -4. Fill out the required information to configure your **destination bucket**: - 1. In the **Bucket region** drop-down, select the region in which you have created your bucket. - 2. In the **Bucket project** drop-down, select the Scaleway project in which you have created your bucket. - 3. In the **Destination bucket** drop-down, select your bucket. - 4. In the **Prefix** field, enter a prefix to define the folder path where your event logs will be stored. - 5. Click **Next** to move on to the Audit Trail export creation step. -5. Enter a name and optional tags for the Audit Trail export, then click **Next**. -6. Review your export and click **Create export** to confirm. - - - The first Audit Trail export includes data from the past 90 days and may take a few minutes to complete. - diff --git a/pages/audit-trail/how-to/manage-adt-export.mdx b/pages/audit-trail/how-to/manage-adt-export.mdx new file mode 100644 index 0000000000..bf2551cb00 --- /dev/null +++ b/pages/audit-trail/how-to/manage-adt-export.mdx @@ -0,0 +1,66 @@ +--- +title: How to create and manage Audit Trail exports +description: Learn how to export your Audit Trail event logs to your Object Storage bucket, retrieve your export, and securely manage your data +tags: audit-trail events track filter export-to-bucket +dates: + validation: 2025-11-10 + posted: 2025-11-10 +--- + +import Requirements from '@macros/iam/requirements.mdx' + +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/). + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail +- [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 + + + 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. + + +## How to create an export + +1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Click the **Region** drop-down and select a region in which you have Audit Trail events. +3. Click **Create export**. You are prompted to create an event export. +4. Fill out the required information to configure your **destination bucket**: + 1. In the **Bucket region** drop-down, select the region in which you have created your bucket. + 2. In the **Bucket project** drop-down, select the Scaleway project in which you have created your bucket. + 3. In the **Destination bucket** drop-down, select your bucket. + 4. In the **Prefix** field, enter a [prefix](/audit-trail/concepts/#prefix) to define the folder path where your event logs will be stored. + 5. Click **Next** to move on to the Audit Trail export creation step. +5. Enter a name and optional tags for the Audit Trail export, then click **Next**. +6. Review your export configuration and click **Create export** to confirm. Your export displays in the **Exports** tab. + + The first Audit Trail export includes data from the past 90 days and may take a few minutes to complete. + + +## How to retrieve and manage an export + +1. Click **Object Storage** in the **Storage** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Click the **Region** drop-down and select the region in which you have created your destination bucket. +3. Click your destination bucket. + 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. +4. Access the `YYYY` folder, the desired `MM` folder, and the `DD` folder. Your export should display as follows: `logs_xxxxxxxxx.json`. +5. Click the icon to download your export. +6. Optionnally, click the icon and click: + 1. **More info** to display object information + 2. **Visibility** to change your [object visibility](/object-storage/concepts/#visibility) + 3. **Object metadata** to add information. + 4. **Object tags** to add tags + 5. **Edit name** to update the name of your file + 6. **Get public link** to publicly share your file + 7. **Delete** to delete your export **from the bucket** + + +## How to delete an export + +1. Click **Audit Trail** in the **Monitoring** section of the [Scaleway console](https://console.scaleway.com/) side menu. +2. Click the **Region** drop-down and select the region in which you have created your Audit Trail export. +3. Click the **Exports** tab. Your export displays. +4. Click the icon to delete your export. +5. Type **DELETE** and click **Delete export** to confirm. \ No newline at end of file diff --git a/pages/audit-trail/menu.ts b/pages/audit-trail/menu.ts index 0cfca34cf2..66163868cc 100644 --- a/pages/audit-trail/menu.ts +++ b/pages/audit-trail/menu.ts @@ -26,6 +26,10 @@ export const auditTrailMenu = { label: 'Use Audit Trail', slug: 'use-audit-trail', }, + { + label: 'Create and manage Audit Trail exports', + slug: 'manage-adt-export', + }, ], label: 'How to', slug: 'how-to', From 96eec9eedd9ce6635d6677dbeb553cc66a6cec59 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 10 Nov 2025 17:38:26 +0100 Subject: [PATCH 3/6] docs(add): faq billing question --- pages/audit-trail/faq.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pages/audit-trail/faq.mdx b/pages/audit-trail/faq.mdx index f0aa4cc8a4..62bebd0ff3 100644 --- a/pages/audit-trail/faq.mdx +++ b/pages/audit-trail/faq.mdx @@ -3,7 +3,7 @@ title: Audit Trail FAQ description: Get answers on using Scaleway's Audit Trail to monitor events, enhance security, and track activities across your resources productIcon: AuditTrailProductIcon dates: - validation: 2025-08-18 + validation: 2025-11-10 --- ## Overview @@ -29,6 +29,10 @@ Find out more about product availability in the [dedicated documentation](/accou ### How am I billed for using Audit Trail? Audit Trail is free of charge. +### How am I billed for Audit Trail exports to an Object Storage bucket? + +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. + ## Compatibility and integration ### Which Scaleway products are integrated with Audit Trail? From 8b4f795fa5640e09d2dd84c45757c623b93c4158 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Thu, 13 Nov 2025 15:54:54 +0100 Subject: [PATCH 4/6] docs(fix): feedback mathias --- pages/audit-trail/concepts.mdx | 4 ++-- pages/audit-trail/how-to/manage-adt-export.mdx | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/audit-trail/concepts.mdx b/pages/audit-trail/concepts.mdx index 99e662cd84..2db174a790 100644 --- a/pages/audit-trail/concepts.mdx +++ b/pages/audit-trail/concepts.mdx @@ -20,7 +20,7 @@ An event is a record of any activity related to your Scaleway resources, encompa ## Export -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. +Audit Trail exports allow you to upload your [event](#event) logs from the past 90 days to any [Object Storage](/object-storage/) bucket. This feature leverages Object Storage benefits which include: @@ -30,7 +30,7 @@ This feature leverages Object Storage benefits which include: - Flexible backup options through integration with third-party tools - Object lock to protect data from accidental deletion -Exporting Audit Trail events to Object Storage provides a secure, durable, and centralized location for long-term retention, analysis, and compliance. +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. 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. diff --git a/pages/audit-trail/how-to/manage-adt-export.mdx b/pages/audit-trail/how-to/manage-adt-export.mdx index bf2551cb00..363063cdf8 100644 --- a/pages/audit-trail/how-to/manage-adt-export.mdx +++ b/pages/audit-trail/how-to/manage-adt-export.mdx @@ -3,8 +3,8 @@ title: How to create and manage Audit Trail exports description: Learn how to export your Audit Trail event logs to your Object Storage bucket, retrieve your export, and securely manage your data tags: audit-trail events track filter export-to-bucket dates: - validation: 2025-11-10 - posted: 2025-11-10 + validation: 2025-11-13 + posted: 2025-11-13 --- import Requirements from '@macros/iam/requirements.mdx' @@ -16,7 +16,7 @@ This page shows you how to export your Audit Trail event logs to an Object Stora - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Created [resources integrated](/audit-trail/reference-content/resource-integration-with-adt/) with Audit Trail -- [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 +- [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 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. From e99f8b9d9118552b8c64a9f7658794deb7913800 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=A9da?= <87707325+nerda-codes@users.noreply.github.com> Date: Fri, 14 Nov 2025 11:30:38 +0100 Subject: [PATCH 5/6] docs(add): ro review Co-authored-by: Rowena Jones <36301604+RoRoJ@users.noreply.github.com> --- pages/audit-trail/faq.mdx | 2 +- pages/audit-trail/how-to/manage-adt-export.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pages/audit-trail/faq.mdx b/pages/audit-trail/faq.mdx index 62bebd0ff3..bffd7b56b2 100644 --- a/pages/audit-trail/faq.mdx +++ b/pages/audit-trail/faq.mdx @@ -31,7 +31,7 @@ Audit Trail is free of charge. ### How am I billed for Audit Trail exports to an Object Storage bucket? -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. +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. ## Compatibility and integration diff --git a/pages/audit-trail/how-to/manage-adt-export.mdx b/pages/audit-trail/how-to/manage-adt-export.mdx index 363063cdf8..6acca4406b 100644 --- a/pages/audit-trail/how-to/manage-adt-export.mdx +++ b/pages/audit-trail/how-to/manage-adt-export.mdx @@ -47,7 +47,7 @@ This page shows you how to export your Audit Trail event logs to an Object Stora 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. 4. Access the `YYYY` folder, the desired `MM` folder, and the `DD` folder. Your export should display as follows: `logs_xxxxxxxxx.json`. 5. Click the icon to download your export. -6. Optionnally, click the icon and click: +6. Optionally, click the icon and click: 1. **More info** to display object information 2. **Visibility** to change your [object visibility](/object-storage/concepts/#visibility) 3. **Object metadata** to add information. From d03e21923c85ea4722c09ca64b07203d523f8232 Mon Sep 17 00:00:00 2001 From: nerda-codes Date: Mon, 17 Nov 2025 14:15:19 +0100 Subject: [PATCH 6/6] docs(add): storage class specs --- pages/audit-trail/concepts.mdx | 2 +- pages/audit-trail/how-to/manage-adt-export.mdx | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/pages/audit-trail/concepts.mdx b/pages/audit-trail/concepts.mdx index 2db174a790..7a55b58d98 100644 --- a/pages/audit-trail/concepts.mdx +++ b/pages/audit-trail/concepts.mdx @@ -20,7 +20,7 @@ An event is a record of any activity related to your Scaleway resources, encompa ## Export -Audit Trail exports allow you to upload your [event](#event) logs from the past 90 days to any [Object Storage](/object-storage/) bucket. +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. This feature leverages Object Storage benefits which include: diff --git a/pages/audit-trail/how-to/manage-adt-export.mdx b/pages/audit-trail/how-to/manage-adt-export.mdx index 6acca4406b..be58b19ba9 100644 --- a/pages/audit-trail/how-to/manage-adt-export.mdx +++ b/pages/audit-trail/how-to/manage-adt-export.mdx @@ -11,6 +11,8 @@ import Requirements from '@macros/iam/requirements.mdx' 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/). +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. + - A Scaleway account logged into the [console](https://console.scaleway.com)