Amazon Kinesis
Kinesis Stream output plugin for Fluentd
Overview
For details, see https://github.com/awslabs/aws-fluent-plugin-kinesis#configuration-kinesis_streams.
Example output configurations
spec:
kinesisStream:
stream_name: example-stream-name
region: us-east-1
format:
type: json
Configuration
KinesisStream
Send your logs to a Kinesis Stream
aws_iam_retries (int, optional)
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.
aws_key_id (*secret.Secret, optional)
AWS access key id. This parameter is required when your agent is not running on EC2 instance with an IAM Role.
aws_sec_key (*secret.Secret, optional)
AWS secret key. This parameter is required when your agent is not running on EC2 instance with an IAM Role.
aws_ses_token (*secret.Secret, optional)
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.
assume_role_credentials (*KinesisStreamAssumeRoleCredentials, optional)
Typically, you can use AssumeRole for cross-account access or federation.
batch_request_max_count (int, optional)
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.
batch_request_max_size (int, optional)
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.
buffer (*Buffer, optional)
format (*Format, optional)
partition_key (string, optional)
A key to extract partition key from JSON object. Default nil, which means partition key will be generated randomly.
process_credentials (*KinesisStreamProcessCredentials, optional)
This loads AWS access credentials from an external process.
region (string, optional)
AWS region of your stream. It should be in form like us-east-1, us-west-2. Default nil, which means try to find from environment variable AWS_REGION.
reset_backoff_if_success (bool, optional)
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.
retries_on_batch_request (int, optional)
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
slow_flush_log_threshold (string, optional)
The threshold for chunk flush performance check. Parameter type is float, not time, default: 20.0 (seconds) If chunk flush takes longer time than this threshold, fluentd logs warning message and increases metric fluentd_output_status_slow_flush_count.
stream_name (string, required)
Name of the stream to put data.
Assume Role Credentials
assume_role_credentials
duration_seconds (string, optional)
The duration, in seconds, of the role session (900-3600)
external_id (string, optional)
A unique identifier that is used by third parties when assuming roles in their customers’ accounts.
policy (string, optional)
An IAM policy in JSON format
role_arn (string, required)
The Amazon Resource Name (ARN) of the role to assume
role_session_name (string, required)
An identifier for the assumed role session
Process Credentials
process_credentials
process (string, required)
Command more info: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ProcessCredentials.html