Skip to content

Commit 9df208f

Browse files
authored
Amazon S3 doc fixups (#159)
- modified heading sizes - modified default for compresslevel() - modified default for chunk-size() and stated minimum size - modified url scheme condition - corrected missing product name variables - corrected type for max-object-size()
2 parents ad1fd20 + 05882eb commit 9df208f

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ description: >-
77

88
The following options are specific to the s3 destination.
99

10-
### access-key()
10+
## access-key()
1111

1212
|Type:| string|
1313
|Default:| N/A|
1414

1515
*Description:* The `ACCESS_KEY` of the service account of the S3 bucket. (Used together with secret-key().)
1616

17-
### bucket()
17+
## bucket()
1818

1919
|Type:| string|
2020
|Default:| N/A|
2121

2222
*Description:* The name of the S3 bucket.
2323
For example: `my-bucket`.
2424

25-
### canned-acl()
25+
## canned-acl()
2626

2727
|Type:| string|
2828
|Default:| N/A|
@@ -34,46 +34,44 @@ For example: `my-bucket`.
3434

3535
If an invalid value is configured, the default is used.
3636

37-
### chunk-size()
37+
## chunk-size()
3838

3939
|Type:| string|
40-
|Default:| N/A|
40+
|Default:| 5 MiB|
4141

42-
*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.
42+
*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.
4343

44-
### compression()
44+
## compression()
4545

4646
|Type:| boolean|
4747
|Default:| no|
4848

4949
*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`).
5050

51-
### compresslevel()
51+
## compresslevel()
5252

5353
|Type:| integer|
54-
|Default:| 0-9|
54+
|Default:| 9|
5555

5656
Description: Only has effect if compression() is set to `yes`. The level of the compression can be set using the compresslevel() option (`0-9`).
5757

58+
## flush-grace-period()
5859

59-
### flush-grace-period()
60-
61-
|Type:| integer[minutes]|
60+
|Type:| integer [minutes]|
6261
|Default:| 60|
6362

6463
*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().
6564

66-
#{% include doc/admin-guide/options/log-fifo-size.md %}
65+
{% include doc/admin-guide/options/log-fifo-size.md %}
6766

68-
### max-object-size()
67+
## max-object-size()
6968

70-
|Type:| number [GiB]|
69+
|Type:| string|
7170
|Default:| 5120GiB|
7271

7372
*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.
7473

75-
### max-pending-uploads()
76-
74+
## max-pending-uploads()
7775

7876
|Type:| integer|
7977
|Default:| 32|
@@ -83,38 +81,37 @@ Description: The max-pending-uploads() and upload-threads() options configure th
8381
* upload-threads() limits the maximum number of parallel uploads.
8482
* max-pending-uploads() limits the number of chunks that are waiting in the work queue of the upload threads to get uploaded
8583

86-
### object-key()
84+
## object-key()
8785

8886
|Type:| template|
8987
|Default:| N/A|
9088

9189
*Description:* The unique object key (or key name), which identifies the object in an Amazon S3 bucket.
9290

93-
### object-key-timestamp()
91+
## object-key-timestamp()
9492

9593
|Type:| template|
9694
|Default:| N/A|
9795

9896
*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.
9997

100-
#{% include doc/admin-guide/options/persist-name.md %}
98+
{% include doc/admin-guide/options/persist-name.md %}
10199

102-
### region()
100+
## region()
103101

104102
|Type:| string|
105103
|Default:| N/A|
106104

107-
108105
*Description:* The regional endpoint where the bucket is stored. For example, us-east-1.
109106

110-
### secret-key()
107+
## secret-key()
111108

112109
|Type:| string|
113110
|Default:| N/A|
114111

115112
*Description:* The `SECRET_KEY` of the service account used to access the S3 bucket. (Together with access-key().)
116113

117-
### storage-class()
114+
## storage-class()
118115

119116
|Type:| string|
120117
|Default:| STANDARD|
@@ -125,20 +122,20 @@ Description: The max-pending-uploads() and upload-threads() options configure th
125122

126123
If an invalid value is configured, the default is used.
127124

128-
### upload-threads()
125+
## upload-threads()
129126

130127
|Type:| integer|
131128
|Default:| 8|
132129

133130
*Description:* The number of {{ site.product.short_name }} worker threads that are used to upload data to S3 from this destination.
134131

135-
### template()
132+
## template()
136133

137134
*Description:* The message as written to the Amazon S3 object. You can use templates and template functions to format the message.
138135

139-
### url()
136+
## url()
140137

141138
|Type:| string|
142139
|Default:| N/A|
143140

144-
*Description:* The URL of the S3 bucket, for example, `https://my-bucket.s3.us-west-2.amazonaws.com`.
141+
*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.

0 commit comments

Comments
 (0)