Fluent Bit Plugin for CloudWatch Logs
A Fluent Bit output plugin for CloudWatch Logs
make to build
./bin/cloudwatch.so. Then use with Fluent Bit:
./fluent-bit -e ./cloudwatch.so -i cpu \ -o cloudwatch \ -p "region=us-west-2" \ -p "log_group_name=fluent-bit-cloudwatch" \ -p "log_stream_name=testing" \ -p "auto_create_group=true"
region: The AWS region.
log_group_name: The name of the CloudWatch Log Group that you want log records sent to.
log_stream_name: The name of the CloudWatch Log Stream that you want log records sent to.
log_stream_prefix: Prefix for the Log Stream name. The tag is appended to the prefix to construct the full log stream name. Not compatible with the
log_key: By default, the whole log record will be sent to CloudWatch. If you specify a key name with this option, then only the value of that key will be sent to CloudWatch. For example, if you are using the Fluentd Docker log driver, you can specify
log_key logand only the log message will be sent to CloudWatch.
role_arn: ARN of an IAM role to assume (for cross account access).
auto_create_group: Automatically create the log group. Valid values are "true" or "false" (case insensitive). Defaults to false.
endpoint: Specify a custom endpoint for the CloudWatch Logs API.
Note: The plugin will always create the log stream, if it does not exist.
This plugin requires the following permissions:
- CreateLogGroup (if
auto_create_groupis set to true)
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 CloudWatch. 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 CloudWatch).
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 cloudwatch Match * region us-east-1 log_group_name fluent-bit-cloudwatch log_stream_prefix from-fluent-bit- auto_create_group true
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.