Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/awslabs/aws-fluent-plugin-kinesis
Amazon Kinesis output plugin for Fluentd
https://github.com/awslabs/aws-fluent-plugin-kinesis
amazon-kinesis fluent-plugin fluentd kinesis-firehose kinesis-producer kinesis-streams ruby
Last synced: about 2 months ago
JSON representation
Amazon Kinesis output plugin for Fluentd
- Host: GitHub
- URL: https://github.com/awslabs/aws-fluent-plugin-kinesis
- Owner: awslabs
- License: apache-2.0
- Created: 2014-04-10T16:26:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T13:45:48.000Z (5 months ago)
- Last Synced: 2024-07-18T20:34:23.675Z (2 months ago)
- Topics: amazon-kinesis, fluent-plugin, fluentd, kinesis-firehose, kinesis-producer, kinesis-streams, ruby
- Language: Ruby
- Homepage:
- Size: 466 KB
- Stars: 294
- Watchers: 99
- Forks: 96
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-repositories - awslabs/aws-fluent-plugin-kinesis - Amazon Kinesis output plugin for Fluentd (Ruby)
README
# Fluent plugin for Amazon Kinesis
[](https://github.com/awslabs/aws-fluent-plugin-kinesis/actions/workflows/test.yml)
[](https://rubygems.org/gems/fluent-plugin-kinesis)
[](https://rubygems.org/gems/fluent-plugin-kinesis)
A fluentd output plugin to send events to [Amazon Kinesis Data Streams][streams] and [Amazon Data Firehose][firehose]. The plugin also supports [KPL Aggregated Record Format][kpl].
This gem includes following three output plugins:
- `kinesis_streams`
- `kinesis_firehose`
- `kinesis_streams_aggregated`
The plugin is also described in [official Fluentd document][fluentd-doc-kinesis].
**Note**: This README is for the latest v3. Plugin v3 is almost compatible with v2. If you use v1, see [v1 README][v1-readme].
## Installation
Simply use RubyGems:
$ gem install fluent-plugin-kinesis --no-document
If you would like to build by yourself and install, you can build and install as follows:
$ git clone https://github.com/awslabs/aws-fluent-plugin-kinesis.git
$ cd aws-fluent-plugin-kinesis
$ bundle install
$ bundle exec rake build
$ bundle exec rake install
# If using fluent-package (td-agent), use td-agent-gem
$ td-agent-gem install pkg/fluent-plugin-kinesis
## Requirements
| fluent-plugin-kinesis | fluentd | ruby |
|:---------------------:|:-----------:|:--------:|
| >= 3.5.0 | >= 0.14.22 | >= 2.4.2 |
| >= 3.2.0 && < 3.5.0 | >= 0.14.22 | >= 2.3 |
| >= 3.0.0 && < 3.2.0 | >= 0.14.10 | >= 2.1 |
| >= 2.0.0 && < 3.0.0 | >= 0.12.35 | >= 2.1 |
| < 2.0.0 | >= 0.10.58 | >= 2.0 |
## Getting Started
When you run this plugin on Amazon EC2 instances or container services, use [instance profiles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html) to assume role. If you want to use specific credentials, see [Credentials](#configuration-credentials).
### kinesis_streams
In your Fluentd configuration, use `@type kinesis_streams`. The configuration would look like this:
@type kinesis_streams
region us-east-1
stream_name YOUR_STREAM
partition_key key # Otherwise, use random partition key
For more details, see [Configuration: kinesis_streams](#configuration-kinesis_streams).
### kinesis_firehose
In your Fluentd configuration, use `@type kinesis_firehose`. The configuration would look like this:
@type kinesis_firehose
region us-east-1
delivery_stream_name YOUR_STREAM
For more details, see [Configuration: kinesis_firehose](#configuration-kinesis_firehose).
### kinesis_streams_aggregated
In your Fluentd configuration, use `@type kinesis_streams_aggregated`. The configuration would look like this:
@type kinesis_streams_aggregated
region us-east-1
stream_name YOUR_STREAM
# Unlike kinesis_streams, there is no way to use dynamic partition key.
# fixed_partition_key or random.
For more details, see [Configuration: kinesis_streams_aggregated](#configuration-kinesis_streams_aggregated).
## Configuration
- [Configuration: Plugin](#configuration-plugin)
- [Configuration: kinesis_streams](#configuration-kinesis_streams)
- [Configuration: kinesis_firehose](#configuration-kinesis_firehose)
- [Configuration: kinesis_streams_aggregated](#configuration-kinesis_streams_aggregated)
- [Configuration: Credentials](#configuration-credentials)
- [AWS key and secret authentication](#aws-key-and-secret-authentication)
- [\ section](#assume_role_credentials-section)
- [\ section](#web_identity_credentials-section)
- [\ section](#instance_profile_credentials-section)
- [\ section](#shared_credentials-section)
- [\ section](#process_credentials-section)
- [Configuration: Performance](#configuration-performance)
- [\ section](#buffer-section)
- [Configuration: Batch Request](#configuration-batch-request)
- [Configuration: Format](#configuration-format)
- [\ section](#format-section)
- [\ section](#inject-section)
- [Configuration: AWS SDK](#configuration-aws-sdk)
## Configuration: Plugin
### Configuration: kinesis_streams
The following parameters are `kinesis_streams` specific configurations.
#### stream_name
Name of the stream to put data.
As of Fluentd v1, you can use placeholders for this `stream_name` parameter. Note that chunk keys are required in your buffer section attributes for placeholders to work.
The following configuration shows `kinesis_streams` output plugin that applies extract_placeholders on `stream_name`:
# chunk_key: tag
# ${tag} will be replaced with actual tag string
@type kinesis_streams
stream_name ${tag}-stream
# ...
The value of `timekey` in buffer chunk keys can be extracted using `strptime` placeholders like this:
# chunk_key: tag and time
@type kinesis_streams
stream_name ${tag}-stream-%Y%m%d
# ...
You can also use custom placeholder like this:
# chunk_key: $.kubernetes.annotations.kinesis_stream
@type kinesis_streams
stream_name "${$.kubernetes.annotations.kinesis_stream}"
# ...
For more details, see [Placeholders in Config: Buffer Section][fluentd-buffer-section-placeholders].
#### partition_key
A key to extract partition key from JSON object. Default `nil`, which means partition key will be generated randomly.
### Configuration: kinesis_firehose
The following parameters are `kinesis_firehose` specific configurations.
#### delivery_stream_name
Name of the delivery stream to put data.
As of Fluentd v1, placerholders are supported. For more details, see [stream_name for kinesis_streams plugin](#stream_name) and [Placeholders in Config: Buffer Section][fluentd-buffer-section-placeholders].
#### append_new_line
Boolean. Default `true`. If it is enabled, the plugin adds new line character (`\n`) to each serialized record.
Before appending `\n`, plugin calls chomp and removes separator from the end of each record as [chomp_record](#chomp_record) is `true`. Therefore, you don't need to enable [chomp_record](#chomp_record) option when you use [kinesis_firehose](#kinesis_firehose) output with default configuration ([append_new_line](#append_new_line) is `true`). If you want to set [append_new_line](#append_new_line) `false`, you can choose [chomp_record](#chomp_record) `false` (default) or `true` (compatible format with plugin v2).
### Configuration: kinesis_streams_aggregated
The following parameters are `kinesis_streams_aggregated` specific configurations.
#### stream_name (kinesis_streams_aggregated)
Name of the stream to put data.
As of Fluentd v1, placerholders are supported. For more details, see [stream_name for kinesis_streams plugin](#stream_name) and [Placeholders in Config: Buffer Section][fluentd-buffer-section-placeholders].
#### fixed_partition_key
A value of fixed partition key. Default `nil`, which means partition key will be generated randomly. Note that all records will go to single shard if you specify this option.
## Configuration: Credentials
To put records into Amazon Kinesis Data Streams or Amazon Data Firehose, you need to provide AWS security credentials. Without specifying credentials in config file, this plugin automatically fetches credentials just following AWS SDK for Ruby does (environment variable, shared profile, or instance profile).
This plugin uses almost same configurations as [fluent-plugin-s3][fluent-plugin-s3-credentials], but also supports several additional configurations like `aws_ses_token` for temporary credentials.
### AWS key and secret authentication
These parameters are required when your agent is not running on EC2 instance with an IAM Role. When using an IAM role, make sure to configure `instance_profile_credentials`. Usage can be found below.
#### aws_key_id (required)
AWS access key id.
#### aws_sec_key (required)
AWS secret key.
#### aws_ses_token
AWS session token. This parameter is optional, but can be provided if using MFA or temporary credentials when your agent is not running on EC2 instance with an IAM Role.
#### aws_iam_retries
The number of attempts to make (with exponential backoff) when loading instance profile credentials from the EC2 metadata service using an IAM role. Defaults to 5 retries.
### \ section
Typically, you can use AssumeRole for cross-account access or federation.
@type kinesis_streams
role_arn ROLE_ARN
role_session_name ROLE_SESSION_NAME
See also:
* [Using IAM Roles - AWS Identity and Access
Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html)
* [Aws::STS::Client](https://docs.aws.amazon.com/sdkforruby/api/Aws/STS/Client.html)
* [Aws::AssumeRoleCredentials](https://docs.aws.amazon.com/sdkforruby/api/Aws/AssumeRoleCredentials.html)
#### role_arn (required)
The Amazon Resource Name (ARN) of the role to assume.
#### role_session_name (required)
An identifier for the assumed role session.
#### policy
An IAM policy in JSON format.
#### duration_seconds
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.
#### external_id
A unique identifier that is used by third parties when assuming roles in their customers' accounts.
#### sts_http_proxy
Proxy url for proxying requests to amazon sts service api. This needs to be set up independently from global http_proxy parameter for the use case in which requests to kinesis api are going via kinesis vpc endpoint but requests to sts api have to go via http proxy.
It should be added to *assume_role_credentials* section in the next format:
sts_http_proxy http://[username:password]@hostname:port
#### sts_endpoint_url
STS API endpoint url. This can be used to override the default global STS API endpoint of *sts.amazonaws.com*. Using regional endpoints may be preferred to reduce latency, and are required if utilizing a PrivateLink VPC Endpoint for STS API calls.
### \ section
Similar to the assume_role_credentials, but for usage in EKS.
@type kinesis_streams
role_arn ROLE_ARN
role_session_name ROLE_SESSION_NAME
web_identity_token_file AWS_WEB_IDENTITY_TOKEN_FILE
See also:
* [Using IAM Roles - AWS Identity and Access Management](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html)
* [IAM Roles For Service Accounts](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html)
* [Aws::STS::Client](http://docs.aws.amazon.com/sdkforruby/api/Aws/STS/Client.html)
* [Aws::AssumeRoleWebIdentityCredentials](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AssumeRoleWebIdentityCredentials.html)
#### role_arn (required)
The Amazon Resource Name (ARN) of the role to assume.
#### role_session_name (required)
An identifier for the assumed role session.
#### web_identity_token_file (required)
The absolute path to the file on disk containing the OIDC token.
#### policy
An IAM policy in JSON format.
#### duration_seconds
The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 43200 seconds (12 hours). By default, the value is set to 3600 seconds (1 hour).
### \ section
Retrieve temporary security credentials via HTTP request. This is useful on EC2 instance.
@type kinesis_streams
ip_address IP_ADDRESS
port PORT
See also:
* [Aws::InstanceProfileCredentials](https://docs.aws.amazon.com/sdkforruby/api/Aws/InstanceProfileCredentials.html)
* [Temporary Security Credentials - AWS Identity and Access
Management](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html)
* [Instance Metadata and User Data - Amazon Elastic Compute
Cloud](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
#### retries
Number of times to retry when retrieving credentials. Default is 5.
#### ip_address
Default is 169.254.169.254.
#### port
Default is 80.
#### http_open_timeout
Default is 5.
#### http_read_timeout
Default is 5.
### \ section
This loads AWS access credentials from local ini file. This is useful for local developing.
@type kinesis_streams
path PATH
profile_name PROFILE_NAME
See also:
* [Aws::SharedCredentials](https://docs.aws.amazon.com/sdkforruby/api/Aws/SharedCredentials.html)
#### path
Path to the shared file. Defaults to "#{Dir.home}/.aws/credentials".
#### profile_name
Defaults to 'default' or `[ENV]('AWS_PROFILE')`.
### \ section
This loads AWS access credentials from an external process.
@type kinesis_streams
process CMD
See also:
* [Aws::ProcessCredentials](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ProcessCredentials.html)
* [Sourcing Credentials From External Processes](https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes)
#### process (required)
Command to be executed as an external process.
## Configuration: Performance
### \ section
Use Fluentd buffering and flushing parameters to optimize throughput. When you use Fluent v1+ (td-agent v3+), write these configurations in buffer section like this:
@type kinesis_streams
flush_interval 1
chunk_limit_size 1m
flush_thread_interval 0.1
flush_thread_burst_interval 0.01
flush_thread_count 15
For more details, see [Config: Buffer Section][fluentd-buffer-section]. Note that each parameter should be adjusted to your system.
### Configuration: Batch Request
#### retries_on_batch_request
Integer, default is 8. The plugin will put multiple records to Amazon Kinesis Data Streams in batches using PutRecords. A set of records in a batch may fail for reasons documented in the Kinesis Service API Reference for PutRecords. Failed records will be retried **retries_on_batch_request** times. If a record fails all retries an error log will be emitted.
#### reset_backoff_if_success
Boolean, default `true`. If enabled, when after retrying, the next retrying checks the number of succeeded records on the former batch request and reset exponential backoff if there is any success. Because batch request could be composed by requests across shards, simple exponential backoff for the batch request wouldn't work some cases.
#### batch_request_max_count
Integer, default 500. The number of max count of making batch request from record chunk. It can't exceed the default value because it's API limit.
Default:
- `kinesis_streams`: 500
- `kinesis_firehose`: 500
- `kinesis_streams_aggregated`: 100,000
#### batch_request_max_size
Integer. The number of max size of making batch request from record chunk. It can't exceed the default value because it's API limit.
Default:
- `kinesis_streams`: 5 MB
- `kinesis_firehose`: 4 MB
- `kinesis_streams_aggregated`: 1 MB
#### drop_failed_records_after_batch_request_retries
Boolean, default `true`.
If *drop_failed_records_after_batch_request_retries* is enabled (default), the plugin will drop failed records when batch request fails after retrying max times configured as *retries_on_batch_request*. This dropping can be monitored from [monitor_agent](https://docs.fluentd.org/input/monitor_agent) or [fluent-plugin-prometheus](https://docs.fluentd.org/monitoring-fluentd/monitoring-prometheus) as *retry_count* or *num_errors* metrics.
If *drop_failed_records_after_batch_request_retries* is disabled, the plugin will raise error and return chunk to Fluentd buffer when batch request fails after retrying max times. Fluentd will retry to send chunk records according to retry config in [Buffer Section](https://docs.fluentd.org/configuration/buffer-section). Note that this retryng may create duplicate records since [PutRecords API](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html) of Kinesis Data Streams and [PutRecordBatch API](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) of Kinesis Data Firehose may return a partially successful response.
#### monitor_num_of_batch_request_retries
Boolean, default `false`. If enabled, the plugin will increment *retry_count* monitoring metrics after internal retrying to send batch request. This configuration enables you to monitor [ProvisionedThroughputExceededException](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecords.html) from [monitor_agent](https://docs.fluentd.org/input/monitor_agent) or [fluent-plugin-prometheus](https://docs.fluentd.org/monitoring-fluentd/monitoring-prometheus). Note that *retry_count* metrics will be counted by the plugin in addition to original Fluentd buffering mechanism if *monitor_num_of_batch_request_retries* is enabled.
## Configuration: Format
### \ section
This plugin uses `Fluent::TextFormatter` to serialize record to string. See [formatter.rb] for more details. By default, it uses `json` formatter same as specific like below:
@type kinesis_streams
@type json
For other configurations of `json` formatter, see [json formatter plugin][fluentd-formatter-json].
### \ section
This plugin uses `Fluent::TimeFormatter` and other injection configurations. See [inject.rb] for more details.
For example, the config below will add `time` field whose value is event time with nanosecond and `tag` field whose value is its tag.
@type kinesis_streams
time_key time
tag_key tag
By default, `time_type string` and `time_format %Y-%m-%dT%H:%M:%S.%N%z` are already set to be applicable to Elasticsearch sub-second format. Although, you can use any configuration.
In addition, there are some format related options:
#### data_key
If your record contains a field whose string should be sent to Amazon Kinesis directly (without formatter), use this parameter to specify the field. In that case, other fields than **data_key** are thrown away and never sent to Amazon Kinesis. Default `nil`, which means whole record will be formatted and sent.
#### compression
Specifying compression way for data of each record. Current accepted options are `zlib` and `gzip`. Otherwise, no compression will be preformed.
#### log_truncate_max_size
Integer, default 1024. When emitting the log entry, the message will be truncated by this size to avoid infinite loop when the log is also sent to Kinesis. The value 0 means no truncation.
#### chomp_record
Boolean. Default `false`. If it is enabled, the plugin calls chomp and removes separator from the end of each record. This option is for compatible format with plugin v2. See [#142](https://github.com/awslabs/aws-fluent-plugin-kinesis/issues/142) for more details.
When you use [kinesis_firehose](#kinesis_firehose) output, [append_new_line](#append_new_line) option is `true` as default. If [append_new_line](#append_new_line) is enabled, the plugin calls chomp as [chomp_record](#chomp_record) is `true` before appending `\n` to each record. Therefore, you don't need to enable [chomp_record](#chomp_record) option when you use [kinesis_firehose](#kinesis_firehose) with default configuration. If you want to set [append_new_line](#append_new_line) `false`, you can choose [chomp_record](#chomp_record) `false` (default) or `true` (compatible format with plugin v2).
## Configuration: AWS SDK
#### region
AWS region of your stream. It should be in form like `us-east-1`, `us-west-2`. Refer to [Regions and Endpoints in AWS General Reference][region] for supported regions. Default `nil`, which means try to find from environment variable `AWS_REGION`.
#### max_record_size
The upper limit of size of each record. Default is 1 MB which is the limitation of Kinesis.
#### http_proxy
HTTP proxy for API calling. Default `nil`.
#### endpoint
API endpoint URL, for testing. Default `nil`.
#### ssl_verify_peer
Boolean. Disable if you want to verify ssl connection, for testing. Default `true`.
#### debug
Boolean. Enable if you need to debug Amazon Data Firehose API call. Default is `false`.
## Development
To launch `fluentd` process with this plugin for development, follow the steps below:
git clone https://github.com/awslabs/aws-fluent-plugin-kinesis.git
cd aws-fluent-plugin-kinesis
make # will install gems dependency
bundle exec fluentd -c /path/to/fluent.conf
To launch using specified version of Fluentd, use `BUNDLE_GEMFILE` environment variable:
BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.td-agent-3.3.0 bundle exec fluentd -c /path/to/fluent.conf
## Contributing
Bug reports and pull requests are welcome on [GitHub][github].
## Related Resources
* [Amazon Kinesis Data Streams Developer Guide](http://docs.aws.amazon.com/kinesis/latest/dev/introduction.html)
* [Amazon Data Firehose Developer Guide](http://docs.aws.amazon.com/firehose/latest/dev/what-is-this-service.html)
[github]: https://github.com/awslabs/aws-fluent-plugin-kinesis
[fluentd-doc-kinesis]: https://docs.fluentd.org/how-to-guides/kinesis-stream
[v1-readme]: https://github.com/awslabs/aws-fluent-plugin-kinesis/blob/v1/README.md
[streams]: https://aws.amazon.com/kinesis/streams/
[firehose]: https://aws.amazon.com/kinesis/firehose/
[kpl]: https://github.com/awslabs/amazon-kinesis-producer/blob/master/aggregation-format.md
[region]: https://docs.aws.amazon.com/general/latest/gr/rande.html#ak_region
[fluent-plugin-s3-credentials]: https://github.com/fluent/fluent-plugin-s3/blob/master/docs/credentials.md
[fluentd-buffer-section]: https://docs.fluentd.org/configuration/buffer-section
[fluentd-buffer-section-placeholders]: https://docs.fluentd.org/configuration/buffer-section#placeholders
[fluentd-formatter-json]: https://docs.fluentd.org/formatter/json
[formatter.rb]: https://github.com/fluent/fluentd/blob/master/lib/fluent/formatter.rb
[inject.rb]: https://github.com/fluent/fluentd/blob/master/lib/fluent/plugin_helper/inject.rb