Skip to content

Commit 4630cb7

Browse files
committed
out_firehose: out_kinesis: add simple_aggregation config parameter and cleanup
- Add missing simple_aggregation configuration parameter to both kinesis_streams and kinesis_firehose output plugin documentation - Sort all configuration parameters alphabetically per project rules - Update .conf examples to use Title_Case for parameters - Fix minor typos: extra space in region, stray backtick in role_arn, period instead of comma in compression values list - Fix time_key default value from 'false' to '_none_' in kinesis.md Fixes #2316. Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent f4d0117 commit 4630cb7

File tree

2 files changed

+34
-32
lines changed

2 files changed

+34
-32
lines changed

pipeline/outputs/firehose.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,20 @@ This plugin uses the following configuration parameters:
1616

1717
| Key | Description | Default |
1818
| :--- | :--- | --------- |
19-
| `region` | The AWS region . | _none_ |
19+
| `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` |
20+
| `compression` | Compression type for Firehose records. Each log record is individually compressed and sent to Firehose. Supported values: `gzip`, `arrow`. `arrow` is only available if Apache Arrow was enabled at compile time. | _none_ |
2021
| `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_ |
2622
| `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_ |
23+
| `external_id` | Specify an external ID for the STS API. You can use this option with the `role_arn` parameter if your role requires an external ID. | _none_ |
24+
| `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_ |
3025
| `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` |
26+
| `region` | The AWS region. | _none_ |
27+
| `role_arn` | ARN of an IAM role to assume (for cross-account access). | _none_ |
28+
| `simple_aggregation` | Enable record aggregation to combine multiple records into single API calls. This reduces the number of requests and can improve throughput. | `false` |
29+
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
30+
| `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_ |
31+
| `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_ |
32+
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |
3233

3334
## Get started
3435

@@ -64,10 +65,10 @@ pipeline:
6465
6566
```text
6667
[OUTPUT]
67-
Name kinesis_firehose
68-
Match *
69-
region us-east-1
70-
delivery_stream my-stream
68+
Name kinesis_firehose
69+
Match *
70+
Region us-east-1
71+
Delivery_Stream my-stream
7172
```
7273

7374
{% endtab %}
@@ -115,11 +116,11 @@ pipeline:
115116
116117
```text
117118
[OUTPUT]
118-
Name kinesis_firehose
119-
Match *
120-
region us-east-1
121-
delivery_stream my-stream
122-
workers 2
119+
Name kinesis_firehose
120+
Match *
121+
Region us-east-1
122+
Delivery_Stream my-stream
123+
Workers 2
123124
```
124125

125126
{% endtab %}

pipeline/outputs/kinesis.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,19 @@ For information about how AWS credentials are fetched, see [AWS credentials](../
1616

1717
| Key | Description | Default |
1818
| --- | ----------- | ------- |
19-
| `region` | The AWS region. | _none_ |
20-
| `stream` | The name of the Kinesis Streams Delivery stream that you want log records sent to. | _none_ |
21-
| `time_key` | Add the timestamp to the record under this key. | `false` |
22-
| `time_key_format` | The strftime compliant format string for the timestamp. 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`. | `%Y-%m-%dT%H:%M:%S` |
23-
| `log_key` | By default, the whole log record will be sent to Kinesis. If you specify a key name with this option, then only the value of that key will be sent to Kinesis. 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 Kinesis. | _none_ |
24-
| `role_arn` | ARN of an IAM role to assume (for cross account access). | _none_ |
19+
| `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 might help improve throughput when there are transient/random networking issues. | `true` |
2520
| `endpoint` | Specify a custom endpoint for the Kinesis API. | _none_ |
21+
| `external_id` | Specify an external ID for the STS API. You can use this option with the `role_arn` parameter if your role requires an external ID. | _none_ |
22+
| `log_key` | By default, the whole log record will be sent to Kinesis. If you specify a key name with this option, then only the value of that key will be sent to Kinesis. 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 Kinesis. | _none_ |
2623
| `port` | TCP port of the Kinesis Streams service. | `443` |
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 might 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_ |
3024
| `profile` | AWS profile name to use. | `default` |
25+
| `region` | The AWS region. | _none_ |
26+
| `role_arn` | ARN of an IAM role to assume (for cross-account access). | _none_ |
27+
| `simple_aggregation` | Enable record aggregation to combine multiple records into single API calls. This reduces the number of requests and can improve throughput. | `false` |
28+
| `stream` | The name of the Kinesis stream that you want log records sent to. | _none_ |
29+
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
30+
| `time_key` | Add the timestamp to the record under this key. | _none_ |
31+
| `time_key_format` | The strftime compliant format string for the timestamp. 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`. | `%Y-%m-%dT%H:%M:%S` |
3132
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |
3233

3334
## Get started
@@ -64,10 +65,10 @@ pipeline:
6465
6566
```text
6667
[OUTPUT]
67-
Name kinesis_streams
68-
Match *
69-
region us-east-1
70-
stream my-stream
68+
Name kinesis_streams
69+
Match *
70+
Region us-east-1
71+
Stream my-stream
7172
```
7273

7374
{% endtab %}

0 commit comments

Comments
 (0)