Skip to content

Commit

Permalink
Merge branch 'main' into e2e
Browse files Browse the repository at this point in the history
  • Loading branch information
musa-asad authored Dec 5, 2024
2 parents 2b992e5 + a8ef6f7 commit d147b88
Show file tree
Hide file tree
Showing 16 changed files with 209 additions and 176 deletions.
7 changes: 4 additions & 3 deletions .github/workflows/integration-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1303,10 +1303,11 @@ jobs:
echo "Cluster name is ${EKS_CLUSTER_NAME}"
kubectl create -f https://raw.githubusercontent.com/NVIDIA/k8s-device-plugin/v0.17.0/deployments/static/nvidia-device-plugin.yml
kubectl patch amazoncloudwatchagents -n amazon-cloudwatch cloudwatch-agent --type='json' -p='[{"op": "replace", "path": "/spec/image", "value": ${{ secrets.AWS_ECR_PRIVATE_REGISTRY }}/${{ env.ECR_INTEGRATION_TEST_REPO }}:${{ github.sha }}}]'
kubectl rollout status daemonset nvidia-device-plugin-daemonset -n kube-system --timeout 10s
# wait nvidia device plugin to be ready
sleep 10
kubectl apply -f ./gpuBurner.yaml
else
terraform destroy -var="beta=${{ github.event.inputs.run_in_beta }}" -auto-approve && exit 1
terraform destroy -auto-approve && exit 1
fi
- name: Run Go tests with retry
Expand Down Expand Up @@ -1345,4 +1346,4 @@ jobs:
else
cd terraform/eks/addon/gpu
fi
terraform destroy -var="beta=${{ github.event.inputs.run_in_beta }}" -auto-approve
terraform destroy -auto-approve
51 changes: 12 additions & 39 deletions extension/entitystore/ec2Info.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (

"github.com/aws/amazon-cloudwatch-agent/internal/ec2metadataprovider"
"github.com/aws/amazon-cloudwatch-agent/plugins/processors/ec2tagger"
"github.com/aws/amazon-cloudwatch-agent/translator/config"
)

const (
Expand All @@ -32,7 +33,8 @@ type EC2Info struct {
AutoScalingGroup string

// region is used while making call to describeTags Ec2 API for AutoScalingGroup
Region string
Region string
kubernetesMode string

metadataProvider ec2metadataprovider.MetadataProvider
logger *zap.Logger
Expand All @@ -48,8 +50,11 @@ func (ei *EC2Info) initEc2Info() {
if err := ei.setInstanceIDAccountID(); err != nil {
return
}
if err := ei.setAutoScalingGroup(); err != nil {
return
// Instance metadata tags is not usable for EKS nodes
// https://github.com/kubernetes/cloud-provider-aws/issues/762
if ei.kubernetesMode != config.ModeEKS {
limitedRetryer := NewRetryer(true, true, defaultJitterMin, defaultJitterMax, ec2tagger.BackoffSleepArray, maxRetry, ei.done, ei.logger)
limitedRetryer.refreshLoop(ei.retrieveAsgName)
}
ei.logger.Debug("Finished initializing EC2Info")
}
Expand Down Expand Up @@ -99,49 +104,16 @@ func (ei *EC2Info) setInstanceIDAccountID() error {
}
}

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(); err != nil {
ei.logger.Debug("Unable to fetch instance tags with imds", zap.Int("retry", retry), zap.Error(err))
} else {
ei.logger.Debug("Retrieval of auto-scaling group tags succeeded")
return nil
}

retry++
}

}

