Fluent Bit Plugin for Amazon Kinesis Firehose
A Fluent Bit output plugin for Amazon Kinesis Data Firehose.
make to build
./bin/firehose.so. Then use with Fluent Bit:
./fluent-bit -e ./firehose.so -i cpu \ -o firehose \ -p "region=us-west-2" \ -p "delivery-stream=example-stream"
region: The region which your Firehose delivery stream(s) is/are in.
delivery_stream: The name of the delivery stream that you want log records sent to.
data_keys: By default, the whole log record will be sent to Kinesis. If you specify a key name(s) with this option, then only those keys and values will be sent to Kinesis. For example, if you are using the Fluentd Docker log driver, you can specify
data_keys logand only the log message will be sent to Kinesis. If you specify multiple keys, they should be comma delimited.
role_arn: ARN of an IAM role to assume (for cross account access).
endpoint: Specify a custom endpoint for the Kinesis Firehose API.
The plugin requires
This plugin uses the AWS SDK Go, and uses its default credential provider chain. If you are using the plugin on Amazon EC2 or Amazon ECS or Amazon EKS, the plugin will use your EC2 instance role or ECS Task role permissions or EKS IAM Roles for Service Accounts for pods. The plugin can also retrieve credentials from a shared credentials file, or from the standard
AWS_SESSION_TOKEN environment variables.
FLB_LOG_LEVEL: Set the log level for the plugin. Valid values are:
error(case insensitive). Default is
info. Note: Setting log level in the Fluent Bit Configuration file using the Service key will not affect the plugin log level (because the plugin is external).
SEND_FAILURE_TIMEOUT: Allows you to configure a timeout if the plugin can not send logs to Firehose. The timeout is specified as a Golang duration, for example:
5m30s. If the plugin has failed to make any progress for the given period of time, then it will exit and kill Fluent Bit. This is useful in scenarios where you want your logging solution to fail fast if it has been misconfigured (i.e. network or credentials have not been set up to allow it to send to Firehose).
Fluent Bit Versions
This plugin has been tested with Fluent Bit 1.2.0+. It may not work with older Fluent Bit versions. We recommend using the latest version of Fluent Bit as it will contain the newest features and bug fixes.
Example Fluent Bit Config File
[INPUT] Name forward Listen 0.0.0.0 Port 24224 [OUTPUT] Name firehose Match * region us-west-2 delivery_stream my-stream
AWS for Fluent Bit
We distribute a container image with Fluent Bit and these plugins.
You can use our SSM Public Parameters to find the Amazon ECR image URI in your region:
aws ssm get-parameters-by-path --path /aws/service/aws-for-fluent-bit/
For more see our docs.
This library is licensed under the Apache 2.0 License.