diff --git a/pages/audit-trail/concepts.mdx b/pages/audit-trail/concepts.mdx index 6b945ab810..7a55b58d98 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-10 --- ## Audit Trail @@ -18,6 +18,38 @@ 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 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: + +- 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 + +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. + + +## 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 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 ## 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/faq.mdx b/pages/audit-trail/faq.mdx index f0aa4cc8a4..bffd7b56b2 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? 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..be58b19ba9 --- /dev/null +++ b/pages/audit-trail/how-to/manage-adt-export.mdx @@ -0,0 +1,68 @@ +--- +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-13 + posted: 2025-11-13 +--- + +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) +- [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 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. + + +## 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. 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. + 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',