func (ei *EC2Info) retrieveAsgName() error {
tags, err := ei.metadataProvider.InstanceTags(context.Background())
if err != nil {
ei.logger.Debug("Failed to get tags through metadata provider", zap.Error(err))
ei.logger.Debug("Failed to get AutoScalingGroup from instance tags. This is likely because instance tag is not enabled for IMDS but will not affect agent functionality.")
return err
} 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))
return err
} else {
ei.logger.Debug("AutoScalingGroup retrieved through IMDS")
ei.mutex.Lock()
Expand All @@ -156,9 +128,10 @@ func (ei *EC2Info) retrieveAsgName() error {
return nil
}

func newEC2Info(metadataProvider ec2metadataprovider.MetadataProvider, done chan struct{}, region string, logger *zap.Logger) *EC2Info {
func newEC2Info(metadataProvider ec2metadataprovider.MetadataProvider, kubernetesMode string, done chan struct{}, region string, logger *zap.Logger) *EC2Info {
return &EC2Info{
metadataProvider: metadataProvider,
kubernetesMode: kubernetesMode,
done: done,
Region: region,
logger: logger,
Expand Down
33 changes: 33 additions & 0 deletions extension/entitystore/ec2Info_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import (
"go.uber.org/zap"

"github.com/aws/amazon-cloudwatch-agent/internal/ec2metadataprovider"
"github.com/aws/amazon-cloudwatch-agent/translator/config"
)

var mockedInstanceIdentityDoc = &ec2metadata.EC2InstanceIdentityDocument{
Expand Down Expand Up @@ -236,3 +237,35 @@ func TestNotInitIfMetadataProviderIsEmpty(t *testing.T) {
})
}
}

func TestNoASGRetrievalInKubernetesMode(t *testing.T) {
type args struct {
metadataProvider ec2metadataprovider.MetadataProvider
kubernetesMode string
}
tests := []struct {
name string
args args
wantErr bool
want string
}{
{
name: "EKSNoASGFromEC2Info",
args: args{
metadataProvider: &mockMetadataProvider{InstanceIdentityDocument: mockedInstanceIdentityDoc, Tags: map[string]string{"aws:autoscaling:groupName": tagVal3}},
kubernetesMode: config.ModeEKS,
},
wantErr: false,
want: "",
},
}
for _, tt := range tests {
logger, _ := zap.NewDevelopment()
t.Run(tt.name, func(t *testing.T) {
ei := &EC2Info{metadataProvider: tt.args.metadataProvider, kubernetesMode: tt.args.kubernetesMode, logger: logger}
go ei.initEc2Info()
time.Sleep(3 * time.Second)
assert.Equal(t, tt.want, ei.GetAutoScalingGroup())
})
}
}
8 changes: 6 additions & 2 deletions extension/entitystore/extension.go
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,13 @@ func (e *EntityStore) Start(ctx context.Context, host component.Host) error {
e.serviceprovider = newServiceProvider(e.mode, e.config.Region, &e.ec2Info, e.metadataprovider, getEC2Provider, ec2CredentialConfig, e.done, e.logger)
switch e.mode {
case config.ModeEC2:
e.ec2Info = *newEC2Info(e.metadataprovider, e.done, e.config.Region, e.logger)
e.ec2Info = *newEC2Info(e.metadataprovider, e.kubernetesMode, e.done, e.config.Region, e.logger)
go e.ec2Info.initEc2Info()
go e.serviceprovider.startServiceProvider()
// Instance metadata tags is not usable for EKS nodes
// https://github.com/kubernetes/cloud-provider-aws/issues/762
if e.kubernetesMode == "" {
go e.serviceprovider.startServiceProvider()
}
}
if e.kubernetesMode != "" {
e.eksInfo = newEKSInfo(e.logger)
Expand Down
52 changes: 52 additions & 0 deletions extension/entitystore/extension_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,58 @@ func TestEntityStore_LogMessageDoesNotIncludeResourceInfo(t *testing.T) {
}
}

func TestEntityStore_ServiceProviderInDifferentEnv(t *testing.T) {
type args struct {
mode string
kubernetesMode string
}
tests := []struct {
name string
args args
}{
{
name: "EC2inEKS",
args: args{
mode: config.ModeEC2,
kubernetesMode: config.ModeEKS,
},
},
{
name: "EC2Only",
args: args{
mode: config.ModeEC2,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {

esConfig := &Config{
Mode: tt.args.mode,
KubernetesMode: tt.args.kubernetesMode,
}
getMetaDataProvider = mockMetadataProviderFunc
e := EntityStore{
logger: zap.NewNop(),
config: esConfig,
}
e.Start(context.TODO(), nil)
time.Sleep(3 * time.Second)

name, source := e.serviceprovider.getServiceNameAndSource()
if tt.args.mode == config.ModeEC2 && tt.args.kubernetesMode != "" {
assert.Equal(t, name, ServiceNameUnknown)
assert.Equal(t, source, ServiceNameSourceUnknown)
} else if tt.args.mode == config.ModeEC2 && tt.args.kubernetesMode == "" {
assert.Equal(t, name, "TestRole")
assert.Equal(t, source, ServiceNameSourceClientIamRole)
}

})
}

}

func assertIfNonEmpty(t *testing.T, message string, pattern string) {
if pattern != "" {
assert.NotContains(t, message, pattern)
Expand Down
2 changes: 1 addition & 1 deletion extension/entitystore/retryer.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func (r *Retryer) refreshLoop(updateFunc func() error) int {

if err != nil {
retry++
r.logger.Debug("there was an error when retrieving service attribute.", zap.Error(err))
r.logger.Debug("there was an issue when retrieving entity attributes but will not affect agent functionality", zap.Error(err))
} else {
retry = 1
}
Expand Down
2 changes: 1 addition & 1 deletion extension/entitystore/serviceprovider.go
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ func (s *serviceprovider) scrapeIAMRole() error {
func (s *serviceprovider) scrapeImdsServiceName() error {
tags, err := s.metadataProvider.InstanceTags(context.Background())
if err != nil {
s.logger.Debug("Failed to get tags through metadata provider", zap.Error(err))
s.logger.Debug("Failed to get service name from instance tags. This is likely because instance tag is not enabled for IMDS but will not affect agent functionality.")
return err
}
// This will check whether the tags contains SERVICE, APPLICATION, APP, in that order.
Expand Down
1 change: 0 additions & 1 deletion internal/retryer/imdsretryer.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ func (r IMDSRetryer) ShouldRetry(req *request.Request) bool {
if awsError, ok := req.Error.(awserr.Error); r.DefaultRetryer.ShouldRetry(req) || (ok && awsError != nil && awsError.Code() == "EC2MetadataError") {
shouldRetry = true
}
fmt.Printf("D! should retry %t for imds error : %v", shouldRetry, req.Error)
return shouldRetry
}

Expand Down
30 changes: 30 additions & 0 deletions translator/tocwconfig/sampleConfig/appsignals_and_ecs_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,47 @@ exporters:
- dimensions:
- - Environment
- Operation
- RemoteEnvironment
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- Operation
- RemoteEnvironment
- RemoteOperation
- RemoteService
- Service
- - Environment
- Operation
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- Operation
- RemoteOperation
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteService
- Service
- - Environment
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteOperation
- RemoteService
- Service
- - Environment
Expand Down
30 changes: 30 additions & 0 deletions translator/tocwconfig/sampleConfig/base_appsignals_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,47 @@ exporters:
- dimensions:
- - Environment
- Operation
- RemoteEnvironment
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- Operation
- RemoteEnvironment
- RemoteOperation
- RemoteService
- Service
- - Environment
- Operation
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- Operation
- RemoteOperation
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteService
- Service
- - Environment
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteOperation
- RemoteResourceIdentifier
- RemoteResourceType
- RemoteService
- Service
- - Environment
- RemoteEnvironment
- RemoteOperation
- RemoteService
- Service
- - Environment
Expand Down
Loading

0 comments on commit d147b88

Please sign in to comment.