-
Notifications
You must be signed in to change notification settings - Fork 207
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1329 from aws/entityMerge
Implements logic for attaching Entity field to CloudWatch Logs PutLogEvent API
- Loading branch information
Showing
123 changed files
with
28,687 additions
and
2,287 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package entitystore | ||
|
|
||
| import ( | ||
| "go.opentelemetry.io/collector/component" | ||
| ) | ||
|
|
||
| type Config struct { | ||
| Mode string `mapstructure:"mode"` | ||
| Region string `mapstructure:"region"` | ||
| Profile string `mapstructure:"profile,omitempty"` | ||
| RoleARN string `mapstructure:"role_arn,omitempty"` | ||
| Filename string `mapstructure:"shared_credential_file,omitempty"` | ||
| } | ||
|
|
||
| var _ component.Config = (*Config)(nil) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package entitystore | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "go.opentelemetry.io/collector/confmap" | ||
| ) | ||
|
|
||
| func TestUnmarshalDefaultConfig(t *testing.T) { | ||
| factory := NewFactory() | ||
| cfg := factory.CreateDefaultConfig() | ||
| assert.NoError(t, confmap.New().Unmarshal(cfg)) | ||
| assert.Equal(t, factory.CreateDefaultConfig(), cfg) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,195 @@ | ||
| // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| package entitystore | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/aws/aws-sdk-go/aws" | ||
| "github.com/aws/aws-sdk-go/service/ec2" | ||
| "github.com/aws/aws-sdk-go/service/ec2/ec2iface" | ||
| "go.uber.org/zap" | ||
|
|
||
| configaws "github.com/aws/amazon-cloudwatch-agent/cfg/aws" | ||
| "github.com/aws/amazon-cloudwatch-agent/internal/ec2metadataprovider" | ||
| "github.com/aws/amazon-cloudwatch-agent/plugins/processors/ec2tagger" | ||
| ) | ||
|
|
||
| const ( | ||
| // InstanceId character maximum length is 19. | ||
| // See https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Instance.html. | ||
| instanceIdSizeMax = 19 | ||
|
|
||
| // AutoScalingGroup character maximum length is 255. | ||
| // See https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_AutoScalingGroup.html. | ||
| autoScalingGroupSizeMax = 255 | ||
| ) | ||
|
|
||
| type ec2Info struct { | ||
| InstanceID string | ||
| AutoScalingGroup string | ||
|
|
||
| // region is used while making call to describeTags Ec2 API for AutoScalingGroup | ||
| Region string | ||
|
|
||
| metadataProvider ec2metadataprovider.MetadataProvider | ||
| ec2API ec2iface.EC2API | ||
| ec2Provider ec2ProviderType | ||
| ec2Credential *configaws.CredentialConfig | ||
| logger *zap.Logger | ||
| done chan struct{} | ||
| } | ||
|
|
||
| func (ei *ec2Info) initEc2Info() { | ||
| ei.logger.Debug("Initializing ec2Info") | ||
| if err := ei.setInstanceId(); err != nil { | ||
| return | ||
| } | ||
| ei.ec2API = ei.ec2Provider(ei.Region, ei.ec2Credential) | ||
| if err := ei.setAutoScalingGroup(); err != nil { | ||
| return | ||
| } | ||
| ei.logger.Debug("Finished initializing ec2Info") | ||
| ei.ignoreInvalidFields() | ||
| } | ||
|
|
||
| func (ei *ec2Info) setInstanceId() error { | ||
| for { | ||
| metadataDoc, err := ei.metadataProvider.Get(context.Background()) | ||
| if err != nil { | ||
| ei.logger.Warn("Failed to get Instance Id through metadata provider", zap.Error(err)) | ||
| wait := time.NewTimer(1 * time.Minute) | ||
| select { | ||
| case <-ei.done: | ||
| wait.Stop() | ||
| return errors.New("shutdown signal received") | ||
| case <-wait.C: | ||
| continue | ||
| } | ||
| } | ||
| ei.logger.Debug("Successfully retrieved Instance ID") | ||
| ei.InstanceID = metadataDoc.InstanceID | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| func (ei *ec2Info) setAutoScalingGroup() error { | ||
| retry := 0 | ||
| for { | ||
| var waitDuration time.Duration | ||
| if retry < len(ec2tagger.BackoffSleepArray) { | ||
| waitDuration = ec2tagger.BackoffSleepArray[retry] | ||
| } else { | ||
| waitDuration = ec2tagger.BackoffSleepArray[len(ec2tagger.BackoffSleepArray)-1] | ||
| } | ||
|
|
||
| wait := time.NewTimer(waitDuration) | ||
| select { | ||
| case <-ei.done: | ||
| wait.Stop() | ||
| return errors.New("shutdown signal received") | ||
| case <-wait.C: | ||
| } | ||
|
|
||
| if retry > 0 { | ||
| ei.logger.Debug("Initial retrieval of tags and volumes", zap.Int("retry", retry)) | ||
| } | ||
|
|
||
| if err := ei.retrieveAsgName(ei.ec2API); err != nil { | ||
| ei.logger.Warn("Unable to describe ec2 tags", zap.Int("retry", retry), zap.Error(err)) | ||
| } else { | ||
| ei.logger.Debug("Retrieval of auto-scaling group tags succeeded") | ||
| return nil | ||
| } | ||
|
|
||
| retry++ | ||
| } | ||
|
|
||
| } | ||
|
|
||
| /* | ||
| This can also be implemented by just calling the InstanceTagValue and then DescribeTags on failure. But preferred the current implementation | ||
| as we need to distinguish the tags not being fetchable at all, from the ASG tag in particular not existing. | ||
| */ | ||
| func (ei *ec2Info) retrieveAsgName(ec2API ec2iface.EC2API) error { | ||
| tags, err := ei.metadataProvider.InstanceTags(context.Background()) | ||
| if err != nil { | ||
| ei.logger.Debug("Failed to get tags through metadata provider", zap.Error(err)) | ||
| return ei.retrieveAsgNameWithDescribeTags(ec2API) | ||
| } else if strings.Contains(tags, ec2tagger.Ec2InstanceTagKeyASG) { | ||
| asg, err := ei.metadataProvider.InstanceTagValue(context.Background(), ec2tagger.Ec2InstanceTagKeyASG) | ||
| if err != nil { | ||
| ei.logger.Error("Failed to get AutoScalingGroup through metadata provider", zap.Error(err)) | ||
| } else { | ||
| ei.logger.Debug("AutoScalingGroup retrieved through IMDS") | ||
| ei.AutoScalingGroup = asg | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (ei *ec2Info) retrieveAsgNameWithDescribeTags(ec2API ec2iface.EC2API) error { | ||
| tagFilters := []*ec2.Filter{ | ||
| { | ||
| Name: aws.String("resource-type"), | ||
| Values: aws.StringSlice([]string{"instance"}), | ||
| }, | ||
| { | ||
| Name: aws.String("resource-id"), | ||
| Values: aws.StringSlice([]string{ei.InstanceID}), | ||
| }, | ||
| { | ||
| Name: aws.String("key"), | ||
| Values: aws.StringSlice([]string{ec2tagger.Ec2InstanceTagKeyASG}), | ||
| }, | ||
| } | ||
| input := &ec2.DescribeTagsInput{ | ||
| Filters: tagFilters, | ||
| } | ||
| for { | ||
| result, err := ec2API.DescribeTags(input) | ||
| if err != nil { | ||
| ei.logger.Error("Unable to retrieve EC2 AutoScalingGroup. This feature must only be used on an EC2 instance.") | ||
| return err | ||
| } | ||
| for _, tag := range result.Tags { | ||
| key := *tag.Key | ||
| if ec2tagger.Ec2InstanceTagKeyASG == key { | ||
| ei.AutoScalingGroup = *tag.Value | ||
| return nil | ||
| } | ||
| } | ||
| if result.NextToken == nil { | ||
| break | ||
| } | ||
| input.SetNextToken(*result.NextToken) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func newEC2Info(metadataProvider ec2metadataprovider.MetadataProvider, providerType ec2ProviderType, ec2Credential *configaws.CredentialConfig, done chan struct{}, region string, logger *zap.Logger) *ec2Info { | ||
| return &ec2Info{ | ||
| metadataProvider: metadataProvider, | ||
| ec2Provider: providerType, | ||
| ec2Credential: ec2Credential, | ||
| done: done, | ||
| Region: region, | ||
| logger: logger, | ||
| } | ||
| } | ||
|
|
||
| func (ei *ec2Info) ignoreInvalidFields() { | ||
| if idLength := len(ei.InstanceID); idLength > instanceIdSizeMax { | ||
| ei.logger.Warn("InstanceId length exceeds characters limit and will be ignored", zap.Int("length", idLength), zap.Int("character limit", instanceIdSizeMax)) | ||
| ei.InstanceID = "" | ||
| } | ||
|
|
||
| if asgLength := len(ei.AutoScalingGroup); asgLength > autoScalingGroupSizeMax { | ||
| ei.logger.Warn("AutoScalingGroup length exceeds characters limit and will be ignored", zap.Int("length", asgLength), zap.Int("character limit", autoScalingGroupSizeMax)) | ||
| ei.AutoScalingGroup = "" | ||
| } | ||
| } |
Oops, something went wrong.