Bucket Logging (Available Upon Request)
The GetBucketLogging
and PutBucketLogging
actions are not available, however, you can get the same functionality by following the steps below.
Request Bucket Logging: This feature is currently provided upon request - please submit your request here, and include "Enable Bucket Logging" as the subject:
Note: It may take up to two weeks to process your request.
Enabling Bucket Logging
To enable bucket logging, you will be asked to provide us with the following information via a secure channel:
Information Needed to Enable Logging
Item | Details |
---|---|
Satellite | The Satellite your project is on: AP1, EU1, or US1 |
Project Name | Your project's name |
Bucket Name(s) | The bucket(s) to log |
Information About the Destination for Logs
Item | Details |
---|---|
Destination Project Name | The project where logs will be stored |
Destination Bucket Name | The bucket to store logs |
Prefix (optional) | Prefix for log object keys |
Write-only Access Grant | Access grant with write-only permissions (see steps below) |
Steps to Create a Write-Only Access Grant for Logging Destination
Important: Access grants used to access the watched bucket need to be created after June 25th 2024.
Generate a New Access Grant:
- Log in to the Satellite UI.
- Click New Access Key and select "Access Grant".
- Name the access grant appropriately.
Select Advanced Options:
- On the second screen, click on "Advanced Options".
- This allows you to customize permissions for the access grant.
Set Encryption Passphrase:
- Enter an encryption passphrase of your choice.
Important: Keep this passphrase secure. Losing it will prevent you from decrypting the log data.
Configure Permissions:
- On the permissions screen, select "Write Only".
- Ensure no other permissions are granted.
- This restricts the access grant to only write logging files without the ability to read, delete, or overwrite them.
Limit Access to Destination Bucket:
- Specify the destination bucket for the logs.
- This limits the access grant to the specified bucket only.
Set Expiration (Optional):
- You can add an expiration date to the access.
Recommendation: Select "No Expiration" to ensure continuous logging. If the access expires, logging will stop.
Review and Create Access Grant:
- Confirm all selections are correct.
- Click on "Create Access" to generate the access grant.
Provide Access Grant to Storj:
- Send us the generated access grant over a secure channel.
Log Format
The log objects are stored in the following key format with non-date-based partitioning:
Example:
Log Fields
The fields in the logs conform to the Amazon S3 Server Access Log Format.