Merge pull request #1 from aws/mainline

update

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.4.0
+* Feature - Add support for dynamic log group names (#46)
+* Feature - Add support for dynamic log stream names (#16)
+* Feature - Support tagging of newly created log groups (#51)
+* Feature - Support setting log group retention policies (#50)
+
 ## 1.3.1
 * Bug - Check for empty logEvents before calling PutLogEvents (#66)
 

README.md

@@ -23,13 +23,16 @@ Run `make` to build `./bin/cloudwatch.so`. Then use with Fluent Bit:
 ### Plugin Options
 
 * `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_stream_name` option.  
+* `log_group_name`: The name of the CloudWatch Log Group that you want log records sent to. This value allows a template in the form of `$(variable)`. See `log_stream_name` description for more. The app will attempt to create missing log groups, and will throw an error if it does not have access.
+* `log_stream_name`: The name of the CloudWatch Log Stream that you want log records sent to. This value allows a template in the form of `$(variable)` where
+`variable` is a map key name in the log message. To access sub-values in the map
+use the form `$(variable['subkey'])`. Special values: `$(tag)` references the full tag name, `$(tag[0])` and `$(tag[1])` are the first and second values of log tag split on periods. You may access any member by index, 0 through 9.
+* `log_stream_prefix`: (deprecated) Prefix for the Log Stream name. Setting this to `prefix-` is the same as setting `log_stream_name = prefix-$(tag)`.
 * `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 log` and only the log message will be sent to CloudWatch.
 * `log_format`: An optional parameter that can be used to tell CloudWatch the format of the data. A value of `json/emf` enables CloudWatch to extract custom metrics embedded in a JSON payload. See the [Embedded Metric Format](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Specification.html).
 * `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.
+* `auto_create_group`: Automatically create log groups (and add tags). Valid values are "true" or "false" (case insensitive). Defaults to false. If you use dynamic variables in your log group name, you may need this to be `true`.
+* `new_log_group_tags`: Comma/equal delimited string of tags to include with _auto created_ log groups. Example: `"tag=val,cooltag2=my other value"`
 * `log_retention_days`: If set to a number greater than zero, and newly create log group's retention policy is set to this many days.
 * `endpoint`: Specify a custom endpoint for the CloudWatch Logs API.
 * `sts_endpoint`: Specify a custom endpoint for the STS API; used to assume your custom role provided with `role_arn`.
@@ -48,10 +51,11 @@ Run `make` to build `./bin/cloudwatch.so`. Then use with Fluent Bit:
 ### Permissions
 
 This plugin requires the following permissions:
-* CreateLogGroup (if `auto_create_group` is set to true)
+* CreateLogGroup (useful when using dynamic groups)
 * CreateLogStream
 * DescribeLogStreams
 * PutLogEvents
+* PutRetentionPolicy (if `log_retention_days` is set > 0)
 
 ### Credentials
 

VERSION

@@ -1 +1 @@
-1.3.2
+1.4.0