Address comments on PR

exporter/awscloudwatchlogsexporter/README.md

@@ -24,7 +24,7 @@ The following settings can be optionally configured:
 - `region`: The AWS region where the log stream is in.
 - `endpoint`: The CloudWatch Logs service endpoint which the requests are forwarded to. [See the CloudWatch Logs endpoints](https://docs.aws.amazon.com/general/latest/gr/cwl_region.html) for a list.
 - `log_retention`: LogRetention is the option to set the log retention policy for only newly created CloudWatch Log Groups. Defaults to Never Expire if not specified or set to 0. Possible values for retention in days are 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, or 3653. 
-- `tags`: Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }. Keys must be between 1-128 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`. Values must be between 1-256 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`.
+- `tags`: Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }. Keys must be between 1-128 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`(alphanumerics, whitespace, and _.:/=+-!). Values must be between 1-256 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`(alphanumerics, whitespace, and _.:/=+-!). [Link to tagging restrictions](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html#:~:text=Required%3A%20Yes-,tags,-The%20key%2Dvalue)
 - `role_arn`: The AWS IAM role to upload segments to a same/different account
 - `raw_log`: Boolean default false. If you want to export only the log message to cw logs. This is required for emf logs. 
 

exporter/awscloudwatchlogsexporter/config.go

@@ -83,7 +83,7 @@ func (config *Config) Validate() error {
  if config.QueueSettings.QueueSize < 1 {
  return errors.New("'sending_queue.queue_size' must be 1 or greater")
  }
- if retErr := cwlogs.IsValidRetentionValue(config.LogRetention); retErr != nil {
+ if retErr := cwlogs.ValidateRetentionValue(config.LogRetention); retErr != nil {
  return retErr
  }
  tagInputErr := cwlogs.ValidateTagsInput(config.Tags)

exporter/awscloudwatchlogsexporter/config_test.go

@@ -17,6 +17,7 @@ package awscloudwatchlogsexporter
 import (
  "path/filepath"
  "strconv"
+ "strings"
  "testing"
 
  "github.com/cenkalti/backoff/v4"
@@ -165,6 +166,23 @@ func TestTagsValidateCorrect(t *testing.T) {
 
 }
 
+func TestTagsValidateTooLittleTags(t *testing.T) {
+ m := make(map[string]*string)
+ defaultRetrySettings := exporterhelper.NewDefaultRetrySettings()
+ wrongcfg := &Config{
+ RetrySettings: defaultRetrySettings,
+ LogGroupName: "test-1",
+ LogStreamName: "testing",
+ Endpoint: "",
+ Tags: m,
+ AWSSessionSettings: awsutil.CreateDefaultSessionConfig(),
+ QueueSettings: QueueSettings{
+ QueueSize: exporterhelper.NewDefaultQueueSettings().QueueSize,
+ },
+ }
+ assert.EqualError(t, component.ValidateConfig(wrongcfg), "invalid amount of items. Please input at least 1 tag or remove the tag field")
+}
+
 func TestTagsValidateTooManyTags(t *testing.T) {
  m := make(map[string]*string)
  avalue := "avalue"
@@ -239,17 +257,14 @@ func TestTagsValidateKeyTooShort(t *testing.T) {
 
 func TestTagsValidateKeyTooLong(t *testing.T) {
  avalue := "avalue"
- akey := ""
- for i := 0; i < 129; i++ {
- akey += "a"
- }
+ akey := strings.Repeat("a", 129)
  defaultRetrySettings := exporterhelper.NewDefaultRetrySettings()
  wrongcfg := &Config{
  RetrySettings: defaultRetrySettings,
  LogGroupName: "test-1",
  LogStreamName: "testing",
  Endpoint: "",
- Tags: map[string]*string{"": &avalue},
+ Tags: map[string]*string{akey: &avalue},
  AWSSessionSettings: awsutil.CreateDefaultSessionConfig(),
  QueueSettings: QueueSettings{
  QueueSize: exporterhelper.NewDefaultQueueSettings().QueueSize,
@@ -276,10 +291,7 @@ func TestTagsValidateValueTooShort(t *testing.T) {
 }
 
 func TestTagsValidateValueTooLong(t *testing.T) {
- avalue := ""
- for i := 0; i < 257; i++ {
- avalue += "a"
- }
+ avalue := strings.Repeat("a", 257)
  defaultRetrySettings := exporterhelper.NewDefaultRetrySettings()
  wrongcfg := &Config{
  RetrySettings: defaultRetrySettings,

exporter/awsemfexporter/README.md

@@ -23,7 +23,7 @@ The following exporter configuration parameters are supported.
 | `log_group_name` | Customized log group name which supports `{ClusterName}` and `{TaskId}` placeholders. One valid example is `/aws/metrics/{ClusterName}`. It will search for `ClusterName` (or `aws.ecs.cluster.name`) resource attribute in the metrics data and replace with the actual cluster name. If none of them are found in the resource attribute map, `{ClusterName}` will be replaced by `undefined`. Similar way, for the `{TaskId}`, it searches for `TaskId` (or `aws.ecs.task.id`) key in the resource attribute map. For `{NodeName}`, it searches for `NodeName` (or `k8s.node.name`) |"/metrics/default"|
 | `log_stream_name` | Customized log stream name which supports `{TaskId}`, `{ClusterName}`, `{NodeName}`, `{ContainerInstanceId}`, and `{TaskDefinitionFamily}` placeholders. One valid example is `{TaskId}`. It will search for `TaskId` (or `aws.ecs.task.id`) resource attribute in the metrics data and replace with the actual task id. If none of them are found in the resource attribute map, `{TaskId}` will be replaced by `undefined`. Similarly, for the `{TaskDefinitionFamily}`, it searches for `TaskDefinitionFamily` (or `aws.ecs.task.family`). For the `{ClusterName}`, it searches for `ClusterName` (or `aws.ecs.cluster.name`). For `{NodeName}`, it searches for `NodeName` (or `k8s.node.name`). For `{ContainerInstanceId}`, it searches for `ContainerInstanceId` (or `aws.ecs.container.instance.id`). (Note: ContainerInstanceId (or `aws.ecs.container.instance.id`) only works for AWS ECS EC2 launch type. |"otel-stream"|
 | `log_retention` | LogRetention is the option to set the log retention policy for only newly created CloudWatch Log Groups. Defaults to Never Expire if not specified or set to 0. Possible values for retention in days are 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, or 3653. |"Never Expire"|
-| `tags` | Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }. Keys must be between 1-128 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`. Values must be between 1-256 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$` | No tags set |
+| `tags` | Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }. Keys must be between 1-128 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`(alphanumerics, whitespace, and _.:/=+-!). Values must be between 1-256 characters and follow the regex pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`(alphanumerics, whitespace, and _.:/=+-!). [Link to tagging restrictions](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html#:~:text=Required%3A%20Yes-,tags,-The%20key%2Dvalue) | No tags set |
 | `namespace` | Customized CloudWatch metrics namespace | "default" |
 | `endpoint` | Optionally override the default CloudWatch service endpoint. | |
 | `no_verify_ssl` | Enable or disable TLS certificate verification. | false |

exporter/awsemfexporter/config.go

@@ -142,7 +142,7 @@ func (config *Config) Validate() error {
  }
  config.MetricDescriptors = validDescriptors
 
- if retErr := cwlogs.IsValidRetentionValue(config.LogRetention); retErr != nil {
+ if retErr := cwlogs.ValidateRetentionValue(config.LogRetention); retErr != nil {
  return retErr
  }
 

exporter/awsemfexporter/config_test.go

@@ -17,6 +17,7 @@ package awsemfexporter
 import (
  "path/filepath"
  "strconv"
+ "strings"
  "testing"
 
  "github.com/stretchr/testify/assert"
@@ -201,6 +202,21 @@ func TestTagsValidateCorrect(t *testing.T) {
 
 }
 
+func TestTagsValidateTooLittleTags(t *testing.T) {
+ m := make(map[string]*string)
+ wrongcfg := &Config{
+ AWSSessionSettings: awsutil.AWSSessionSettings{
+ RequestTimeoutSeconds: 30,
+ MaxRetries: 1,
+ },
+ DimensionRollupOption: "ZeroAndSingleDimensionRollup",
+ Tags: m,
+ ResourceToTelemetrySettings: resourcetotelemetry.Settings{Enabled: true},
+ logger: zap.NewNop(),
+ }
+ assert.EqualError(t, component.ValidateConfig(wrongcfg), "invalid amount of items. Please input at least 1 tag or remove the tag field")
+}
+
 func TestTagsValidateTooManyTags(t *testing.T) {
  m := make(map[string]*string)
  avalue := "avalue"
@@ -267,10 +283,7 @@ func TestTagsValidateKeyTooShort(t *testing.T) {
 
 func TestTagsValidateKeyTooLong(t *testing.T) {
  avalue := "avalue"
- akey := ""
- for i := 0; i < 129; i++ {
- akey += "a"
- }
+ akey := strings.Repeat("a", 129)
  wrongcfg := &Config{
  AWSSessionSettings: awsutil.AWSSessionSettings{
  RequestTimeoutSeconds: 30,
@@ -300,10 +313,7 @@ func TestTagsValidateValueTooShort(t *testing.T) {
 }
 
 func TestTagsValidateValueTooLong(t *testing.T) {
- avalue := ""
- for i := 0; i < 257; i++ {
- avalue += "a"
- }
+ avalue := strings.Repeat("a", 257)
  wrongcfg := &Config{
  AWSSessionSettings: awsutil.AWSSessionSettings{
  RequestTimeoutSeconds: 30,

internal/aws/cwlogs/cwlog_client.go

@@ -157,16 +157,10 @@ func (client *Client) CreateStream(logGroup, streamName *string) (token string,
  var awsErr awserr.Error
  if errors.As(err, &awsErr) && awsErr.Code() == cloudwatchlogs.ErrCodeResourceNotFoundException {
  // Create Log Group with tags if they exist and were specified in the config
- if client.tags != nil && len(client.tags) > 0 {
- _, err = client.svc.CreateLogGroup(&cloudwatchlogs.CreateLogGroupInput{
- LogGroupName: logGroup,
- Tags: client.tags,
- })
- } else {
- _, err = client.svc.CreateLogGroup(&cloudwatchlogs.CreateLogGroupInput{
- LogGroupName: logGroup,
- })
- }
+ _, err = client.svc.CreateLogGroup(&cloudwatchlogs.CreateLogGroupInput{
+ LogGroupName: logGroup,
+ Tags: client.tags,
+ })
  if err == nil {
  // For newly created log groups, set the log retention polic if specified or non-zero. Otheriwse, set to Never Expire
  if client.logRetention != 0 {

internal/aws/cwlogs/utils.go

@@ -21,7 +21,7 @@ import (
 )
 
 // Added function to check if value is an accepted number of log retention days
-func IsValidRetentionValue(input int64) error {
+func ValidateRetentionValue(input int64) error {
  switch input {
  case
  0,
@@ -53,9 +53,13 @@ func IsValidRetentionValue(input int64) error {
 
 // Check if the tags input is valid
 func ValidateTagsInput(input map[string]*string) error {
+ if input != nil && len(input) < 1 {
+ return fmt.Errorf("invalid amount of items. Please input at least 1 tag or remove the tag field")
+ }
  if len(input) > 50 {
  return fmt.Errorf("invalid amount of items. Please input at most 50 tags")
  }
+ // The regex for the Key and Value requires "alphanumerics, whitespace, and _.:/=+-!" as noted here: https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogGroup.html#:~:text=%5E(%5B%5Cp%7BL%7D%5Cp%7BZ%7D%5Cp%7BN%7D_.%3A/%3D%2B%5C%2D%40%5D%2B)%24
  validKeyPattern := regexp.MustCompile(`^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`)
  validValuePattern := regexp.MustCompile(`^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`)
  for key, value := range input {