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
The Amazon Kinesis Data Firehose output plugin allows to ingest your records into the [Firehose](https://aws.amazon.com/kinesis/data-firehose/) service.
7
+
The _Amazon Kinesis Data Firehose_ output plugin lets you ingest your records into the [Firehose](https://aws.amazon.com/kinesis/data-firehose/) service.
8
8
9
-
This is the documentation for the core Fluent Bit Firehose plugin written in C. It can replace the [aws/amazon-kinesis-firehose-for-fluent-bit](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) Golang Fluent Bit plugin released last year. The Golang plugin was named `firehose`; this new high performance and highly efficient firehose plugin is called `kinesis_firehose` to prevent conflicts/confusion.
9
+
This is the documentation for the core Fluent Bit Firehose plugin written in C. It can replace the [aws/amazon-kinesis-firehose-for-fluent-bit](https://github.com/aws/amazon-kinesis-firehose-for-fluent-bit) Golang Fluent Bit plugin. The Golang plugin was named `firehose`. This new Firehose plugin is called `kinesis_firehose` to prevent conflicts/confusion.
10
10
11
-
See [here](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e706b0edb2f9acd7cdfdbc3/administration/aws-credentials.md) for details on how AWS credentials are fetched.
11
+
See [AWS credentials](https://docs.fluentbit.io/manual/administration/aws-credentials) for details on how AWS credentials are fetched.
12
12
13
-
## Configuration Parameters
13
+
## Configuration parameters
14
14
15
-
| Key | Description |
16
-
| :--- | :--- |
17
-
| region | The AWS region. |
18
-
| delivery\_stream | The name of the Kinesis Firehose Delivery stream that you want log records sent to. |
19
-
| time\_key | Add the timestamp to the record under this key. By default the timestamp from Fluent Bit will not be added to records sent to Kinesis. |
20
-
| time\_key\_format | strftime compliant format string for the timestamp; for example, the default is '%Y-%m-%dT%H:%M:%S'. Supports millisecond precision with '%3N' and supports nanosecond precision with '%9N' and '%L'; for example, adding '%3N' to support millisecond '%Y-%m-%dT%H:%M:%S.%3N'. This option is used with time\_key. |
21
-
| log\_key | By default, the whole log record will be sent to Firehose. If you specify a key name with this option, then only the value of that key will be sent to Firehose. For example, if you are using the Fluentd Docker log driver, you can specify `log_key log` and only the log message will be sent to Firehose. |
22
-
| compression | Compression type for Firehose records. Each log record is individually compressed and sent to Firehose. 'gzip' and 'arrow' are the supported values. 'arrow' is only an available if Apache Arrow was enabled at compile time. Defaults to no compression. |
23
-
| role\_arn | ARN of an IAM role to assume \(for cross account access\). |
24
-
| endpoint | Specify a custom endpoint for the Firehose API. |
25
-
| sts\_endpoint | Custom endpoint for the STS API. |
26
-
| auto\_retry\_requests | Immediately retry failed requests to AWS services once. This option does not affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which may help improve throughput when there are transient/random networking issues. This option defaults to `true`. |
27
-
| external\_id | Specify an external ID for the STS API, can be used with the role_arn parameter if your role requires an external ID. |
28
-
| profile | AWS profile name to use. Defaults to `default`. |
29
-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. Default: `1`. |
15
+
This plugin uses the following configuration parameters:
30
16
31
-
## Getting Started
17
+
| Key | Description | Default |
18
+
| :--- | :--- | --------- |
19
+
|`region`| The AWS region . |_none_|
20
+
|`delivery_stream`| The name of the Kinesis Firehose Delivery stream that you want log records sent to. |_none_|
21
+
|`time_key`| Add the timestamp to the record under this key. By default, the timestamp from Fluent Bit won't be added to records sent to Kinesis. |_none_|
22
+
|`time_key_format`| strftime compliant format string for the timestamp; for example, the default is `%Y-%m-%dT%H:%M:%S`. Supports millisecond precision with `%3N` and nanosecond precision with `%9N` and `%L`. For example, adding `%3N` to support millisecond `%Y-%m-%dT%H:%M:%S.%3N`. This option is used with `time_key`. |_none_|
23
+
|`log_key`| By default, the whole log record will be sent to Firehose. If you specify a key name with this option, then only the value of that key will be sent to Firehose. For example, if you are using the Fluentd Docker log driver, you can specify `log_key log` and only the log message will be sent to Firehose. |_none_|
24
+
|`compression`| Compression type for Firehose records. Each log record is individually compressed and sent to Firehose. Supported values: `gzip`. `arrow`. `arrow` is only an available if Apache Arrow was enabled at compile time. Defaults to no compression. |_none_|
25
+
|`role_arn`| ARN of an IAM role to assume (for cross account access`). |_none_|
26
+
|`endpoint`| Specify a custom endpoint for the Firehose API. |_none_|
27
+
|`sts_endpoint`| Custom endpoint for the STS API. |_none_|
28
+
|`auto_retry_requests`| Immediately retry failed requests to AWS services once. This option doesn't affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which can help improve throughput when there are transient/random networking issues. |`true`|
29
+
|`external_id`| Specify an external ID for the STS API. Can be used with the `role_arn` parameter if your role requires an external ID. |_none_|
30
+
|`profile`| AWS profile name to use. |`default`|
31
+
|`workers`| The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. |`1`|
32
32
33
-
In order to send records into Amazon Kinesis Data Firehose, you can run the plugin from the command line or through the configuration file:
33
+
## Get started
34
34
35
-
### Command Line
35
+
To send records into Amazon Kinesis Data Firehose, you can run the plugin from the command line or through the configuration file.
36
36
37
-
The **firehose** plugin, can read the parameters from the command line through the **-p** argument \(property\), e.g:
37
+
### Command line
38
+
39
+
The Firehose plugin can read the parameters from the command line through the `-p` argument (property).
In your main configuration file append the following:
46
48
@@ -49,7 +51,7 @@ In your main configuration file append the following:
49
51
50
52
```yaml
51
53
pipeline:
52
-
54
+
53
55
outputs:
54
56
- name: kinesis_firehose
55
57
match: '*'
@@ -90,7 +92,7 @@ The following AWS IAM permissions are required to use this plugin:
90
92
91
93
### Worker support
92
94
93
-
Fluent Bit 1.7 adds a new feature called `workers` which enables outputs to have dedicated threads. This `kinesis_firehose` plugin fully supports workers.
95
+
Fluent Bit 1.7 added a new feature called `workers` which enables outputs to have dedicated threads. This `kinesis_firehose` plugin fully supports workers.
94
96
95
97
Example:
96
98
@@ -99,7 +101,7 @@ Example:
99
101
100
102
```yaml
101
103
pipeline:
102
-
104
+
103
105
outputs:
104
106
- name: kinesis_firehose
105
107
match: '*'
@@ -125,7 +127,7 @@ pipeline:
125
127
126
128
{% hint style="info" %}
127
129
128
-
If you enable a single worker, you are enabling a dedicated thread for your Firehose output. We recommend starting with without workers, evaluating the performance, and then adding workers one at a time until you reach your desired/needed throughput. For most users, no workers or a single worker will be sufficient.
130
+
If you enable a single worker, you are enabling a dedicated thread for your Firehose output. Fluent Bit recommends starting with without workers, evaluating the performance, and then adding workers one at a time until you reach your desired/needed throughput. For most users, no workers or a single worker will be sufficient.
129
131
130
132
{% endhint %}
131
133
@@ -141,7 +143,7 @@ Amazon distributes a container image with Fluent Bit and these plugins.
0 commit comments