Skip to content

out_firehose: out_kinesis: add simple_aggregation config parameter and cleanup #2317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eschabell wants to merge 1 commit into
base: master
Choose a base branch
from
Open

out_firehose: out_kinesis: add simple_aggregation config parameter and cleanup #2317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 20 additions & 19 deletions pipeline/outputs/firehose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,20 @@ This plugin uses the following configuration parameters:

| Key | Description | Default |
| :--- | :--- | --------- |
| `region` | The AWS region . | _none_ |
| `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` |
| `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_ |
| `delivery_stream` | The name of the Kinesis Firehose Delivery stream that you want log records sent to. | _none_ |
| `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_ |
| `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_ |
| `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_ |
| `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_ |
| `role_arn` | ARN of an IAM role to assume (for cross account access`). | _none_ |
| `endpoint` | Specify a custom endpoint for the Firehose API. | _none_ |
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
| `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` |
| `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_ |
| `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_ |
| `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_ |
| `profile` | AWS profile name to use. | `default` |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |
| `region` | The AWS region. | _none_ |
| `role_arn` | ARN of an IAM role to assume (for cross-account access). | _none_ |
| `simple_aggregation` | Enable record aggregation to combine multiple records into single API calls. This reduces the number of requests and can improve throughput. | `false` |
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
| `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_ |
| `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_ |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |

## Get started

Expand Down Expand Up @@ -64,10 +65,10 @@ pipeline:

```text
[OUTPUT]
Name kinesis_firehose
Match *
region us-east-1
delivery_stream my-stream
Name kinesis_firehose
Match *
Region us-east-1
Delivery_Stream my-stream
```

{% endtab %}
Expand Down Expand Up @@ -115,11 +116,11 @@ pipeline:

```text
[OUTPUT]
Name kinesis_firehose
Match *
region us-east-1
delivery_stream my-stream
workers 2
Name kinesis_firehose
Match *
Region us-east-1
Delivery_Stream my-stream
Workers 2
```

{% endtab %}
Expand Down
27 changes: 14 additions & 13 deletions pipeline/outputs/kinesis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,19 @@ For information about how AWS credentials are fetched, see [AWS credentials](../

| Key | Description | Default |
| --- | ----------- | ------- |
| `region` | The AWS region. | _none_ |
| `stream` | The name of the Kinesis Streams Delivery stream that you want log records sent to. | _none_ |
| `time_key` | Add the timestamp to the record under this key. | `false` |
| `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` |
| `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_ |
| `role_arn` | ARN of an IAM role to assume (for cross account access). | _none_ |
| `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` |
| `endpoint` | Specify a custom endpoint for the Kinesis API. | _none_ |
| `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_ |
| `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_ |
| `port` | TCP port of the Kinesis Streams service. | `443` |
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
| `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` |
| `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_ |
| `profile` | AWS profile name to use. | `default` |
| `region` | The AWS region. | _none_ |
| `role_arn` | ARN of an IAM role to assume (for cross-account access). | _none_ |
| `simple_aggregation` | Enable record aggregation to combine multiple records into single API calls. This reduces the number of requests and can improve throughput. | `false` |
| `stream` | The name of the Kinesis stream that you want log records sent to. | _none_ |
| `sts_endpoint` | Custom endpoint for the STS API. | _none_ |
| `time_key` | Add the timestamp to the record under this key. | _none_ |
| `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` |
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `1` |

## Get started
Expand Down Expand Up @@ -64,10 +65,10 @@ pipeline:

```text
[OUTPUT]
Name kinesis_streams
Match *
region us-east-1
stream my-stream
Name kinesis_streams
Match *
Region us-east-1
Stream my-stream
```

{% endtab %}
Expand Down