You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/_admin-guide/070_Destinations/225_Amazon-s3/000_amazon_s3_options.md
+25-28Lines changed: 25 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -7,22 +7,22 @@ description: >-
7
7
8
8
The following options are specific to the s3 destination.
9
9
10
-
###access-key()
10
+
## access-key()
11
11
12
12
|Type:| string|
13
13
|Default:| N/A|
14
14
15
15
*Description:* The `ACCESS_KEY` of the service account of the S3 bucket. (Used together with secret-key().)
16
16
17
-
###bucket()
17
+
## bucket()
18
18
19
19
|Type:| string|
20
20
|Default:| N/A|
21
21
22
22
*Description:* The name of the S3 bucket.
23
23
For example: `my-bucket`.
24
24
25
-
###canned-acl()
25
+
## canned-acl()
26
26
27
27
|Type:| string|
28
28
|Default:| N/A|
@@ -34,46 +34,44 @@ For example: `my-bucket`.
34
34
35
35
If an invalid value is configured, the default is used.
36
36
37
-
###chunk-size()
37
+
## chunk-size()
38
38
39
39
|Type:| string|
40
-
|Default:|N/A|
40
+
|Default:|5 MiB|
41
41
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.
43
43
44
-
###compression()
44
+
## compression()
45
45
46
46
|Type:| boolean|
47
47
|Default:| no|
48
48
49
49
*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`).
50
50
51
-
###compresslevel()
51
+
## compresslevel()
52
52
53
53
|Type:| integer|
54
-
|Default:|0-9|
54
+
|Default:| 9|
55
55
56
56
Description: Only has effect if compression() is set to `yes`. The level of the compression can be set using the compresslevel() option (`0-9`).
57
57
58
+
## flush-grace-period()
58
59
59
-
### flush-grace-period()
60
-
61
-
|Type:| integer[minutes]|
60
+
|Type:| integer [minutes]|
62
61
|Default:| 60|
63
62
64
63
*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().
65
64
66
-
#{% include doc/admin-guide/options/log-fifo-size.md %}
65
+
{% include doc/admin-guide/options/log-fifo-size.md %}
67
66
68
-
###max-object-size()
67
+
## max-object-size()
69
68
70
-
|Type:|number [GiB]|
69
+
|Type:|string|
71
70
|Default:| 5120GiB|
72
71
73
72
*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.
74
73
75
-
### max-pending-uploads()
76
-
74
+
## max-pending-uploads()
77
75
78
76
|Type:| integer|
79
77
|Default:| 32|
@@ -83,38 +81,37 @@ Description: The max-pending-uploads() and upload-threads() options configure th
83
81
* upload-threads() limits the maximum number of parallel uploads.
84
82
* max-pending-uploads() limits the number of chunks that are waiting in the work queue of the upload threads to get uploaded
85
83
86
-
###object-key()
84
+
## object-key()
87
85
88
86
|Type:| template|
89
87
|Default:| N/A|
90
88
91
89
*Description:* The unique object key (or key name), which identifies the object in an Amazon S3 bucket.
92
90
93
-
###object-key-timestamp()
91
+
## object-key-timestamp()
94
92
95
93
|Type:| template|
96
94
|Default:| N/A|
97
95
98
96
*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.
99
97
100
-
#{% include doc/admin-guide/options/persist-name.md %}
98
+
{% include doc/admin-guide/options/persist-name.md %}
101
99
102
-
###region()
100
+
## region()
103
101
104
102
|Type:| string|
105
103
|Default:| N/A|
106
104
107
-
108
105
*Description:* The regional endpoint where the bucket is stored. For example, us-east-1.
109
106
110
-
###secret-key()
107
+
## secret-key()
111
108
112
109
|Type:| string|
113
110
|Default:| N/A|
114
111
115
112
*Description:* The `SECRET_KEY` of the service account used to access the S3 bucket. (Together with access-key().)
116
113
117
-
###storage-class()
114
+
## storage-class()
118
115
119
116
|Type:| string|
120
117
|Default:| STANDARD|
@@ -125,20 +122,20 @@ Description: The max-pending-uploads() and upload-threads() options configure th
125
122
126
123
If an invalid value is configured, the default is used.
127
124
128
-
###upload-threads()
125
+
## upload-threads()
129
126
130
127
|Type:| integer|
131
128
|Default:| 8|
132
129
133
130
*Description:* The number of {{ site.product.short_name }} worker threads that are used to upload data to S3 from this destination.
134
131
135
-
###template()
132
+
## template()
136
133
137
134
*Description:* The message as written to the Amazon S3 object. You can use templates and template functions to format the message.
138
135
139
-
###url()
136
+
## url()
140
137
141
138
|Type:| string|
142
139
|Default:| N/A|
143
140
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