Bucket Notification Sizing Guidelines

Sizing Fields

During the configuration of bucket notification, ensure the following fields are correctly filled in as they can impact the size of the message sent:

  • bucket name: The name of the bucket that triggers the notification. The maximum length is 63 characters.

  • object key: The key of the object that triggers the notification. The maximum length is 1024 characters.

Example

The following is an example of a bucket notification configuration with an external Kafka cluster (version 3.1.2).

The disk space to allocate to Kafka depends on the workload (i.e. the number of notification events expected at a given moment and the message retention period).

The message sizing is set to 985 bytes.

{
   "Records": [{
       "eventVersion": "1.0",
       "eventSource": "scality:s3",
       "awsRegion": "us-east-1",
       "eventTime": "2023-01-02T15:25:09.629Z",
       "eventName": "s3:ObjectCreated:Put",
       "userIdentity": {
           "principalId": null
       },
       "requestParameters": {
           "sourceIPAddress": null
       },
       "responseElements": {
           "x-amz-request-id": null,
           "x-amz-id-2": null
       },
       "s3": {
           "s3SchemaVersion": "1.0",
           "configurationId": "ZTExY2FmMGEtOWUyMy00ODY1LTlhOWE",
           "bucket": {
               "name": "example-bucket",
               "ownerIdentity": {
                   "principalId": null
               },
               "arn": null
           },
           "object": {
               "key": "example-object",
               "size": "10753",
               "eTag": null,
               "versionId": "aJr8WJ0p2tTV00000000001I4j3QKsvf",
               "sequencer": null
           }
       }
   }]
 }

Note

Refer to Kafka Sizing Considerations for more information on sizing guidelines.