diff --git a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md index 67d8a855..f68ef321 100644 --- a/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md +++ b/doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md @@ -7,14 +7,14 @@ description: >- The following options are specific to the s3 destination. -### access-key() +## access-key() |Type:| string| |Default:| N/A| *Description:* The `ACCESS_KEY` of the service account of the S3 bucket. (Used together with secret-key().) -### bucket() +## bucket() |Type:| string| |Default:| N/A| @@ -22,7 +22,7 @@ The following options are specific to the s3 destination. *Description:* The name of the S3 bucket. For example: `my-bucket`. -### canned-acl() +## canned-acl() |Type:| string| |Default:| N/A| @@ -34,46 +34,44 @@ For example: `my-bucket`. If an invalid value is configured, the default is used. -### chunk-size() +## chunk-size() |Type:| string| -|Default:| N/A| +|Default:| 5 MiB| -*Description:* The size of log messages written by syslog-n OSE to the S3 object in a batch. If compression is enabled, the chunk-size() specifies the compressed size. +*Description:* The size of log messages written by {{ site.product.short_name }} to the S3 object in a batch. If compression is enabled, the chunk-size() specifies the compressed size. Must be set to at least 5 MiB. -### compression() +## compression() |Type:| boolean| |Default:| no| *Description:* Setting compression to `yes` enables gzip compression, and implicitly adds a `.gz` suffix to the created object’s key. You can set the level of the compression using the compresslevel() option (`0-9`). -### compresslevel() +## compresslevel() |Type:| integer| -|Default:| 0-9| +|Default:| 9| Description: Only has effect if compression() is set to `yes`. The level of the compression can be set using the compresslevel() option (`0-9`). +## flush-grace-period() -### flush-grace-period() - -|Type:| integer[minutes]| +|Type:| integer [minutes]| |Default:| 60| *Description:* After the grace period expires and no new messages are routed to the destination, {{ site.product.short_name }} flushes the contents of the buffer to the S3 object even if the volume of the messages in the buffer is lower than chunk-size(). -#{% include doc/admin-guide/options/log-fifo-size.md %} +{% include doc/admin-guide/options/log-fifo-size.md %} -### max-object-size() +## max-object-size() -|Type:| number [GiB]| +|Type:| string| |Default:| 5120GiB| *Description:* The maximal size of the S3 object. If an object reaches this size, {{ site.product.short_name }} appends an index suffix ("-1", “-2”, …) to the object key and starts a new object after rotation. -### max-pending-uploads() - +## max-pending-uploads() |Type:| integer| |Default:| 32| @@ -83,38 +81,37 @@ Description: The max-pending-uploads() and upload-threads() options configure th * upload-threads() limits the maximum number of parallel uploads. * max-pending-uploads() limits the number of chunks that are waiting in the work queue of the upload threads to get uploaded -### object-key() +## object-key() |Type:| template| |Default:| N/A| *Description:* The unique object key (or key name), which identifies the object in an Amazon S3 bucket. -### object-key-timestamp() +## object-key-timestamp() |Type:| template| |Default:| N/A| *Description:* The object-key-timestamp() option can be used to set a datetime-related template, which is appended to the end of the object, for example: "`${R_MONTH_ABBREV}${R_DAY}`". When a log message arrives with a newer timestamp template resolution, the previous timestamped object gets finished and a new one is started with the new timestamp. If an older message arrives, it does not reopen the old object, but starts a new object with the key having an index appended to the old object. -#{% include doc/admin-guide/options/persist-name.md %} +{% include doc/admin-guide/options/persist-name.md %} -### region() +## region() |Type:| string| |Default:| N/A| - *Description:* The regional endpoint where the bucket is stored. For example, us-east-1. -### secret-key() +## secret-key() |Type:| string| |Default:| N/A| *Description:* The `SECRET_KEY` of the service account used to access the S3 bucket. (Together with access-key().) -### storage-class() +## storage-class() |Type:| string| |Default:| STANDARD| @@ -125,20 +122,20 @@ Description: The max-pending-uploads() and upload-threads() options configure th If an invalid value is configured, the default is used. -### upload-threads() +## upload-threads() |Type:| integer| |Default:| 8| *Description:* The number of {{ site.product.short_name }} worker threads that are used to upload data to S3 from this destination. -### template() +## template() *Description:* The message as written to the Amazon S3 object. You can use templates and template functions to format the message. -### url() +## url() |Type:| string| |Default:| N/A| -*Description:* The URL of the S3 bucket, for example, `https://my-bucket.s3.us-west-2.amazonaws.com`. +*Description:* The API endpoint URL of the S3 bucket. When used with Amazon AWS, the {{ site.product.short_name }} S3 destination automatically creates the service URL. It is recommended that you omit this option. This option is required only if the {{ site.product.short_name }} S3 driver is used in conjunction with third-party S3 service providers, such as MinIO or Google Cloud.